Skip to content

Commit 5941079

Browse files
authored
Update README.md
1 parent f89a310 commit 5941079

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ our [Android web views SDK guide](doc/english/web_views.md).
1313
* [Add Google Play Services](#sdk-gps)
1414
* [Add permissions](#sdk-permissions)
1515
* [Proguard settings](#sdk-proguard)
16-
* [Adjust broadcast receiver](#sdk-broadcast-receiver)
16+
* [Install referrer](#install-referrer)
17+
* [Google Play Referrer API](#gpr-api)
18+
* [Google Play Store intent](#gps-intent)
1719
* [Integrate the SDK into your app](#sdk-integrate)
1820
* [Basic setup](#basic-setup)
1921
* [Session tracking](#session-tracking)
@@ -160,9 +162,25 @@ If you are using Proguard, add these lines to your Proguard file:
160162

161163
If you are **not targeting the Google Play Store**, you can remove the `com.google.android.gms` rules.
162164

163-
### <a id="sdk-broadcast-receiver"></a>Adjust broadcast receiver
165+
### <a id="install-referrer"></a>Install referrer
164166

165-
If you are **not using your own broadcast receiver** to receive `INSTALL_REFERRER` intent, add the following `receiver` tag inside the `application` tag in your `AndroidManifest.xml`.
167+
In order to properly attribute install of your app with it's source, we need to get information about **install referrer**. This can be obtained with usage of **Google Play Referrer API** or with catching **Google Play Store intent** with broadcast receiver.
168+
169+
**Important**: Google Play Referrer API is newly introduced by Google in order to provide more reliable and secure way of obtaining install referrer information and also to aid attribution providers to fight click injection in more efficient way. It is **strongly recommended** that you have this supported in your application. Google Play Store intent is less secure way of obtaining install referrer information which will exist in parallel with new Google Play Referrer API for a while, but is intended to be deprecated at some point in future.
170+
171+
#### <a id="gpr-api"></a>Google Play Referrer API
172+
173+
In order to have this supported in your app, please make sure that you have followed [Add the SDK to your project](#sdk-add) chapter properly and that you have following line added to your `build.gradle` file:
174+
175+
```
176+
compile 'com.android.installreferrer:installreferrer:1.0'
177+
```
178+
179+
In addition to that, this feature is supported if you use **Adjust SDK v4.12.0 or above**.
180+
181+
#### <a id="gps-intent"></a>Google Play Store intent
182+
183+
Google Play Store `INSTALL_REFERRER` intent should be captured with broadcast receiver. If you are **not using your own broadcast receiver** to receive `INSTALL_REFERRER` intent, add the following `receiver` tag inside the `application` tag in your `AndroidManifest.xml`.
166184

167185
```xml
168186
<receiver
@@ -176,16 +194,10 @@ If you are **not using your own broadcast receiver** to receive `INSTALL_REFERRE
176194

177195
![][receiver]
178196

179-
We use this broadcast receiver to retrieve the install referrer, in order to improve conversion tracking.
197+
We use this broadcast receiver to retrieve the install referrer and pass it to our backend.
180198

181199
If you are already using a different broadcast receiver for the `INSTALL_REFERRER` intent, follow [these instructions][referrer] to add the Adjust broadcast receiver.
182200

183-
**Note**: Receiving referrer information via `INSTALL_REFERRER` intent is part of old Google referrer mechanism which got replaced with [new Google referrer API][new-referrer-api]. It is strongly advised to add support for new API which significantly improves security of the referrer information being delivered into the app and also helps attribution providers to fight click injection in more efficient way. In order to have this supported in your app, please make sure that you have followed [Add the SDK to your project](#sdk-add) chapter properly and that you have following line added to your `build.gradle` file:
184-
185-
```
186-
compile 'com.android.installreferrer:installreferrer:1.0'
187-
```
188-
189201
### <a id="sdk-integrate"></a>Integrate the SDK into your app
190202

191203
To start with, we'll set up basic session tracking.

0 commit comments

Comments
 (0)