Play Install Referrer API
Stay organized with collections
Save and categorize content based on your preferences.
This documentation provides technical reference for using the
Play Install Referrer API. The Play Install Referrer API is an
AIDL Service Interface
primarily used by non-Java programmers.
Note: The
Play Install Referrer Library
provides a wrapper around the Play Install Referrer API and is designed to help Java
programmers use the API.
The getInstallReferrer() method
This 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.
|
Caution: The install referrer information will be
available for 90 days and won't change unless the application is
reinstalled. To avoid unnecessary API calls in your app, you should invoke the
API only once during the first execution after install.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-07-21 UTC.
[null,null,["Last updated 2025-07-21 UTC."],[],[],null,["# Play Install Referrer API\n\nThis documentation provides technical reference for using the\nPlay Install Referrer API. The Play Install Referrer API is an\n[AIDL Service Interface](https://developer.android.com/guide/components/aidl.html)\nprimarily used by non-Java programmers.\n\n\n**Note:** The\n[Play Install Referrer Library](/google/play/installreferrer/library)\nprovides a wrapper around the Play Install Referrer API and is designed to help Java\nprogrammers use the API.\n\nThe getInstallReferrer() method\n-------------------------------\n\nThis method returns the app install referrer information corresponding to the\ngiven package name sent through a `Bundle` (key mapped in table 1). In the\nresponse `Bundle` sent by Google Play, the referral information is stored in\nfields mapped to the keys detailed in table 2.\n\n\n**Table 1.** `getInstallReferrer()` bundle data\nrequest.\n\n| Parameter | Type | Description |\n|----------------|----------|----------------------------------------------------------|\n| `package_name` | `String` | The package name of the caller, used for disambiguation. |\n\n\n**Table 2.** Response data from a `getInstallReferrer()`\nrequest.\n\n| Key | Type | Description |\n|-------------------------------------------|-----------|--------------------------------------------------------------------------------------|\n| `install_referrer` | `String` | The referrer URL of the installed package. |\n| `referrer_click_timestamp_seconds` | `long` | The client-side timestamp, in seconds, when the referrer click happened. |\n| `install_begin_timestamp_seconds` | `long` | The client-side timestamp, in seconds, when app installation began. |\n| `referrer_click_timestamp_server_seconds` | `long` | The server-side timestamp, in seconds, when the referrer click happened. |\n| `install_begin_timestamp_server_seconds` | `long` | The server-side timestamp, in seconds, when app installation began. |\n| `install_version` | `string` | The app's version at the time when the app was first installed. |\n| `google_play_instant` | `boolean` | Indicates whether your app's instant experience was launched within the past 7 days. |\n\n**Caution:** The install referrer information will be\navailable for 90 days and **won't change** unless the application is\nreinstalled. To avoid unnecessary API calls in your app, you should invoke the\nAPI **only once** during the first execution after install."]]
