Install Referrerモジュール
要件
- Tealium for Android(5.0.0以降)(4.x向けソリューション)
インストール
Install ReferrerモジュールをMavenによって、または手動でインストールします。
Maven
Install ReferrerモジュールをMavenによってインストールするには:
プロジェクトの最上位の
build.gradle
ファイルに、次のMavenレポジトリを追加します。maven { url "https://maven.tealiumiq.com/android/releases/" }
プロジェクトモジュールの
build.gradle
ファイルに、以下のようにMavenの依存関係を追加します。dependencies{ // only required if you do not have this reference implementation 'com.tealium:library:5.8.0' implementation 'com.tealium:installreferrer:1.1.3' // only required if you do not already have this reference and require lifecycle tracking implementation 'com.tealium:lifecycle:1.1.4' // Google's Install Referrer API implementation 'com.android.installreferrer:installreferrer:1.0' }
Google Install Referrer APIはこのモジュールの依存関係の1つですが、自動的には追加されません。ビルドにこのモジュールを追加してください。
(Tealiumをインスタンス化した後で)Tealiumライブラリをインスタンス化する同じブロックで、以下を追加します。
// import the Tealium InstallReferrer module in the import section import com.tealium.installreferrer.InstallReferrerReceiver; // substitute the example instance name here with the same instance name you used when initializing the Tealium library private static final String TEALIUM_INSTANCENAME = "INSTANCE_NAME"; // call this to store the referrer as Persistent data - recommended InstallReferrerReceiver.setReferrerPersistent(applicationContext, TEALIUM_INSTANCENAME); // call this to store the referrer as Volatile data (reset at app restart/terminate) - not recommended in most cases InstallReferrerReceiver.setReferrerVolatile(applicationContext, TEALIUM_INSTANCENAME);
手動
Install Referrerモジュールを手動でインストールするには:
Tealium Install Referrerモジュールをダウンロードします。
最上位の
build.gradle
ファイルで、以下を検証します。allprojects { repositories { jcenter() flatDir { dirs 'libs' } } }
ファイル
tealium.installreferrer-1.1.2.aar
をプロジェクトの<PROJECT_ROOT>/<MODULE>/libs
ディレクトリにコピーします。Tealiumライブラリの依存関係をプロジェクトモジュールの
build.gradle
ファイルに追加します。dependencies { // only required if you do not already have this reference implementation(name:'tealium-5.6.1', ext:'aar') implementation(name:'tealium.installreferrer-1.1.2', ext:'aar') // only required if you do not already have this reference and require lifecycle tracking implementation(name:'tealium.lifecycle-1.1.2', ext:'aar') // Google's Install Referrer API implementation 'com.android.installreferrer:installreferrer:1.0' }
値の例
受信URLがすべての指定されたキャンペーン情報を含んでいたと仮定すると、INSTALL_REFERRER
変数には以下のURL形式データが受信されると予想できます。
utm_medium=test_medium&
utm_term=test_term&
utm_content=test_content&
utm_campaign=test_name
追加の検討事項
保存されたリファラーの削除
保存されたインストールリファラー文字列を削除するには、Tealiumライブラリに用意されている標準メソッドを呼び出して、永続的または揮発性ストレージから変数を削除します。変数のキー名は、InstallReferrerReceiver
クラスによって公開されます。次の例では、保存されたインストールリファラーが永続性データと揮発性データの両方から削除されます。変数が存在しない場合、このコードは何も行わず、エラーも発生しません。
// remove from persistent data store
instance.getDataSources().getPersistentDataSources().edit().remove(InstallReferrerReceiver.KEYNAME).apply();
// remove from volatile data store (session only)
instance.getDataSources().getVolatileDataSources().remove(InstallReferrerReceiver.KEYNAME);
Tealium SDK 4.xでの対応策
Install ReferrerモジュールはTealium SDK 5.xとのみ互換性があります。
SDK 4.xでこの機能を実現するには、以下のコードを使用します。
// Android Manifest
<receiver
android:name="com.tealium.InstallReferrerReceiver"
android:exported="true">
<intent-filter>
<action android:name="com.android.vending.INSTALL_REFERRER" />
</intent-filter>
</receiver>
// Class for retrieving install referrer
public class InstallReferrerReceiver extends BroadcastReceiver {
private static final String INSTALL_REFERRER = "INSTALL_REFERRER";
public void onReceive(Context context, Intent intent) {
if (intent != null) {
return;
}
Bundle extras = intent.getExtras();
if (extras == null) {
return;
}
String referrer = extras.getString("referrer");
if (StringUtils.isNotBlank(referrer)) {
Tealium.getGlobalCustomData().edit().putString(INSTALL_REFERRER, referrer).apply();
}
}
}
APIリファレンス
Install Referrerモジュールのメソッドの完全なリファレンスについては、Tealium SDK for Android APIのInstallReferrerReceiver
クラスを参照してください。
このページはお役にたちましたでしょうか?
最終更新日 :: 2022年August月29日