メインコンテンツまでスキップ

Android SDK

DeployGateはAPKファイルをアップロードすればそのままアプリを配信できますが、SDKを組み込むことでアプリの開発をよりスムーズにすることができます。


SDKのインストール(Android Studio/Gradle)

  1. アプリモジュールの build.gradle ファイル (例: app/build.gradle) に以下を記述します。
build.gradle
// Groovy DSL

dependencies {
// 開発時やデバッグ時に指定する build variant では sdk を使います
debugImplementation "com.deploygate:sdk:${latest_version}"

// DeployGate SDKの機能を無効化したい build variant では sdk-mock を使います
releaseImplementation "com.deploygate:sdk-mock:${latest_version}"
}
build.gradle.kts
// Kotlin DSL

dependencies {
// 開発時やデバッグ時に指定する build variant では sdk を使います
debugImplementation("com.deploygate:sdk:${latest_version}")

// DeployGate SDKの機能を無効化したい build variant では sdk-mock を使います
releaseImplementation("com.deploygate:sdk-mock:${latest_version}")
}
sdk-mock について

現在、Android SDK は以下の2種類を公開しています。

  • com.deploygate:sdk
  • com.deploygate:sdk-mock

Android SDK を無効化したい場合は sdk の代わりに sdk-mock を利用することを推奨しています。sdk-mocksdk と同じインターフェースを持ちつつ、内部は空実装になっています。 sdk-mock を利用すれば、特定の build variant でSDKを無効化するためのアプリコードを書く必要はありません。

ターゲットSDKバージョンがAPI 30以上のアプリの場合

Android SDK 4.3.0 以降をお使いください。4.3.0 より低いバージョンで利用する場合、 Android 11以上の端末ではSDKがDeployGateのサービスへ接続するために、 パッケージのクエリを行えるようにする 必要があります。このため、 AndroidManifest.xml に以下の記述を追加してください。

<queries>
<package android:name="com.deploygate" />
</queries>
  1. Android Studio の場合は、 Sync Project With Gradle Files をクリックして編集内容を反映させます。

Screenshot of Android sdk

  1. アプリをビルドして DeployGate で配信すると、アプリの起動やクラッシュレポートを DeployGate 上で確認できるようになります。
ビルドとアップロードはGradle DeployGate Pluginを使うと簡単です

Gradleプラグイン をご利用いただくと Gradle タスクを実行するだけでビルドとアップロードを行えるようになります。

DeployGateで配信されていないビルドでは動作しません

DeployGate SDKは、DeployGateアプリと連携しサービス上から配信されているビルドでのみ動作します。DeployGate を介さず開発環境に直接接続されているエミュレータや実機にインストールした場合には動作しないようになっています。

DeployGate SDK で提供する機能の一部は特定のOSバージョン以降でしか動作しない場合があります。

詳しくは各種リファレンスをご参照ください。

リファレンス