adjust-icon

Cocos2d-x SDK 連携ガイド

AdjustのAndroid SDKを実装することで、アトリビューション、イベント、さらにその他のさまざまなデータをCocos2d-xアプリで記録できます。Adjust SDKをアプリに実装するには、以下の手順に従ってください。

1. Adjust SDKを取得する

Cocos2d-xアプリでAdjust SDKを使うには、プロジェクトに追加する必要があります。GitHubのリリースページから最新バージョンをダウンロードし、任意のディレクトリにアーカイブを抽出してください。

### プロジェクトにSDKを追加

プロジェクトにSDKを追加する方法:

  1. Adjust SDKのアーカイブを抽出します。

  2. distディレクトリからC++ ファイルをコピーし、Cocos2d-x プロジェクトに追加します。

  3. Androidのみ ):Android.mkファイルのLOCAL_SRC_FILESセクションにC++ファイルのパスを追加します。

    Android.mk
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustConfig2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustAttribution2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustProxy2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustEvent2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/Adjust2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustEventFailure2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustEventSuccess2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustSessionFailure2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustSessionSuccess2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustAppStoreSubscription2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustPlayStoreSubscription2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustThirdPartySharing2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustAdRevenue2dx.cpp
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustAppStorePurchase2dx.cpp \
    $(LOCAL_PATH)/../../../Classes/Adjust/AdjustPlayStorePurchase2dx.cpp \

3. プロジェクト設定を更新する

プロジェクトでAdjust SDKを有効化するには、プロジェクトの設定を更新してください。セクションの手順に従ってください。

Android設定

SDK JAR ライブラリ

AndroidをターゲットとするCocos2d-xアプリには、Java Archive(JAR)ライブラリが必要です。JARライブラリをアプリに実装するには、抽出したアーカイブからadjust-android.jarライブラリをプロジェクトのlibsフォルダーにコピーしてください。

パーミッションを追加

Adjust SDKがデバイス情報にアクセスできるようにするには、アプリが必要とするパーミッションを宣言する必要があります。これを行うには、AndroidManifest.xmlファイルにパーミッションを追加します。

オンライン機能にアクセスするには、以下のパーミッションを追加してください:

AndroidManifest.xml
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

アプリがGoogle Play ストアを対象としていない場合、デバイスのネットワーク状態にアクセスするために以下のパーミッションを追加してください:

AndroidManifest.xml
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
4.32.0で変更

Adjust SDKには、デフォルトでcom.google.android.gms.AD_IDパーミッションが含まれています。アプリがCOPPA(児童オンラインプライバシー保護法)に準拠する必要がある場合、またはアプリがGoogle Play ストアを対象としていない場合は、removeディレクティブを使用してこのパーミッションを削除する必要があります。

AndroidManifest.xml
<uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove"/>

ProGuardを設定する

Proguardを使ってアプリを最適化する場合は、Proguardがクラスを削除しないようにルールを追加する必要があります。

Proguard.pro
-keep class com.adjust.sdk.** { *; }
-keep class com.google.android.gms.common.ConnectionResult {
int SUCCESS;
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
java.lang.String getId();
boolean isLimitAdTrackingEnabled();
}
-keep public class com.android.installreferrer.** { *; }

Google Play ストアでアプリを公開していない場合は、以下のルールを追加します:

Proguard.pro
-keep public class com.adjust.sdk.** { *; }

インストールリファラーを設定する

インストールリファラーは、インストールをソースにアトリビュートするために使用される一意の識別子です。Adjust SDKは、アトリビューションを実行するためにこの情報を必要とします。インストールのリファラー情報を取得するには、以下のいずれかの方法を使用します:

Google Play Referrer API
v4.12.0に追加

Google Play Referrer APIは、Google Play ストアを対象とするアプリで使用できます。

Google Play Referrer APIをサポートするには、build.gradleファイルに以下を追加します:

build.gradle
dependencies {
implementation 'com.android.installreferrer:installreferrer:2.2'
}

Proguardを使用している場合は、依存関係が削除されないように、忘れずにルールを追加してください。

Proguard.pro
-keep public class com.android.installreferrer.** { *; }
Huawei Referrer API
v4.22.0に追加

Huawei Referrer APIは、Huaweiデバイスを対象とするアプリで使用できます。バージョン10.4以降、Adjust SDKはHuawei App GalleryのHuaweiデバイスへのインストールを記録できます。このAPIをサポートするために設定を変更する必要はありません。

Meta インストールリファラー
v4.37.0に追加

