6 月 3 日の「#Android11: The Beta Launch Show」にぜひご参加ください。

Play Install Referrer API

このドキュメントでは、Play Install Referrer API の使用に関するテクニカル情報を紹介します。Play Install Referrer API は AIDL サービス インターフェースで、主に Java 以外のプログラマーによって使用されます。

注: Play Install Referrer Library は Play Install Referrer API のラッパーを提供し、Java プログラマーはこのライブラリを通じて Play Install Referrer API を使用することができます。

getInstallReferrer() メソッド

このメソッドは、Bundle(表 1 にマッピングされているキー)で送信される特定のパッケージ名に対応する、アプリのインストール リファラー情報を返します。Google Play から送信される応答の Bundle では、キー(表 2 を参照)にマッピングされているフィールドにリファラー情報が格納されます。

表 1. getInstallReferrer() によるバンドルデータのリクエスト

パラメータ 説明
package_name String 呼び出し元のパッケージ名。曖昧さ回避に使用されます。

表 2. getInstallReferrer() のリクエストに対する応答データ

キー 説明
install_referrer String インストール済みパッケージのリファラー URL。
referrer_click_timestamp_seconds long リファラー クリックが行われたときのタイムスタンプ(秒単位)。
install_begin_timestamp_seconds long インストールが開始されたときのタイムスタンプ(秒単位)。
google_play_instant boolean 過去 7 日間の間にアプリの Instant エクスペリエンスが起動されたかどうかを示します。

注意: インストール リファラー情報の使用可能期間は 90 日です。この情報は、アプリが再インストールされない限り変更されません。アプリで不要な API 呼び出しが行われないようにするには、インストール後の最初の実行時に API を 1 回だけ呼び出します。