This document provides a technical reference for using the Play Install Referrer API. The Play Install Referrer API is an Android Interface Definition Language (AIDL) service interface for developers who aren't using Kotlin or the Java programming language.
Get the install referrer
The getInstallReferrer() method returns the app install referrer information
corresponding to the given package name sent through a Bundle (key mapped in
table 1). In the response Bundle sent by Google Play, the referral
information is stored in fields mapped to the keys detailed in table 2.
Table 1. getInstallReferrer() bundle data
request.
| Parameter | Type | Description |
|---|---|---|
package_name
|
String
|
The package name of the caller, used for disambiguation. |
Table 2. Response data from a getInstallReferrer()
request.
| Key | Type | Description |
|---|---|---|
install_referrer
|
String
|
The referrer URL of the installed package. |
referrer_click_timestamp_seconds
|
long
|
The client-side timestamp, in seconds, when the referrer click happened. |
install_begin_timestamp_seconds
|
long
|
The client-side timestamp, in seconds, when app installation began. |
referrer_click_timestamp_server_seconds
|
long
|
The server-side timestamp, in seconds, when the referrer click happened. |
install_begin_timestamp_server_seconds
|
long
|
The server-side timestamp, in seconds, when app installation began. |
install_version
|
string
|
The app's version at the time when the app was first installed. |
google_play_instant
|
boolean
|
Indicates whether your app's instant experience was launched within the past 7 days. |