Play Install Referrer APIを使ってキャンペーンを計測する方法

2020年6月10日 | 広報・PR・イベント運営担当

2020年3月1日に INSTALL_REFERRER ブロードキャストが廃止され、これまで Google Play から取得できたキャンペーン情報がインテントから取得できなくなりました。

Android Developers Blog Still Using InstallBroadcast? Switch to the Play Referrer API by March 1, 2020
https://android-developers.googleblog.com/2019/11/still-using-installbroadcast-switch-to.html

これに伴なって、新しいキャンペーン情報の取得方法として、Google Play ストアの Install Referrer API を利用するように案内が出ています。今回は Firebase 利用者向けの、Install Referrer API を利用するためのアプリ側の実装方法についてまとめます。

Android Developers Play Install Referrer Library
https://developer.android.com/google/play/installreferrer/library

 

Install Referrer API実装手順

【1】INSTALL_REFERRER のブロードキャストレシーバーを実装済みの場合、Android Manifest から「INSTALL_REFERRER」の記載を削除します。

【2】アプリの build.gradle ファイルの dependencies セクションに下記の記述を追加します。

implementation ‘com.android.installreferrer:installreferrer:1.1.1’

【3】Application クラスのフィールドに下記を追加します。

private InstallReferrerClient referrerClient;

【4】Application クラスの onCreate() から下記のメソッドを呼びます。

※初回起動時のみ一度だけ実行する制御を行う必要があります。
 

private void setReferrer() {

referrerClient = InstallReferrerClient.newBuilder(this).build();
referrerClient.startConnection(new InstallReferrerStateListener() {
@Override
public void onInstallReferrerSetupFinished(int responseCode) {
switch (responseCode) {
case InstallReferrerClient.InstallReferrerResponse.OK:

// Connection established
try {
ReferrerDetails response = referrerClient.getInstallReferrer();
String referrer = response.getInstallReferrer();
Log.d(TAG, “referrer:”+ referrer);

// その他イベント送信など処理があれば記載

} catch (Exception e) {
e.printStackTrace();
}

referrerClient.endConnection();

break;
case InstallReferrerClient.InstallReferrerResponse.FEATURE_NOT_SUPPORTED:
// API not available on the current Play Store app
referrerClient.endConnection();
Log.d(TAG, “InstallReferrerResponse.FEATURE_NOT_SUPPORTED”);
break;
case InstallReferrerClient.InstallReferrerResponse.SERVICE_UNAVAILABLE:
// Connection could not be established
referrerClient.endConnection();
Log.d(TAG, “InstallReferrerResponse.SERVICE_UNAVAILABLE”);
break;
}
}

@Override
public void onInstallReferrerServiceDisconnected() {
// Try to restart the connection on the next request to
// Google Play by calling the startConnection() method.
Log.d(TAG, “onInstallReferrerServiceDisconnected”);
}
});
}

例えば下記のようなキャンペーンURLでアプリをインストールした場合、response.getInstallReferrer() で取得した文字列 referrer は下記のような値になります。

例)
キャンペーンURL
https://play.google.com/store/apps/details?id=com.test.sampleapp&referrer=utm_source%3Dgoogle%26utm_medium%3Dcpc%26utm_campaign%3Dpromo referrer:utm_source=google&utm_medium=cpc&utm_campaign=promo

referrer 情報が取得できたら、この文字列を使ってカスタムイベントを送信するなどの処理を行ってください。
referrer API とのコネクションが確立した際に、自動イベントの firebase_campaign が発生するので、カスタムイベントを送信しなくても流入元の計測は可能です。
90日間はインストール時の情報が API 側に保持され、何度も API を呼び出してしまうと何度も流入計測が行われてしまいますので、初回起動時の一度のみ実行する制御を忘れずに行ってください。

 

今回は Firebase 利用者向けの Install Referrer API への移行方法についてご紹介しました。従来のGoogle Analytics SDK での利用については下記のヘルプを参照してください。

キャンペーンの測定  |  Android 向けアナリティクス  |  Google Developers
https://developers.google.com/analytics/devguides/collection/android/v4/campaigns

 

いかがでしたか?

イー・エージェンシーでは、アプリ分析に必須の Google アナリティクス for Firebase の導入・運用を支援しております。
さらに、アプリとWebのクロスプラットフォーム分析ができる Google アナリティクス 4 プロパティ(GA4)の導入・運用も支援しております。
詳しくは下記サイトをご覧ください。

Google アナリティクス 4 プロパティ(GA4)など
Google マーケティング プラットフォーム|イー・エージェンシー
https://googleanalytics360-suite.e-agency.co.jp/

PICK UP

広報・PR・イベント運営担当

ライター

おもてなしを科学するイー・エージェンシーでは、クロスデバイス分析によるユーザー単位の分析やオンラインオフラインを横断した分析など次世代の分析をサポート。また分析データを元にしたABテスト支援から、EC領域での購買、行動データを活用したレコメンドシステムなどを提供。 お問い合わせはこちらにどうぞ。

お問い合わせ

サービスに関するご相談は
こちらよりお気軽にお問い合わせください。

e-Agencyの様々な情報をFacebookでお届けします!