Android SDK - 基本的な統合

ビデオガイドあり

統合プロセスの詳細な手順については、このビデオをご覧ください。 最良の結果を得るには、ビデオと以下の文書ガイドの両方を使用してください。


前提条件

この統合を進める前に、 Singular SDKの統合: 計画と前提条件 の手順を完了してください。

重要: これらの前提条件の手順は、すべての Singular SDK 統合に必須です。


インストール

インストール方法

注: Android Studio では、新規プロジェクトのデフォルトが Kotlin DSL (build.gradle.kts) になりました。 以下のすべてのコード例では、 Kotlin DSL (推奨) Groovy DSL の両方の形式を示しています。

方法 1: Gradle (推奨)

方法 1: Gradle (推奨)

SDK リポジトリを追加

プロジェクトの依存関係管理で、Singular Maven リポジトリを構成します。

注: Gradle 7 以降、Android はプロジェクトまたはモジュールレベルの build.gradle の宣言ではなく、 settings.gradle または settings.gradle.kts での集中型リポジトリ宣言の使用を推奨しています。

Gradle 7+ の構成

settings ファイルに Singular SDK リポジトリを追加します:

settings.gradle.kts (Kotlin DSL - Recommended) settings.gradle (Groovy DSL)
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://maven.singular.net/")
        }
    }
}

旧バージョンの Gradle

旧バージョンの Gradle の場合は、プロジェクトレベルのビルドファイルにリポジトリを追加します:

build.gradle.kts (Kotlin DSL - Recommended) build.gradle (Groovy DSL)
repositories {
    mavenCentral()
    maven {
        url = uri("https://maven.singular.net/")
    }
}

Singular ライブラリの依存関係を追加

アプリモジュールの依存関係に Singular ライブラリを追加します。

app/build.gradle.kts (Kotlin DSL - Recommended) app/build.gradle (Groovy DSL)
dependencies {
    implementation("com.singular.sdk:singular_sdk:12.13.0")
}

トラブルシューティング: 重複クラスの問題

複数の依存関係に同じライブラリが含まれている場合、重複クラスエラーが発生する可能性があります。 これは、旧バージョンの Google Play Services ライブラリを使用するときによく発生します。

一般的なエラー例:

Duplicate class com.google.android.gms.common.api.ResultCallback found in modules play-services-6.5.87.aar and play-services-basement-17.6.0.aar

解決策: 競合する依存関係の除外

重複クラスの問題を解決するには、Singular SDK または競合の原因となっている 他の依存関係から、競合する推移的依存関係 (transitive dependency) を除外します。

app/build.gradle.kts (Kotlin DSL - Recommended) app/build.gradle (Groovy DSL)
dependencies {
    // Exclude specific Google Play Services modules from Singular SDK
    implementation("com.singular.sdk:singular_sdk:12.13.0") {
        exclude(group = "com.google.android.gms", module = "play-services")
    }

    // Add the specific Google Play Services libraries your app needs
    implementation("com.google.android.gms:play-services-ads-identifier:17.0.0")
    implementation("com.google.android.gms:play-services-appset:16.0.2")
}

グローバル除外ルール

重複クラスの競合がプロジェクト全体の複数の依存関係に影響する場合は、 グローバル除外ルールを適用できます。

app/build.gradle.kts (Kotlin DSL - Recommended) app/build.gradle (Groovy DSL)
configurations.all {
    exclude(group = "com.google.android.gms", module = "play-services")
}

依存関係解決の確認

除外ルールを適用した後、依存関係ツリーを確認して競合が解決されていることを確認します。

Terminal Command
./gradlew app:dependencies --configuration debugRuntimeClasspath

このコマンドは、アプリの完全な依存関係ツリーを表示し、 どのライブラリが含まれており、どれが除外されているかを示します。


Samsung Galaxy Store のサポート

アプリが Samsung Galaxy Store で配信されている場合は、 Samsung Galaxy Store install referrer の依存関係を追加してください。

app/build.gradle.kts (Kotlin DSL - Recommended) app/build.gradle (Groovy DSL)
dependencies {
    implementation("store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:4.0.0")
}

推移的依存関係 (Transitive Dependencies)

Singular SDK の推移的依存関係を無効化している場合は、アプリモジュールの依存関係に これらの必要なライブラリを手動で追加してください。