Adjust SDKはv4.37.0以降でMetaインストールリファラーをサポートしています。この機能を有効にする方法:

  1. App DashboardでMetaアプリIDを検索します。詳しくはMetaのアプリダッシュボードのドキュメントをご覧ください。

  2. MetaアプリをAndroidManifest.xmlファイルに追加します

    AndroidManifest.xml
    <queries>
    <package android:name="com.facebook.katana" />
    </queries>
    <queries>
    <package android:name="com.instagram.android" />
    </queries>
  3. AdjustConfig2dx.setFbAppIdメソッドに 文字列 の引数としてアプリIDをパスします。

    AdjustConfig2dx adjustConfig = AdjustConfig2dx(appToken, environment, false);
    adjustConfig.setFbAppId("your-fb-app-id");
    Adjust2dx::start(adjustConfig);

iOS設定

特定のiOS frameworksをアプリに実装した場合、Adjust SDKは追加の情報を取得できます。これらのframeworksによって特定のSDK機能を有効にできますが、SDKが正常に動作するために必須というわけではありません。Frameworksを実装して、 プロジェクト設定(Project Settings) > ビルドフェーズ(Build Phases) > バイナリとライブラリをリンク(Link Binary With Libraries) でそれらをオプションとしてマークすることができます。

Framework説明注意
AdSupport.frameworkデバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。
AdServices.frameworkApple Search Adsのアトリビューションを処理します。
StoreKit.frameworkSKAdNetworkフレームワークにアクセスできるようにします。iOS14以降のデバイスでAdjust SDKがSKAdNetworkとのコミュニケーションを行うために必要です。
AppTrackingTransparency.frameworkAdjust SDKがユーザーのトラッキング同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。

リンカーフラグを追加

AdjustSdk.frameworkからのカテゴリーをサポートするには、リンカーフラグを追加する必要があります。これを行うには、以下の手順に従ってください。

  1. Project Settings —> Build Settings に移動します。
  2. その他のリンカーフラグ を選択します。
  3. -ObjCフラグを追加します。

追加ソースファイルをコピー

iOSの設定を完了するには、Cocos2d C++ファイルと共に、全てのObjective-C++(.hおよび.mm)ファイルをXcodeプロジェクトにコピーする必要があります。全ての.mmファイルが Build Phases —> Compile Sources セクションに表示されていることを確認してください。

4. Adjust SDKを実装する

プロジェクトの設定を更新したら、Adjust SDKをアプリに実装することができます。これを行うには、以下の手順に従ってください。

  1. プロジェクトナビゲーター でアプリケーションデリゲートファイルを探し、開きます。

  2. ファイルの上部にAdjust/Adjust2dx.hクラスを含めます。

  3. 以下の引数を指定して、 applicationDidFinishLaunchingメソッド内でAdjustConfig2dxオブジェクトをインスタンス化します:

    • appToken: Adjustアプリトークン
    • environment: AdjustEnvironmentSandbox2dx
  4. 任意でログレベルを変更し、ログの詳細度を調整することができます。

  5. Adjust2dx::startメソッドを呼び出し、AdjustConfig2dxインスタンスを引数としてパスします。

#include "Adjust/Adjust2dx.h"
bool AppDelegate::applicationDidFinishLaunching() {
std::string appToken = "{YourAppToken}";
std::string environment = AdjustEnvironmentSandbox2dx;
AdjustConfig2dx adjustConfig = AdjustConfig2dx(appToken, environment);
adjustConfig.setLogLevel(AdjustLogLevel2dxVerbose);
Adjust2dx::start(adjustConfig);
}

5. セッション送信の設定(Androidのみ)

Adjust SDKがAndroidデバイスでセッション情報を送信できるようにするには、アプリがバックグラウンドに送信されるか、フォアグラウンドに移動した時に、特定のAdjustメソッドを呼び出す必要があります。これを設定するには、以下の手順に従ってください。

  1. プロジェクトナビゲーター でアプリケーションデリゲートファイルを探し、開きます。

  2. applicationWillEnterForeground メソッド内で onResume メソッドを呼び出してください。

  3. applicationDidEnterBackground メソッド内で onPause メソッドを呼び出してください。

    #include "Adjust/Adjust2dx.h"
    void AppDelegate::applicationDidEnterBackground() {
    #if (CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID)
    Adjust2dx::onPause();
    #endif
    }
    void AppDelegate::applicationWillEnterForeground() {
    #if (CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID)
    Adjust2dx::onResume();
    #endif
    }

6. アプリのビルド

設定が完了しました。これで、Cocos2d-xアプリのビルドと実行が可能になりました。ログを有効にして、問題がないか確認してください。ログを確認して、Install trackedメッセージがあるか調べます。

Adjust SDKを使用してユーザーをアトリビューションできるようになりました。