このガイドはまもなく廃止されます。
このREADMEファイルはまもなく廃止されます。SDKのドキュメントはAdjustヘルプセンターに掲載されています。以下のリンクよりご覧ください。
これはネイティブAdjust™のAndroid SDKガイドです。Adjust™についての詳細はadjust.comをご覧ください。
Read this in other languages: English, 中文, 日本語, 한국어.
- Pushトークン (uninstall tracking)
- アトリビューションコールバック
- 広告収益のトラッキング
- サブスクリプション計測
- イベントとセッションのコールバック
- ユーザーアトリビューション
- デバイス ID
- プリインストールトラッカー
- オフラインモード
- トラッキングの無効化
- イベントバッファリング
- バックグラウンドでのトラッキング
- GDPR消去する権利（忘れられる権利）
- サードパーティーとの共有
- ユーザー同意による計測
- "Session failed (Ignoring too frequent session...)"というエラーが出る
- ブロードキャストレシーバーがインストールリファラーを受信していない
- アプリ起動時にイベントを始動したい
Android サンプルアプリがexample ディレクトリ example-app-java および example-app-kotlin directories)にあります。Webviewに使用するサンプルアプリはexample-webbridge directory 、Android TVのサンプルは example-app-tvをご覧ください。をご覧ください。SDK実装の際は、Androidプロジェクトを開き、このサンプルをご参照ください。Androidプロジェクトを開くと、Adjust SDKの導入方法の実例を確認できます。
Adjust SDKをAndroidプロジェクトに実装する手順を説明します。ここでは、Androidアプリケーションの開発にAndroid Studioが使用されていること、また、対象はAndroid APIレベル9（Gingerbread) 以降であることを条件に説明します。
Mavenを使用している場合は、以下の内容をbuild.gradleファイルに追加します。file:
implementation 'com.adjust.sdk:adjust-android:4.28.4'
implementation 'com.android.installreferrer:installreferrer:2.2'アプリの WebView内でAdjust SDKを使用したい場合は、以下のdependencyを追加してください。
implementation 'com.adjust.sdk:adjust-android-webbridge:4.28.4'注意：WebView拡張機能用にサポートされている最小のAndroid APIレベルは17（Jelly Bean）です。
Adjust SDK およびWebView拡張機能をJAR ファイルとして追加し、Adjustリリースページからダウンロードすることもできます。
2014年8月1日より、Google Playストアのアプリには、端末をユニーク判別するためにGoogle Advertising ID（Google広告ID）の使用が義務付けられました。Adjust SDKでGoogle Advertising IDを使用するには、Google Play Serviceを導入する必要があります。導入済みでない場合は、以下の手順に沿って設定してください。アプリのbuild.gradleファイルを開き、dependenciesブロックに次の行を追加してください。file:
implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'注意：Adjust SDKは、Google Playサービスの一つであるplay-services-analyticsライブラリの特定のバージョンとは紐付いていませんので、必要に応じて最新バージョンをご使用ください。
AndroidManifest.xmlファイルにAdjust SDKに必要なパーミッションが存在しない場合は、以下を追加してください。
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>Google Playストア以外の第三者ストアからアプリをリリースする場合は、以下のパーミッションも追加してください。
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>Proguardをお使いの場合は、以下をProguardファイルに追加してください。
-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ストア以外の第三者ストアからアプリをリリースする場合は、com.adjust.sdkのパッケージ規定に従ってください。
-keep public class com.adjust.sdk.** { *; }
アプリのインストールをアトリビューションソースに正確にアトリビュートするため、Adjustはインストールリファラーの情報を必要とします。そのためにGoogle Play Referrer APIかブロードキャストレシーバーを使用して、Google Playストアのインテントを取得します。
重要：Google Play Referrer APIは、Androidのインストールリファラーをより安全に提供し、またクリックインジェクションの不正に対抗する目的でGoogleが新たに導入したものです。アプリケーションでこれをサポートすることを強く推奨します。Google Playストアのインテントは、インストールのリファラー情報を取得する上で安全性が低い方法です。当面、新しいGoogle Play Referrer APIと並行して引き続き存在しますが、将来廃止される予定です。
アプリでこのAPIをサポートするには、SDKをプロジェクトに追加するの章の手順に適切に従って、以下の行をbuild.gradleファイルに追加していることを確認してください。file:
implementation 'com.android.installreferrer:installreferrer:2.2'
また、Proguardの設定の章をよく読んで、記載されているすべてのルール、特に、この機能に必要なルールが追加されていることを確認してください。
-keep public class com.android.installreferrer.**{ *; }
この機能は、Adjust SDK v4.12.0以降を使用している場合にサポートされます。
注意：Googleは、リファラー情報を提供するためのINSTALL_REFERRERインテントの使用を2020年3月1日付で廃止することを発表しました 。この方法でリファラー情報にアクセスしている場合は、Google Play リファラーAPIの方法に移行してください。
Google Play ストアのINSTALL_REFERRERインテントは、ブロードキャストレシーバーを使用して受信することをおすすめします。ブロードキャストレシーバーを使用せずにINSTALL_REFERRERインテントを取得したい場合、以下のreceiverタグをAndroidManifest.xmlのapplicationタグ内に追加してください。
<receiver
android:name="com.adjust.sdk.AdjustReferrerReceiver"
android:permission="android.permission.INSTALL_PACKAGES"
android:exported="true" >
<intent-filter>
<action android:name="com.android.vending.INSTALL_REFERRER" />
</intent-filter>
</receiver>Adjustはこのブロードキャストレシーバーを使用して、インストールのリファラー情報を取得し、バックエンドに転送します。
INSTALL_REFERRERインテントに対して既に他のブロードキャストレシーバーを使用している場合、こちらの説明に従って、Adjust ブロードキャストレシーバーを追加してください。
v4.21.1以降より、Adjust SDKはHuawei App Galleryバージョン10.4以降のHuawei端末へのインストール計測をサポートしています。HuaweiリファラAPIの使用を開始するために連携手順を追加で設定する必要はありません。
まず最初に、基本的なセッショントラッキングを設定します。
ネイティブアプリにSDKを実装する場合は、以下のネイティブアプリSDKに示す手順に従ってください。SDKをアプリ内のWebViewで使用する場合は、以下のWebView SDKに示す手順に従ってください。
SDKの初期化には、Androidアプリケーションのグローバルクラスを使用することを推奨します。アプリ内に存在しない場合、以下の手順に従ってください。
-
Applicationを継承したクラスを作成します。 -
アプリの
AndroidManifest.xmlファイルを開き、applicationエレメントを確認します。 -
android:name属性を追加し、先頭にドット（.）を付けて新規アプリケーションのクラス名をセットします。サンプルアプリの場合、
GlobalApplicationという名前のApplicationクラスを使用しているため、マニフェストファイルの設定は以下の通りになります。<application android:name=".GlobalApplication" <!-- ... --> </application>
-
ApplicationクラスのonCreateメソッドをご確認いただき、無い場合は作成してください。また、以下のコードを追加してAdjust SDKを初期化してください。import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; public class GlobalApplication extends Application { @Override public void onCreate() { super.onCreate(); String appToken = "{YourAppToken}"; String environment = AdjustConfig.ENVIRONMENT_SANDBOX; AdjustConfig config = new AdjustConfig(this, appToken, environment); Adjust.onCreate(config); } }
{YourAppToken}をアプリトークンに差し替えてください。トークンは dashboard で確認できます。
アプリのビルドをテスト用（Sandbox）か本番用（Production）に分けるためには、SDK内の環境environmentをいずれかにセットする必要があります。
String environment = AdjustConfig.ENVIRONMENT_SANDBOX;
String environment = AdjustConfig.ENVIRONMENT_PRODUCTION;重要: リリース前のテスト段階では、AdjustConfig.ENVIRONMENT_SANDBOXに設定してください。アプリをストアに申請する前に、SDKの環境をAdjustConfig.ENVIRONMENT_PRODUCTIONに変更してください。再度開発やテストを行う場合は、設定をAdjustConfig.ENVIRONMENT_SANDBOXに戻してください。
Adjustはこの環境設定を使用して、本番用の計測数値とテスト端末からのテスト計測を区別してレポート画面に表示します。この値の設定には常に注意が必要ですが、購入イベントを計測する場合は特に気をつけてください。
WebViewオブジェクトのリファレンスを取得後：
webView.getSettings().setJavaScriptEnabled(true)を呼び出して、JavaScriptをWebViewで有効化しますAdjustBridge.registerAndGetInstance(getApplication(), webview)をコールしてAdjustBridgeInstanceのデフォルトインスタンスを起動します起動します- これにより、AdjustブリッジがWebViewのJavaScript Interfaceとして登録されます
- 必要に応じて、
AdjustBridge.setWebView()を呼び出して新たなWebViewを設定します AdjustBridgeInstanceとWebViewの登録を取り消す場合はAdjustBridge.unregister()を呼び出します
これらの手順を行うと、アクティビティは以下のように記述されます。
public class MainActivity extends Activity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
WebView webView = (WebView) findViewById(R.id.webView);
webView.getSettings().setJavaScriptEnabled(true);
webView.setWebChromeClient(new WebChromeClient());
webView.setWebViewClient(new WebViewClient());
AdjustBridge.registerAndGetInstance(getApplication(),webview);
try {
webView.loadUrl("file:///android_asset/AdjustExample-WebView.html");
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
protected void onDestroy() {
AdjustBridge.unregister();
super.onDestroy();
}
}この手順が完了すると、アプリに Adjust ブリッジが追加されます。JavaScript ブリッジは、Adjust のネイティブAndroid SDK と、WebViewにロードされるページの間での通信が可能となります。
HTMLファイルに、アセットのルートフォルダにある Adjust JavaScript をインポートしてください。HTML ファイルが同じ場所にある場合は、以下のような形でインポートできます：
<script type="text/javascript" src="adjust.js"></script>
<script type="text/javascript" src="adjust_event.js"></script>
<script type="text/javascript" src="adjust_third_party_sharing.js"></script>
<script type="text/javascript" src="adjust_config.js"></script>JavaScript ファイルにリファレンスを追加したら、 HTML ファイル内でそれを使って Adjust SDK を初期化します：
let yourAppToken = '{YourAppToken}';
let environment = AdjustConfig.EnvironmentSandbox;
let adjustConfig = new AdjustConfig(yourAppToken, environment);
Adjust.onCreate(adjustConfig);{YourAppToken}をアプリトークンに差し替えてください。トークンは[管理画面]で確認できます。
次に、まだテスト（Sandbox）を行っているか本番用モード（Production）にしているかに応じて、environmentを対応する値に設定します：
let environment = AdjustConfig.EnvironmentSandbox;
let environment = AdjustConfig.EnvironmentProduction;重要: アプリのテスト中は（その場合に限り）、値をAdjustConfig.EnvironmentSandboxに設定してください。アプリをストアに申請する前に、対象環境がAdjustConfig.EnvironmentProductionと設定されていることを確認してください。開発やテストを再開する場合は、値をAdjustConfig.EnvironmentSandboxに戻してください。
Adjustはこの環境設定を使用して、本番用の計測数値とテスト端末からのテスト計測を区別してレポート画面に表示します。この値の設定は常にご注意ください。
注意：この手順は非常に重要です。必ずアプリに正しく実装されていることを確認してください。この実装を行うことにより、アプリ内のAdjust SDKで適切なセッション計測が可能になります。
-
ActivityLifecycleCallbacksインターフェースを実装したプライベートクラスを追加します。このインターフェースを利用できなければ、そのアプリのAndroid APIレベルは14未満を対象としています。アクティビティをそれぞれ手動でアップデートする必要がありますので、こちらのガイドを参照してください。以前にAdjust.onResumeおよびAdjust.onPauseのコールを使っていた場合、これらを削除する必要があります。 -
onActivityResumed(Activity activity)メソッドを編集して、Adjust.onResume()のコールを追加します。 onActivityPaused(Activity activity)メソッドを編集して、Adjust.onPause()`のコールを追加します。 -
Adjust SDKの設定で、
onCreate()メソッドを追加します。作成したActivityLifecycleCallbacksのコールと、作成したregisterActivityLifecycleCallbacksクラスのインスタンスを追加してください。import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; public class GlobalApplication extends Application { @Override public void onCreate() { super.onCreate(); String appToken = "{YourAppToken}"; String environment = AdjustConfig.ENVIRONMENT_SANDBOX; AdjustConfig config = new AdjustConfig(this, appToken, environment); Adjust.onCreate(config); registerActivityLifecycleCallbacks(new AdjustLifecycleCallbacks()); } private static final class AdjustLifecycleCallbacks implements ActivityLifecycleCallbacks { @Override public void onActivityResumed(Activity activity) { Adjust.onResume(); } @Override public void onActivityPaused(Activity activity) { Adjust.onPause(); } //... } }
GradleのminSdkVersionが9から13の場合、14以降にアップデートすると、今後の連携の手順が容易になります。Android公式管理画面にて、最新バージョン関する情報をご確認ください。
セッショントラッキングを正しく行うためには、Acticityの開始または停止ごとにAdjust SDKの該当メソッドをコールする必要があります。この設定を行わないと、SDKはセッション開始やセッション終了を見落とす可能性があります。適切にセッションをトラッキングするには、すべてのアクティビティに対して以下の作業を行なってください。
- アクティビティの
onResume中にAdjust.onResume()をコールしてください。必要に応じてメソッドを作成してください。 - アクティビティの
onPause中にAdjust.onPause()をコールしてください。必要に応じてメソッドを作成してください。
これらの手順を行うと、アクティビティは以下のように記述されます。
import com.adjust.sdk.Adjust;
public class YourActivity extends Activity {
protected void onResume() {
super.onResume();
Adjust.onResume();
}
protected void onPause() {
super.onPause();
Adjust.onPause();
}
}これと同じ手順をアプリのすべてのアクティビティに行なってください。後ほど新しいアクティビティを作成する場合、この手順を忘れないでください。コーディングスタイルの違いによって、すべてのアクティビティに対する共通のスーパークラスにこれを実装するという方法もあります。
アカウントマネージャーがAdjust SDKシグネチャーを有効化する必要があります。この機能を使用する場合は、Adjustのサポート（[email protected]）までお問い合わせください。
すでにアカウントでSDKシグネチャーが有効になっており、Adjust管理画面のアプリシークレット（App Secret）にアクセスできる場合は、以下の方法を使用してアプリにSDKシグネチャーを実装してください。
アプリシークレットは、設定するインスタンスでsetAppSecretを呼び出して登録されます。
| Native App SDK |
AdjustConfig config = new AdjustConfig(this, appToken, environment);
config.setAppSecret(secretId, info1, info2, info3, info4);
Adjust.onCreate(config); |
| Web View SDK |
let adjustConfig = new AdjustConfig(yourAppToken, environment);
adjustConfig.setAppSecret(secretId,info1, info2, info3, info4);
Adjust.onCreate(adjustConfig); |
ConfigインスタンスのsetLogLevelに設定するパラメーターを変更することによって、記録するログのレベルを調節できます。
| Native App SDK |
config.setLogLevel(LogLevel.VERBOSE); // enable all logs
config.setLogLevel(LogLevel.DEBUG); // disable verbose logs
config.setLogLevel(LogLevel.INFO); // disable debug logs (default)
config.setLogLevel(LogLevel.WARN); // disable info logs
config.setLogLevel(LogLevel.ERROR); // disable warning logs
config.setLogLevel(LogLevel.ASSERT); // disable error logs
config.setLogLevel(LogLevel.SUPRESS); // disable all logs |
| Web View SDK |
adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose); // enable all logs
adjustConfig.setLogLevel(AdjustConfig.LogLevelDebug); // disable verbose logs
adjustConfig.setLogLevel(AdjustConfig.LogLevelInfo); // disable debug logs (default)
adjustConfig.setLogLevel(AdjustConfig.LogLevelWarn); // disable info logs
adjustConfig.setLogLevel(AdjustConfig.LogLevelError); // disable warning logs
adjustConfig.setLogLevel(AdjustConfig.LogLevelAssert); // disable error logs
adjustConfig.setLogLevel(AdjustConfig.LogLevelSuppress); // disable all logs |
すべてのログの出力を無効にする場合、ログレベルをsuppressに設定する他に、configオブジェクトのコンストラクタを使用してください (抑制されたログレベルがサポートされるべきかどうかを判定するboolean値が得られます)。
| Native App SDK |
AdjustConfig config = new AdjustConfig(this, appToken, environment);
config.setLogLevel(LogLevel.SUPRESS);
Adjust.onCreate(config); |
| Web View SDK |
let adjustConfig = new AdjustConfig(yourAppToken, environment, true);
adjustConfig.setLogLevel(AdjustConfig.LogLevelSuppress);
Adjust.onCreate(adjustConfig); |
Androidアプリをビルドして実行します。LogCatviewerにてtag:Adjustフィルターを設定し、他のすべてのログを非表示にすることができます。アプリが起動された後、Install trackedのログが出力されるはずです。
URLからアプリへのディープリンクを使ったAdjustトラッカーURLをご利用の場合、ディープリンクURLとその内容の情報を得ることが可能です。すでにアプリをインストールしている状態でそのURLを訪れる（スタンダードディープリンク）ユーザーもいれば、まだインストールしていないユーザーが開く（ディファードディープリンク）場合もあります。スタンダードディープリンクの場合、Androidのプラットフォームにはディープリンクの内容を取得できる仕組みがあります。ディファードディープリンクに対してはAndroidプラットフォームはサポートしていませんので、Adjust SDKがディープリンクの内容を取得するメカニズムを提供します。
アプリをインストール済みのユーザーがdeep_linkパラメーターのついたAdjustのトラッカーURLをクリックした後にそのアプリを起動させたい場合は、アプリのディープリンクを有効化してください。ユニークスキーム名を選択し、トラッカーがクリックされてアプリが開いた時に起動させたいactivityを指定することで有効化できます。これはAndroidManifest.xml内で設定できます。マニフェストファルの該当のactivity定義にintent-filterセクションを追加し、該当のスキーム名にandroid:schemeプロパティを指定してください。
<activity
android:name=".MainActivity"
android:configChanges="orientation|keyboardHidden"
android:label="@string/app_name"
android:screenOrientation="portrait">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="adjustExample" />
</intent-filter>
</activity>トラッカーURLのクリック後にアプリを起動させるには、AdjustトラッカーURLのdeep_linkパラメーターにあるスキーム名を指定する必要があります。ディープリンクに情報を追加していないトラッカーURLは次のようになります。
https://app.adjust.com/abc123?deep_link=adjustExample%3A%2F%2F
deep_linkパラメーターの値はURLエンコードされる必要があります。
トラッカーURLをクリック後、アプリが上記の設定をされていれば、アプリはMainActivityインテントの通りに起動します。MainActivityクラス内でdeep_linkパラメーターの内容が自動的に提供されます。届けられたこの情報はエンコードされていませんが、URL内ではエンコードされています。
AndroidManifest.xmlファイルのactivityのandroid:launchMode設定によっては、deep_linkパラメーターの内容情報はアクティビティファイルの適切な箇所に届けられます。android:launchModeのとり得る値について詳しくはAndroid公式資料をご確認ください。
指定のアクティビティにIntentオブジェクトを介してディープリンクの内容情報を送ることができる場所は2か所あります。activityのonCreateメソッドかonNewIntentメソッドのいずれかです。アプリが起動してこれらのどちらかのメソッドが呼ばれると、クリックURL中のdeep_linkパラメーター内の実際に渡されたディープリンクを取得することができます。この情報はロジックを追加する際に使うことができます。
これらのメソッドからディープリンク情報を抽出する方法は以下の通りです。
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Intent intent = getIntent();
Uri data = intent.getData();
// data.toString()-> This is your deep_link parameter value.
}@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
Uri data = intent.getData();
// data.toString()-> This is your deep_link parameter value.
}ユーザーがdeep_linkパラメーターのついたトラッカーURLをクリックし、アプリ未インストールの場合はディファードディープリンクが作動します。クリックしたユーザーはアプリストアにリダイレクトされます。アプリをダウンロードし初回起動したタイミングで、deep_linkパラメーターの内容がアプリに送信されます。
Adjust SDKはデフォルトでディファードディープリンクを開きます。追加設定の必要はありません。
コールバック関数を用いて、SDKがディファードディープリンクを開くかどうかを決めることができます。
| Native App SDK |
AdjustConfig config = new AdjustConfig(this, appToken, environment);
// Evaluate the deeplink to be launched.
config.setOnDeeplinkResponseListener(newOnDeeplinkResponseListener() {
@Override
public boolean launchReceivedDeeplink(Uri deeplink) {
// ...
if (shouldAdjustSdkLaunchTheDeeplink(deeplink)) {
return true;
} else {
return false;
}
}
});
Adjust.onCreate(config);Adjust SDKがサーバーからディープリンク情報を受信すると、リスナ内のディープリンク内容の情報を送信しますので、
|
| Web View SDK |
let adjustConfig = new AdjustConfig(yourAppToken, environment);
adjustConfig.setDeferredDeeplinkCallback(function(deeplink) {});
Adjust.onCreate(adjustConfig);このディファードディープリンクのシナリオでは、Configオブジェクトにもう1つの設定を追加できます。Adjust SDK がディファードディープリンクに関する情報を入手すると、SDK で URL を開くかどうかを選択できます。このオプションについては、Configオブジェクトで // ...
function deferredDeeplinkCallback(deeplink) {}
let adjustConfig = new AdjustConfig(yourAppToken, environment);
adjustConfig.setOpenDeferredDeeplink(true);
adjustConfig.setDeferredDeeplinkCallback(deferredDeeplinkCallback);
Adjust.start(adjustConfig);コールバックを設定しない場合、Adjust SDK はデフォルトで常にURLを立ち上げようとすることにご注意ください。 |
Adjustはディープリンクを使ったリエンゲージメントキャンペーンをサポートしています。詳しくは公式資料をご覧ください。
この機能をご利用の場合は、ユーザーが正しくリアトリビューションされるために、Adjust SDKへのコールを追加してください。
アプリでディープリンクの内容データを受信したら、Adjust.appWillOpenUrl(Uri, Context)メソッドへのコールを追加してください。このコールによって、Adjust SDKはディープリンクの中に新たなアトリビューションが存在するかを調べ、あった場合はAdjustサーバーにこれを送信します。ディープリンクのついたAdjustトラッカーURLのクリックによってユーザーがリアトリビュートされる場合、アトリビューションコールバックがこのユーザーの新しいアトリビューションデータで呼ばれます。
Adjust.appWillOpenUrl(Uri, Context)のコールは下記のようになります。
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Intent intent = getIntent();
Uri data = intent.getData();
Adjust.appWillOpenUrl(data, getApplicationContext());
}@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
Uri data = intent.getData();
Adjust.appWillOpenUrl(data, getApplicationContext());
}注: Android SDK v4.14.0より、Adjust.appWillOpenUrl(Uri)メソッドはdeprecated（推奨されていません） と表示されます。代わりにAdjust.appWillOpenUrl(Uri,Context)メソッドを使用してください。
Web viewに関する注意:このコールは、web viewから関数Adjust.appWillOpenUrlをJavascript でこのように作成することもできます:
Adjust.appWillOpenUrl(deeplinkUrl);Emailサービスプロバイダー（ESP）独自のカスタムトラッキングリンク経由でディープリンクを使用したり、クリックを計測する必要がある場合は、AdjustLinkResolutionクラスのresolveLinkメソッドを使用してリンクをresolve（解析し、変換すること）します。これにより、アプリでディープリンクが開かれた時に、メール計測キャンペーンとのインタラクションを記録できます。
resolveLinkメソッドでは、以下のパラメーターが使用できます。
url- アプリを起動したディープリンクresolveUrlSuffixArray- リンクの解析が必要な、設定済みキャンペーンのカスタムドメインadjustLinkResolutionCallback- 最終的なURLを含むコールバック
受信したリンクがresolveUrlSuffixArrayで指定されたドメインのいずれにも属さない場合、コールバックはディープリンクURLをそのまま転送します。リンクが指定されたドメインのいずれかを含む場合、SDKはリンクの解析を試み、callbackパラメーターにディープリンクを返します。返されたディープリンクは、Adjust.appWillOpenUrlメソッドを使ってAdjust SDKでリアトリビュートすることも可能です。
注: URLの解析と変換が行われると、SDKは自動的に最大10のリダイレクトをフォローします。さらに、SDKはフォローした最新のURLを
callbackURLとして返します。つまり、フォローするリダイレクトが10個を超える場合は10番目のリダイレクトURLが返されます。
例
AdjustLinkResolution.resolveLink(url,
new String[]{"example.com"},
new AdjustLinkResolution.AdjustLinkResolutionCallback() {
@Override
public void resolvedLinkCallback(Uri resolvedLink) {
Adjust.appWillOpenUrl(resolvedLink, getApplicationContext());
}
});Adjustを使ってアプリ内のイベントをトラッキングすることができます。ここではあるボタンのタップを毎回トラックするケースを想定して説明します。管理画面にてイベントトークンを作成します。そのイベントトークンは仮にabc123とします。タップをトラックするため、ボタンのonClickメソッドに以下のような記述を追加します。
| Native App SDK |
AdjustEvent adjustEvent = new AdjustEvent("abc123");
Adjust.trackEvent(adjustEvent); |
| Web View SDK |
let adjustEvent = new AdjustEvent('abc123');
Adjust.trackEvent(adjustEvent); |
広告へのタップはもちろん、アプリ内購入の発生時もトラッキングが可能です。例えば、1回のタップで1ユーロセントの報酬と仮定すると、報酬イベントを以下のようにトラッキングできます。
| Native App SDK |
AdjustEvent adjustEvent = new AdjustEvent("abc123");
adjustEvent.setRevenue(0.01,"EUR");
Adjust.trackEvent(adjustEvent); |
| Web View SDK |
let adjustEvent = new AdjustEvent('abc123');
adjustEvent.setRevenue(0.01,'EUR');
Adjust.trackEvent(adjustEvent); |
これはコールバックパラメーターと紐付けることができます。
通貨トークンを設定する場合、Adjustは自動的に収益を任意の報酬に変換します。詳しくは通貨の変換をご覧ください。
アプリ内購入をトラッキングする際は、支払いが終了し、アイテムが購入された後にtrackEventをコールするようにしてください。実際に発生しなかった収益イベントをトラッキングしてしまうのを防ぐためです。
収益とイベントトラッキングについてはイベントトラッキングガイドもご参照ください。
オプションとしてオーダーIDを追加することにより、収益イベントが重複してトラッキングされるのを防ぐことができます。これを実行すると、10個前までのオーダーIDが記憶され、収益イベントに紐づけられたオーダーIDが重複している場合、そのイベントを排除します。これは、アプリ内購入の計測に特に有効です。以下の例をご参照ください。
| Native App SDK |
AdjustEvent adjustEvent = new AdjustEvent("abc123");
adjustEvent.setRevenue(0.01,"EUR");
adjustEvent.setOrderId("{OrderId}");
Adjust.trackEvent(adjustEvent); |
| Web View SDK |
let adjustEvent = new AdjustEvent('abc123');
adjustEvent.setRevenue(0.01,'EUR');
adjustEvent.setOrderId('{OrderId}');
Adjust.trackEvent(event); |
Adjustのサーバーサイドのレシート認証ツール、購入認証（Purchase Verification）を使ってアプリ内で行われたアプリ内収益の妥当性を調べる際は、 Android purchase SDKをご利用ください。詳しくはこちらをご覧ください。
Adjust SDKがデフォルトで収集するローデータに加えて、Adjust SDKを使用してカスタム値(ユーザーID、製品IDなど)を必要な数だけトラッキングし、イベントまたはセッションに追加できます。カスタムパラメーターはローデータとして転送されます。Adjust管理画面には表示されません。
Adjust SDK が標準仕様で取得するパラメーター（IDFAなど）に加え、Adjust SDK を使ってカスタム値（クライアント様が保有するユーザー ID、商品 ID など）をイベントまたはセッションに追加することができます。カスタムパラメーターは、コールバック経由でのみ送信が可能で、Adjust管理画面のレポートには表示されません。社内と外部パートナー双方の利用目的で値をトラッキングする場合は（例えば商品 ID など）、リアルタイムコールバックとパートナーパラメーターの両方にてトラッキングすることを推奨します。
[管理画面]でイベントにコールバックURLを登録することができます。イベントがトラッキングされるたびにそのURLにGETリクエストが送信されます。トラッキングする前にイベントでaddCallbackParameterをコールすることによって、イベントにコールバックパラメーターを追加できます。AdjustはそれらのパラメーターをコールバックURLに追加します。
例えば、コールバックURLに http://www.example.com/callbackと登録した場合、次のようにイベントをトラッキングします。
| Native App SDK |
AdjustEvent adjustEvent = new AdjustEvent("abc123");
adjustEvent.addCallbackParameter("key","value");
adjustEvent.addCallbackParameter("foo","bar");
Adjust.trackEvent(adjustEvent); |
| Web View SDK |
let adjustEvent = new AdjustEvent('abc123');
adjustEvent.addCallbackParameter('key','value');
adjustEvent.addCallbackParameter('foo','bar');
Adjust.trackEvent(adjustEvent); |
この場合、Adjustは以下のGETリクエストを送信します。
http://www.example.com/callback?key=value&foo=bar
Adjustはさまざまなパラメーターをサポートしています。例えば{gps_adid}はパラメーター値として利用できます。コールバック内で、このプレースホルダーは該当デバイスのGoogle Play Service IDに置き換えられます。独自に設定されたパラメーターには何も格納されませんが、コールバックに追加されます。イベントにコールバックを登録していない場合、Adjustがこれらのパラメーターを読むことはありません。
URLコールバックについて詳しくはコールバックガイドをご覧ください。利用可能な値のリストもこちらで参照してください。
Adjustの管理画面上で連携が有効化されているネットワークパートナーに送信するパラメーターを設定することができます。
これは上記のコールバックパラメーターと同様に機能しますが、イベントインスタンスのaddPartnerParameterメソッドをコールすることにより追加されます。
| Native App SDK |
AdjustEvent adjustEvent = new AdjustEvent("abc123");
adjustEvent.addPartnerParameter("key","value");
adjustEvent.addPartnerParameter("foo","bar");
Adjust.trackEvent(adjustEvent); |
| Web View SDK |
let adjustEvent = new AdjustEvent('abc123');
adjustEvent.addPartnerParameter('key','value');
adjustEvent.addPartnerParameter('foo','bar');
Adjust.trackEvent(adjustEvent); |
スペシャルパートナーとの連携方法の詳細については、スペシャルパートナーガイド スペシャルパートナーをご覧ください。
トラッキングしたいイベントにカスタムIDを追加できます。このIDはイベントをトラッキングし、成功か失敗かの通知を受け取けとれるようコールバックを登録することができます。イベントインスタンスにsetCallbackIdメソッドをコールしてこのIDを設定してください：
| Native App SDK |
AdjustEvent adjustEvent = new AdjustEvent("abc123");
adjustEvent.setCallbackId("Your-Custom-Id");
Adjust.trackEvent(adjustEvent); |
| Web View SDK |
let adjustEvent = new AdjustEvent('abc123');
adjustEvent.setCallbackId('Your-Custom-Id');
Adjust.trackEvent(adjustEvent); |
いくつかのパラメーターは、Adjust SDKのイベントごと、セッションごとに送信するために保存されます。このいずれかのパラメーターを追加すると、これらはローカルに保存されるため、毎回追加する必要はありません。同じパラメーターを再度追加しても何も起こりません。
これらのセッションパラメーターはAdjust SDKが起動する前にコールすることができます。インストール時にパラメーターを送信したい場合は、Adjust SDKの初回起動を遅らせることができます。ただし、必要なパラメーターの値を得られるのは起動後となります。
イベントで設定された同じコールバックパラメーターを、 Adjust SDKのイベントごとまたはセッションごとに送信するために保存することもできます。
セッションコールバックパラメーターのインターフェイスとイベントコールバックパラメーターは似ています。イベントにキーと値を追加する代わりに、AdjustのAdjust.addSessionCallbackParameter(String key, String value)へのコールで追加されます。
| Native App SDK |
adjustEvent.addCallbackParameter("foo", "bar"); |
| Web View SDK |
Adjust.addSessionCallbackParameter('foo', 'bar'); |
セッションコールバックパラメーターは、イベントに追加されたコールバックパラメーターとマージされます。イベントに追加されたコールバックパラメーターは、セッションコールバックパラメーターより優先されます。イベントに追加されたコールバックパラメーターがセッションから追加されたパラメーターと同じキーを持っている場合、イベントに追加されたコールバックパラメーターの値が優先されます。
Adjust.removeSessionCallbackParameter(String key)メソッドに指定のキーを渡すことで、特定のセッションパートナーパラメーターを削除することができます。
| Native App SDK |
AdjustEvent.addCallbackParameter("foo", "bar"); |
| Web View SDK |
Adjust.removeSessionCallbackParameter('foo'); |
セッションコールバックパラメーターからすべてのキーと値を削除したい場合は、Adjust.resetSessionCallbackParameters()メソッドを使ってリセットすることができます。
| Native App SDK |
Adjust.resetSessionCallbackParameters(); |
| Web View SDK |
Adjust.resetSessionCallbackParameters(); |
Adjust SDKのイベントごとやセッションごとに送信されるセッションコールバックパラメーターがあるように、セッションパートナーパラメーターも用意されています。
これらはAdjustのネットワークパートナーに送信されます。Adjust[管理画面]のパートナー設定で有効化された連携に利用されます。
セッションパートナーパラメーターのインターフェイスとイベントパートナーパラメーターは似ています。イベントにキーと値を追加する代わりに、Adjust.addSessionPartnerParameter(String key, String value)へのコールで追加されます。
| Native App SDK |
adjustEvent.addCallbackParameter("foo", "bar"); |
| Web View SDK |
Adjust.addSessionPartnerParameter('foo', 'bar'); |
セッションパートナーパラメーターはイベントに追加されたパートナーパラメーターとマージされます。イベントに追加されたパートナーパラメーターは、セッションパートナーパラメーターより優先されます。イベントに追加されたパートナーパラメーターがセッションから追加されたパラメーターと同じキーを持っている場合、イベントに追加されたパートナーパラメーターの値が優先されます。
Adjust.removeSessionPartnerParameter(String key)メソッドに指定のキーを渡すことで、特定のセッションパートナーパラメーターを削除することができます。
| Native App SDK |
Adjust.removeSessionPartnerParameter("foo"); |
| Web View SDK |
Adjust.removeSessionPartnerParameter('foo'); |
セッションパートナーパラメーターからすべてのキーと値を削除したい場合は、Adjust.resetSessionPartnerParameters()メソッドを使ってリセットすることができます。
| Native App SDK |
Adjust.resetSessionPartnerParameters(); |
| Web View SDK |
Adjust.resetSessionPartnerParameters(); |
Adjust SDKの初回起動を遅らせると、ユニークID（会員ID）などのセッションパラメーターを取得してインストール時に送信できるようになります。
ConfigインスタンスのsetDelayStartメソッドで、ディレイタイムを秒単位で設定できます。
| Native App SDK |
adjustConfig.setDelayStart(5.5); |
| Web View SDK |
adjustConfig.setDelayStart(5.5); |
この場合、Adjust SDKは最初のインストールセッションと生成されるイベントを5.5秒間は送信しません。設定された時間が過ぎるまで、もしくはAdjust.sendFirstPackages()がコールされるまで、セッションパラメーターはすべてディレイインストールセッションとイベントに追加され、Adjust SDKは通常通り再開します。
Adjust SDKのディレイスタートは最大で10秒です。
プロジェクトにAdjust SDKを連携させると、以下の機能をご利用できるようになります。
Pushトークンは、オーディエンスビルダーやコールバックに使用されます。また、アンインストールや再インストールのトラッキングにも必要です。
Push通知のトークンを送信する場合は、トークンを取得したら（あるいはその値が変更される度に）、Adjustに以下のコールを追加してください：
| Native SDK |
Adjust.setPushToken(pushNotificationsToken, context);シグネチャーに しかし、 |
| Web View SDK |
Adjust.setPushToken(pushNotificationsToken); |
トラッカーのアトリビューション変化の通知を受けるために、リスナーを登録することができます。アトリビューションには複数の流入元が紐づく可能性があるため、この情報は同時に送ることができません。
アトリビューションデータに関するポリシーを必ずご確認ください。
Configインスタンスで、SDKをスタートする前に以下のアトリビューションコールバックを追加してください。
| Native App SDK |
AdjustConfig config = new AdjustConfig(this, appToken, environment);
config.setOnAttributionChangedListener(newOnAttributionChangedListener() {
@Override
public void onAttributionChanged(AdjustAttribution attribution) {}
});
Adjust.onCreate(config); |
| Web View SDK |
function attributionCallback(attribution) {}
// ...
let adjustConfig = new AdjustConfig(yourAppToken, environment);
adjustConfig.setAttributionCallback(attributionCallback);
Adjust.onCreate(adjustConfig); |
リスナーはSDKが最後のアトリビューションデータを取得した時に呼ばれます。リスナーの機能でattributionパラメーターを確認することができます。このパラメーターのプロパティの概要は以下のとおりです。
trackerToken最新アトリビューションのトラッカートークンtrackerName最新アトリビューションのトラッカー名network最新アトリビューションの流入元名campaign最新アトリビューションのキャンペーン名adgroup最新アトリビューションのアドグループ名creative最新アトリビューションのクリエイティブ名clickLabel最新アトリビューションのクリックラベルadidAdjustユニークID（Adjust Device ID）costTypeコストタイプの文字列costAmountコストの金額costCurrencyコスト通貨の文字列
注：コストデータ - costType、costAmountおよびcostCurrencyは、setNeedsCostメソッドを呼び出してAdjustConfigで設定された場合にのみ利用可能です。設定されていない場合、あるいは設定されていてもアトリビューションの一部でない場合は、これらのフィールドはnullの値を持ちます。この機能はSDK v4.25.0以降のみ利用可能です。
注：この機能はネイティブのSDK v4.22.0以降のみ利用可能です。
Play Storeのサブスクリプションをトラッキングし、それぞれの有効性をAdjust SDKで確認できます。サブスクリプションの購入が完了したら、次のようにAdjust SDKを呼び出します。
| Native App SDK |
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
price,
currency,
sku,
orderId,
signature,
purchaseToken);
subscription.setPurchaseTime(purchaseTime);
Adjust.trackPlayStoreSubscription(subscription); |
Subscription tracking parameters:
イベント計測と同様に、コールバックやパートナーのパラメーターをサブスクリプションオブジェクトに付与できます。
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
price,
currency,
sku,
orderId,
signature,
purchaseToken);
subscription.setPurchaseTime(purchaseTime);
// コールバックパラメーターの追加
subscription.addCallbackParameter("key","value");
subscription.addCallbackParameter("foo","bar");
// パートナーパラメーターの追加
subscription.addPartnerParameter("key","value");
subscription.addPartnerParameter("foo","bar");
Adjust.trackPlayStoreSubscription(subscription);注：この機能はネイティブのSDK v4.18.0以降のみ利用可能です。
Adjust SDKを利用して、以下のメソッドを呼び出し広告収益情報を計測することができます。
| Native App SDK |
Adjust.trackAdRevenue(source, payload); |
Adjust SDKにパスするメソッドの引数は以下の通りです。
source- 広告収益情報のソースを指定するStringオブジェクトpayload-広告収益のJSONを格納するJSONObject`オブジェクト
現在、弊社は以下のsourceパラメータの値のみ対応しています。
AD_REVENUE_MOPUB- メディエーションプラットフォームのMoPubを示します。（詳細は、統合ガイドを参照ください）
イベントとセッションの双方もしくはどちらかをトラッキングし、成功か失敗かの通知を受け取れるようリスナーを登録することができます。リスナーには４種類あります。それらは、トラッキングに成功したイベント、トラッキングに失敗したイベント、トラッキングに成功したセッション、トラッキングに失敗したイベントです。Configオブジェクトを生成すると、リスナーをいくつでも追加することができます。
| Native App SDK |
AdjustConfig config = new AdjustConfig(this, appToken, environment);
// Set event success tracking delegate.
config.setOnEventTrackingSucceededListener(newOnEventTrackingSucceededListener() {
@Override
public void onFinishedEventTrackingSucceeded(AdjustEventSuccess eventSuccessResponseData) {
// ...
}
});
// Set event failure tracking delegate.
config.setOnEventTrackingFailedListener(newOnEventTrackingFailedListener() {
@Override
public void onFinishedEventTrackingFailed(AdjustEventFailure eventFailureResponseData) {
// ...
}
});
// Set session success tracking delegate.
config.setOnSessionTrackingSucceededListener(newOnSessionTrackingSucceededListener() {
@Override
public void onFinishedSessionTrackingSucceeded(AdjustSessionSuccess sessionSuccessResponseData) {
// ...
}
});
// Set session failure tracking delegate.
config.setOnSessionTrackingFailedListener(newOnSessionTrackingFailedListener() {
@Override
public void onFinishedSessionTrackingFailed(AdjustSessionFailure sessionFailureResponseData) {
// ...
}
});
Adjust.onCreate(config); |
| Web View SDK |
function eventSuccessCallback(eventSuccessResponseData) {}
function eventFailureCallback(eventFailureResponseData) {}
function sessionSuccessCallback(sessionSuccessResponseData) {}
function sessionFailureCallback(sessionFailureResponseData) {}
// ...
let adjustConfig = new AdjustConfig(yourAppToken, environment);
adjustConfig.setEventSuccessCallback(eventSuccessCallback);
adjustConfig.setEventFailureCallback(eventFailureCallback);
adjustConfig.setSessionSuccessCallback(sessionSuccessCallback);
adjustConfig.setSessionFailureCallback(sessionFailureCallback);
Adjust.onCreate(adjustConfig); |
リスナー関数はSDKがサーバーにパッケージ送信を試みた後で呼ばれます。リスナー関数内でリスナー用のレスポンスデータオブジェクトを確認することができます。レスポンスデータのプロパティの概要は以下の通りです。
messageサーバーからのメッセージまたはSDKのエラーログtimestampサーバーからのタイムスタンプadidAdjustから提供されるユニークデバイスIDjsonResponseサーバーからのレスポンスのJSONオブジェクト
どちらのイベントレスポンスデータオブジェクトも以下を含みます。
eventTokenトラッキングされたパッケージがイベントだった場合、そのイベントトークンcallbackIdイベントオブジェクトにカスタム設定されたコールバックID
失敗したイベントとセッションは以下を含みます。
willRetry後にパッケージ再送を試みる予定であるかどうかを示すboolean
アトリビューションコールバックで説明したとおり、アトリビューション情報に変更がある度に、このコールバックが起動されます。Adjust インスタンスの以下のメソッドをコールすることで、必要な時にいつでもユーザーの最新のアトリビューション情報にアクセスすることができます：
| Native App SDK |
AdjustAttribution attribution = Adjust.getAttribution(); |
| Web View SDK |
let attribution = Adjust.getAttribution(); |
注意： このコールは、Adjust SDK v4.11.0以上で使用が可能です。
注意： 最新のアトリビューション情報は、Adjustがバックエンドで行うアプリインストールのトラッキングが完了し、アトリビューションコールバックがトリガーされた後にのみ利用が可能となります。SDKが初期化され、アトリビューションコールバックがトリガーされる前には、ユーザーのアトリビューション値にアクセスすることができません。
Adjust SDK を使って、デバイス ID を取得することもできます。
Google Analyticsなどの一部のサービスでは、レポートの重複を防ぐためにデバイスIDとクライアントIDを連携させることが求められます。
| Native App SDK |
|
Google 広告IDは、バックグラウンドでのスレッドでしか読み込みできないという制約があります。コンテキストのある Adjust.getGoogleAdId(this, new OnDeviceIdsRead() {
@Override
public void onGoogleAdIdRead(String googleAdId) {}
}); |
| Web View SDK |
|
デバイスの Google 広告デバイス ID を取得する際には、Google 広告 ID を引数として受け取る Adjust.getGoogleAdId(function(googleAdId) {
// ...
}); |
Amazonの広告 ID を取得する必要がある場合は、Adjustインスタンスで、以下のメソッドを呼び出します：
| Native App SDK |
String amazonAdId = Adjust.getAmazonAdId(context); |
| Web View SDK |
let amazonAdId = Adjust.getAmazonAdId(); |
アプリがインストールされている各デバイスに対して、Adjust は、バックエンドでユニークな Adjust デバイス ID (adid) を生成します。この ID を取得するためには、Adjustインスタンスで、以下のメソッドを呼び出してください：
| Native App SDK |
String adid = Adjust.getAdid(); |
| Web View SDK |
let adid = Adjust.getAdid(); |
注意： このコールは、Adjust SDK v4.11.0以降で使用が可能です。
注意：adidに関する情報は、Adjustがバックエンドで行うアプリインストールのトラッキングが完了後のみ利用可能となります。SDKが初期化されてアプリインストールのトラッキングが完了しないと、adid値にアクセスすることはできません。
Adjust SDKは、出荷直後のスマートフォンにプリインストールされたアプリの初回起動を計測することが可能です。Adjustでは、システムペイロードを使用するソリューションと、デフォルトトラッカーを使用するソリューションの2つを提供しています。
通常は、システムペイロードのソリューションを推奨します。ただし、特定の状況ではトラッカーの利用が必要な場合があります。Adjustのプリインストールパートナーとパートナーとの統合についてはヘルプセンターをご覧ください。どちらのソリューションを実装すればよいか不明な場合は、[email protected]までお問い合わせください。
このソリューションはSDK v4.23.0以上でサポートされています。
configオブジェクトを作成した後、パラメーターtrueを指定してsetPreinstallTrackingEnabledを呼び出すことによって、プリインストールアプリを認識するためのAdjust SDKを有効にします。
| Native App SDK |
adjustConfig.setPreinstallTrackingEnabled(true); |
| Web View SDK |
adjustConfig.setPreinstallTrackingEnabled(true); |
-
[管理画面]上で新しいトラッカーを作成してください。
-
App Delegateを開き、Configのデフォルトトラッカーを設定してください。
Native App SDK AdjustConfig adjustConfig = new AdjustConfig(appToken, environment);
Web View SDK adjustConfig.setDefaultTracker('{TrackerToken}');
-
{TrackerToken}をステップ2で作成したトラッカートークンに差し替えてください。管理画面にはhttp://app.adjust.com/を含むトラッカーURLが表示されます。ソースコード内にはこのURLすべてではなく、6文字のトークンを抜き出して指定してください。 -
アプリをビルドしてください。LogCatで下記のような行が表示されるはずです。
Default tracker: 'abc123'
Adjustのサーバーへの送信を一時停止し、保持されているトラッキングデータを後から送信するためにAdjust SDKをオフラインモードにすることができます。オフラインモード中はすべての情報がファイルに保存されるため、イベントを多く発生させすぎないようにご注意ください。
trueパラメーターでsetOfflineMode を呼び出すと、オフラインモードを有効にできます。
| Native App SDK |
Adjust.setOfflineMode(true); |
| Web View SDK |
Adjust.setOfflineMode(true); |
反対に、falseパラメーターでsetOfflineModeを呼び出すと、オフラインモードを解除できます。Adjust SDKがオンラインモードに戻った時、保存されていた情報は正しいタイムスタンプでAdjustのサーバーに送られます。
トラッキングの無効化とは異なり、この設定はセッション間で記憶されません。オフラインモード時にアプリを終了しても、次に起動した時にはオンラインモードとしてアプリが起動します。
setEnabledにパラメーターfalseを渡すことで、AdjustSDKが行うデバイスのアクティビティのトラッキングをすべて無効にすることができます。この設定はセッション間で記憶されます。
| Native App SDK |
Adjust.setEnabled(false); |
| Web View SDK |
Adjust.setEnabled(false); |
Adjust SDKが現在有効化されているかどうかは、isEnabled関数を呼び出すことで確認できます。また、setEnabled関数にtrueを渡せば、Adjust SDKを有効化することができます。
イベントトラッキングを大量に行っている場合は、ネットワークリクエストを遅らせて1分毎にまとめて送信したほうがいい場合があります。その場合は、Configインスタンスでイベントバッファリングを有効にしてください。
| Native App SDK |
adjustConfig.setEventBufferingEnabled(true); |
| Web View SDK |
adjustConfig.setEventBufferingEnabled(true); |
デフォルトでは、アプリがバックグラウンドにある間、Adjust SDKはネットワークリクエストの送信を停止します。この設定はConfigインスタンスで変更できます。
| Native App SDK |
adjustConfig.setSendInBackground(true); |
| Web View SDK |
adjustConfig.setSendInBackground(true); |
EUの一般データ保護規制(GDPR)第17条に基づいて、ユーザーが「忘れられる権利（right to be forgotten）」を行使した場合は、Adjustに通知することができます。次のメソッドを呼び出して、ユーザーの申請をAdjustバックエンドに伝えるようAdjust SDKに指示してください。
| Native App SDK |
Adjust.gdprForgetMe(context); |
| Web View SDK |
```Adjust.gdprForgetMe(); |
この情報を受け取ると、Adjustは該当ユーザーのデータを消去し、Adjust SDKはユーザーのトラッキングを停止します。以降、そのデバイスからのリクエストはAdjustに送信されません。
この変更はテストを行なっている場合でも恒久的で、元の設定に戻すことはできないことをご留意ください。
ユーザーがサードパーティーとのデータ共有を無効化、有効化、あるいは再有効化する情報をAdjustに送信することができます。
次のメソッドを呼び出して、ユーザーの選択（データ共有を無効にする）をAdjustバックエンドに伝えるようAdjust SDKに指示してください。
| Native App SDK |
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(false);
Adjust.trackThirdPartySharing(adjustThirdPartySharing); |
| Web View SDK |
let adjustThirdPartySharing = new AdjustThirdPartySharing(false);
Adjust.trackThirdPartySharing(adjustThirdPartySharing); |
この情報を受け取ると、Adjustは特定のユーザーに関してパートナーとのデータ共有をブロックし、Adjust SDKは通常通り機能します。
次のメソッドを呼び出して、データ共有あるいはデータ共有の変更に関するユーザーの選択をAdjustバックエンドに伝えるようAdjust SDKに指示してください。
| Native App SDK |
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
Adjust.trackThirdPartySharing(adjustThirdPartySharing); |
| Web View SDK |
let adjustThirdPartySharing = new AdjustThirdPartySharing(true);
Adjust.trackThirdPartySharing(adjustThirdPartySharing); |
この情報を受け取ると、Adjustは特定のユーザーに関してパートナーとのデータ共有設定を変更し、Adjust SDKは通常通り機能します。
次のメソッドを呼び出して、詳細なオプションをAdjustバックエンドに送信するようAdjust SDKに指示してください。
| Native App SDK |
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null);
adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar");
Adjust.trackThirdPartySharing(adjustThirdPartySharing); |
| Web View SDK |
let adjustThirdPartySharing = new AdjustThirdPartySharing(null);
adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar");
Adjust.trackThirdPartySharing(adjustThirdPartySharing); |
Adjust管理画面で同意有効期間とユーザーデータ保持期間を含むデータプライバシー設定を有効化あるいは無効化するには、以下のメソッドを実装してください。
次のメソッドを呼び出して、データプライバシー設定をAdjustバックエンドに伝えるようAdjust SDKに指示してください。
| Native App SDK |
Adjust.trackMeasurementConsent(true); |
| Web View SDK |
Adjust.trackMeasurementConsent(true); |
この情報を受け取ると、Adjustは同意による計測を有効化、あるいは無効化します。Adjust SDKは通常通り機能します。
このエラーはインストールのテストの際に起こりえます。アンインストール後に再インストールするだけでは新規インストールとして動作しません。SDKがローカルで統計したセッションデータを失ったとサーバーは判断してエラーメッセージを無視し、その端末に関する有効なデータのみが与えられます。
この仕様はテスト中には厄介かもしれませんが、サンドボックスと本番用の挙動をできる限り近づけるために必要です。
アプリに対して、編集者レベル（または管理人権限）のアクセス権を持っている場合には、どんなデバイスに対するアプリのセッションデータについても、テストコンソールを使ってAdjust管理画面から直接リセットすることができます。
端末に関する記録が消去されると、テスティングコンソールはForgot deviceと返します。もしその端末の記録がすでに消去されていたり、値が不正だった場合は、そのリンクはAdvertising ID not foundと返します。
端末に関する記録を消去しても、GDPR 忘れられる権利のコールを元に戻すことはできません。
現在ご契約のパッケージでアクセスが可能の場合は、開発者用APIで設定確認と端末記録の消去を行うことができます。
ガイドに従って設定を済ませていれば、ブロードキャストレシーバーはAdjustのSDKとサーバーにインストールを送信するよう設定されているはずです。
手動でテスト用インストールリファラーを作動させることで確認できます。com.your.appidにアプリIDを入力し、Android Studioのadbツールで以下のコマンドを実行してください。
adb shell am broadcast -a com.android.vending.INSTALL_REFERRER -n com.your.appid/com.adjust.sdk.AdjustReferrerReceiver --es "referrer" "adjust_reftag%3Dabc1234%26tracking_id%3D123456789%26utm_source%3Dnetwork%26utm_medium%3Dbanner%26utm_campaign%3Dcampaign"
INSTALL_REFERRERインテントに対してすでに別のブロードキャストリファラーを使っている状態でこのガイドの設定をした場合、com.adjust.sdk.AdjustReferrerReceiverにブロードキャストレシーバーを入力してください。
-n com.your.appid/com.adjust.sdk.AdjustReferrerReceiverパラメーターを削除することもできます。削除すると、デバイスに入っているすべてのアプリがINSTALL_REFERRERインテントを受信します。
ログレベルをverboseに設定していれば、リファラが読み込まれると以下のログが表示されるはずです。
V/Adjust: Referrer to parse (adjust_reftag=abc1234&tracking_id=123456789&utm_source=network&utm_medium=banner&utm_campaign=campaign) from reftag
SDKのパッケージハンドラーに追加されるクリックパッケージは以下のような形です。
V/Adjust: Path: /sdk_click
ClientSdk: android4.6.0
Parameters:
app_token abc123abc123
click_time yyyy-MM-dd'T'HH:mm:ss.SSS'Z'Z
created_at yyyy-MM-dd'T'HH:mm:ss.SSS'Z'Z
environment sandbox
gps_adid 12345678-0abc-de12-3456-7890abcdef12
needs_attribution_data 1
referrer adjust_reftag=abc1234&tracking_id=123456789&utm_source=network&utm_medium=banner&utm_campaign=campaign
reftag abc1234
source reftag
tracking_enabled 1
アプリの起動前にこのテストを行う場合、パッケージの送信は表示されません。パッケージはアプリの起動後に送信されます。
重要: この機能をテストをするためにadbツールを利用することは推奨していません。すべてのリファラーコンテンツをadbでテストするためには（&で分けられた複数のパラメータがある場合）、ブロードキャストレシーバーで受信するためにコンテンツをエンコードすることが必要です。もしエンコードをしないと、adbはリファラーを最初の&サインで切り、誤ったコンテンツをブロードキャストレシーバーに伝えます。
アプリがどのようにエンコードされていないリファラーを受信しているかを確認したい場合は、Adjustのサンプルアプリを利用して、MainActivity.javaファイルのonFireIntentClickメソッドのインテント内に送信されたコンテンツを変更してください：file:
public void onFireIntentClick(View v) {
Intent intent = new Intent("com.android.vending.INSTALL_REFERRER");
intent.setPackage("com.adjust.examples");
intent.putExtra("referrer", "utm_source=test&utm_medium=test&utm_term=test&utm_content=test&utm_campaign=test");
sendBroadcast(intent);
}自分の選んだコンテンツでputExtra2番目のパラメーターを自由に変更してください。
このタイミングでイベントを始動しても、期待どおりの動作をしない可能生があります。理由はこちらです。
直感的には分かりにくいですが、グローバルApplicationクラスのonCreateメソッドはアプリ起動時だけでなく、アプリによってシステムやイベントが作動する時にも呼ばれます。
Adjust SDKはこの場合の初期化についてサポートしています。この機能はアプリが実際に起動した時でなく、アクティビティがスタートした時、たとえばユーザーがアプリを起動させた時に起こります。
これらのコールはアプリがユーザーの操作以外の要因で起動した場合にも、Adjust SDKを起動しイベントを送信します。これはアプリの外部要因にもよります。
このように、アプリ起動時のイベントの作動はインストールとセッションの数を正確にトラッキングできません。
インストール後にイベントを作動させたい場合は、アトリビューション変更時用のリスナーをご利用ください。
アプリ起動時にイベントを作動させたい場合は、スタートするアクティビティのonCreateメソッドをご使用ください。
Adjust SDKはMITライセンスを適用しています。
Copyright (c) 2012-2021 Adjust GmbH, http://www.adjust.com
以下に定める条件に従い、本ソフトウェアおよび関連文書のファイル（以下「ソフトウェア」）の複製を取得するすべての人に対し、 ソフトウェアを無制限に扱うことを無償で許可します。これには、ソフトウェアの複製を使用、複写、変更、結合、掲載、頒布、サブライセンス、 および/または販売する権利、およびソフトウェアを提供する相手に同じことを許可する権利も無制限に含まれます。
上記の著作権表示および本許諾表示を、ソフトウェアのすべての複製または重要な部分に記載するものとします。
ソフトウェアは「現状のまま」で、明示であるか暗黙であるかを問わず、何らの保証もなく提供されます。 ここでいう保証とは、商品性、特定の目的への適合性、および権利非侵害についての保証も含みますが、それに限定されるものではありません。 作者または著作権者は、契約行為、不法行為、またはそれ以外であろうと、ソフトウェアに起因または関連し、 あるいはソフトウェアの使用またはその他の扱いによって生じる一切の請求、損害、その他の義務について何らの責任も負わないものとします。