app/build.gradle.kts (Kotlin DSL - Recommended) app/build.gradle (Groovy DSL)
dependencies {
    implementation("com.android.installreferrer:installreferrer:2.2")
    implementation("com.google.android.gms:play-services-appset:16.0.2")
}

Google Play Services の依存関係

アプリで Google Play Services API 17.0.0 以上を実装していない場合は、 次の依存関係を追加してください。

app/build.gradle.kts (Kotlin DSL - Recommended) app/build.gradle (Groovy DSL)
dependencies {
    implementation("com.google.android.gms:play-services-ads-identifier:17.0.0")
}
方法 2: 手動インストール

代替インストール方法

手動ダウンロード

SDK AAR ファイルをダウンロードして、プロジェクトに手動で統合します。

  1. SDK をダウンロード: このページの上部のリンクから SDK をダウンロードします
  2. 展開して libs に追加: SDK パッケージを展開し、 Singular.aar を Android プロジェクトの libs ディレクトリに追加します
  3. libs ディレクトリを作成: 存在しない場合は、プロジェクトフォルダ (通常は <project>/app/libs ) に libs という名前のディレクトリを作成します
方法 3: Maven インストール

Maven インストール

プロジェクトの pom.xml ファイルに Singular Maven リポジトリを追加します。

pom.xml
<project ...>
    <repositories>
        <repository>
            <id>singular.net</id>
            <url>http://maven.singular.net/</url>
        </repository>
    </repositories>
</project>

依存関係を追加します:

pom.xml
<dependency>
    <groupId>com.singular.sdk</groupId>
    <artifactId>singular_sdk</artifactId>
    <version>12.13.0</version>
</dependency>
方法 4: Eclipse インストール

Eclipse インストール

次の手順に従って、Eclipse を使用して SDK を統合します。

Eclipse AAR プラグインを使用できます: gradle-eclipse-aar-plugin

プラグインを使用しない場合は、次の手順に従ってください:

  1. AAR を展開: singular_sdk-12.13.0.aar を展開します
  2. JAR ファイルの名前を変更: classes.jar の名前を singular_sdk-12.13.0.jar に変更します (これがメインの SDK jar です)
  3. install referrer を追加: com.android.installreferrer:installreferrer:2.2 ライブラリをプロジェクトに追加します
  4. パーミッションをコピー: AAR に含まれる AndroidManifest.xml BIND_GET_INSTALL_REFERRER_SERVICE パーミッションを、ご使用の AndroidManifest.xml にコピーします
  5. ライセンスパーミッションをコピー: AAR に含まれる AndroidManifest.xml CHECK_LICENSE パーミッションを、ご使用の AndroidManifest.xml にコピーします

ProGuard 構成

ProGuard ルール

コード難読化の問題を防ぐため、 proguard.config ファイルに次のルールを追加します。

proguard.config
-keep class com.singular.sdk.** { *; }
-keep public class com.android.installreferrer.** { *; }
# Uncomment this line in case your are calling the 'revenue' function using the Google billing library
#-keep public class com.android.billingclient.** { *; }

必須パーミッション

AndroidManifest の構成

これらのパーミッションを AndroidManifest.xml ファイルの <manifest> タグの下に追加します。

AndroidManifest.xml
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="BIND_GET_INSTALL_REFERRER_SERVICE" />
<uses-permission android:name="com.android.vending.CHECK_LICENSE" />
<uses-permission android:name="com.google.android.gms.permission.AD_ID" />

Kids SDK を統合する場合は、 com.google.android.gms.permission.AD_ID パーミッションを除外してください。


Samsung Galaxy Store クエリ

Samsung Galaxy Store の install referrer をサポートするには、次を AndroidManifest.xml に追加してください。

AndroidManifest.xml
<queries>
    <package android:name="com.sec.android.app.samsungapps" />
</queries>

SDK の統合

プライバシーコンプライアンス: Singular SDK を実装する際は、GDPR、CCPA、COPPA を含む、 ビジネスを展開する地域で施行されているプライバシー法を遵守してください。 ガイダンスについては SDK のオプトインとオプトアウトの方法 を参照してください。

Singular SDK のインポート

Import 文の追加

MainActivity ファイルに Singular ライブラリをインポートします。

Kotlin Java
import com.singular.sdk.*

SDK の初期化

初期化関数の作成

セッショントラッキングとアトリビューションを有効にするには、private メソッドを作成し、 MainActivity の onCreate() メソッドから呼び出すことで、アプリ起動のたびに Singular SDK を初期化してください。

次の手順に従ってください:

  1. 関数を追加: 初期化メソッドを MainActivity クラス (または任意のエントリーポイントの Activity) 内に配置します
  2. 認証情報を挿入: SDK KEY SDK SECRET を、ダッシュボードの Singular SDK キーとシークレットに置き換えます
  3. SingularConfig を更新: SDK を初期化する前に、SingularConfig オブジェクトを作成し、 SDK の設定を行います (以下の構成オプションを参照)
  4. 関数を呼び出す: UI のセットアップ後、イベントのロギング前に、 onCreate() initSingularSDK() を呼び出します

基本実装

基本構成で初期化メソッドを作成します。

Kotlin Java
private fun initSingularSDK() {
    // Configure Singular with SDK key and secret
    val config = SingularConfig("SDK KEY", "SDK SECRET")

    try {
        Singular.init(applicationContext, config)
        Log.d("Singular", "SDK initialized successfully")
    } catch (e: Exception) {
        Log.e("Singular", "SDK initialization failed: ${e.message}")
    }
}

MainActivity の onCreate からの呼び出し

MainActivity の onCreate() メソッドで初期化メソッドを呼び出します。

Kotlin Java
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    // Initialize Singular SDK
    initSingularSDK()

    // Proceed with your app setup (e.g., UI initialization)
}

実装ガイドライン

SDK の初期化を実装する際は、以下の重要なガイドラインに従ってください。

  • 配置: 適切なセッショントラッキングを保証するため、初期化メソッドを Application クラスではなく MainActivity に追加します
  • エラー処理: try-catch ブロックは、アプリをクラッシュさせずに、 初期化エラー (例: 無効な認証情報) をログに記録します
  • ディープリンク: ディープリンク (アプリを起動する URL) を処理するには、 拡張セットアップについて ディープリンクのサポート を参照してください
  • META Install Referrer: Meta Install Referrer アトリビューション を有効にするには、 config.withFacebookAppId("FacebookAppID") を追加します

2025年6月18日以降 、Meta の Advanced Mobile Measurement Reporting (AMM) により、Meta Install Referrer の実装が不要になります。AMM レポートが有効な場合、 Meta Install Referrer を実装することは推奨されません。

Pro Tip: アプリが複数のエントリーポイント (例: ディープリンク) をサポートしている場合、 一貫した動作を保証するため、関連する各 Activity の onCreate() initSingularSDK() が呼び出されるようにしてください。


構成オプション

SingularConfig メソッド

SingularConfig オブジェクトでは、チェーン可能な構成メソッドを使用して SDK の動作をカスタマイズできます。 利用可能なすべてのオプションについては、以下の表を参照してください。

メソッド 説明
.withFacebookAppId(String facebookAppID) Facebook App ID を構成します。 Meta Install Referrer アトリビューション に必須です。 詳細は アプリの Facebook App ID はどこで確認できますか? を参照してください。

2025年6月18日以降 、Meta の Advanced Mobile Measurement Reporting (AMM) により、Meta Install Referrer の実装が不要になります。 AMM レポートが有効な場合、Meta Install Referrer を 実装することは推奨されません。

.withCustomUserId(String customId) ユーザー ID を Singular に送信します
.withSingularLink(Intent intent, SingularLinkHandler handler)
.withSingularLink(Intent intent, SingularLinkHandler handler, long shortlinkTimeoutSec)
Singular Links によるディープリンクを有効化します。単一引数のオーバーロードは デフォルトで 10 秒の short link 解決タイムアウトを使用します。これを上書きするには、 3 引数のオーバーロードを使用してください。この呼び出しは deferred deep link も処理するため、 個別の withDDLHandler / withDDLTimeoutInSec の構成は不要になりました。
.withOpenURI(URI openURI) intent から URI を取得します (Singular 発信ではないリンクからアプリが 開かれた場合のディープリンク処理用)
.withGlobalProperty(String key, String value, boolean overrideExisting) グローバルプロパティに指定の値を設定します。key と value は、 アプリから送信されるすべてのイベント/セッションとともに Singular に送信されます
.withSessionTimeoutInSec(long timeout) セッションタイムアウトを設定します
.withFCMDeviceToken(String token) 最初のセッションで送信される FCM トークンを設定します
.withLoggingEnabled() ロギングを有効化します
.withLogLevel(int level) ロギングレベルを構成します (デフォルトは Log.ERROR)