From 135d52e378b9e717bc4e906edcc31b531ecc6815 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 27 Feb 2024 12:43:54 +0100 Subject: [PATCH 1/2] Add MIR referrer details for each SDK --- src/content/docs/sdk/android/index.mdx | 43 ++++++++++++- src/content/docs/sdk/flutter/index.mdx | 33 ++++++++-- src/content/docs/sdk/react-native/index.mdx | 43 +++++++++---- src/content/docs/sdk/unity/index.mdx | 71 +++++++++++++-------- 4 files changed, 143 insertions(+), 47 deletions(-) diff --git a/src/content/docs/sdk/android/index.mdx b/src/content/docs/sdk/android/index.mdx index 6ee1cd351..fe9ee6aa4 100644 --- a/src/content/docs/sdk/android/index.mdx +++ b/src/content/docs/sdk/android/index.mdx @@ -143,13 +143,50 @@ The Xiaomi referrer plugin enables you to record install referrer values for app The Samsung referrer plugin enables you to record install referrer values for apps that target the Samsung Galaxy store. See the plugin documentation for install information. +### Meta referrer integration + + + +The Adjust SDK bundles the `` elements [required by Meta](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps). You don't need to add these to your `AndroidManifest.xml`. + + + + + +The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer) in v4.36.0 and above. To enable this feature: + + + +1. Find your Meta app ID in your [App Dashboard](https://developers.facebook.com/apps). See Meta's [App Dashboard documentation](https://developers.facebook.com/docs/development/create-an-app/app-dashboard) for more information. +2. Pass your App ID as a __string__ argument to the `AdjustConfig.setFbAppId` method. + + + + +```kotlin {2} +val config = AdjustConfig(this, appToken, environment) +config.setFbAppId(); +Adjust.onCreate(config) +``` + + + + +```java {2} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setFbAppId() +Adjust.onCreate(config); +``` + + + + ## 6. Integrate the Adjust SDK The following information is required to initialize the Adjust SDK: -`appToken`: Your [Adjust app token](https://help.adjust.com/en/article/app-settings#view-your-app-token). - -`environment`: The environment your app is running in. Set this to `AdjustConfig.ENVIRONMENT_SANDBOX` to test your app locally. +- `appToken`: Your [Adjust app token](https://help.adjust.com/en/article/app-settings#view-your-app-token). +- `environment`: The environment your app is running in. Set this to `AdjustConfig.ENVIRONMENT_SANDBOX` to test your app locally. The recommended way to initialize the Adjust SDK is inside a global Android [Application class](http://developer.android.com/reference/android/app/Application.html). If you haven't already set this up for your app, follow these steps: diff --git a/src/content/docs/sdk/flutter/index.mdx b/src/content/docs/sdk/flutter/index.mdx index 56260ffbc..197be15d7 100644 --- a/src/content/docs/sdk/flutter/index.mdx +++ b/src/content/docs/sdk/flutter/index.mdx @@ -108,8 +108,7 @@ The install referrer is a unique identifier which you can use to attribute an ap - - +#### Google Play Referrer API To support the Google Play Referrer API, add the following in your `build.gradle` file: @@ -123,13 +122,35 @@ If you are using Proguard, make sure you have added the following setting in you -keep public class com.android.installreferrer.** { *; } ``` - - +#### Huawei Referrer API + + As of v4.22.0, the Adjust SDK supports install tracking on Huawei devices using Huawei App Gallery v10.4 and later. You don't need to make any changes to start using the Huawei Referrer API. - - + + +#### Meta referrer integration + + + +The Adjust SDK bundles the `` elements [required by Meta](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps). You don't need to add these to your `AndroidManifest.xml`. + + + + + +The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer) in v4.36.0 and above. To enable this feature: + + + +1. Find your Meta app ID in your [App Dashboard](https://developers.facebook.com/apps). See Meta's [App Dashboard documentation](https://developers.facebook.com/docs/development/create-an-app/app-dashboard) for more information. +2. Assign your App ID to the `fbAppId` property on your `AdjustConfig` instance. + + ```dart {2} + AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); + config.fbAppId = "" + ``` ## 3. Add iOS frameworks diff --git a/src/content/docs/sdk/react-native/index.mdx b/src/content/docs/sdk/react-native/index.mdx index c46b42794..952fece8f 100644 --- a/src/content/docs/sdk/react-native/index.mdx +++ b/src/content/docs/sdk/react-native/index.mdx @@ -159,17 +159,14 @@ Although install referrer isn't required, it's highly recommended to improve att - - - - +#### Google Play Referrer API -This feature is supported in Adjust SDK v4.12.0 and later. - - + To support the [Google Play Referrer API](https://developer.android.com/google/play/installreferrer): + + 1. Add the following line in the **dependencies block** of your top-level `build.gradle` file: ```groovy title="build.gradle" @@ -199,13 +196,37 @@ allprojects { -keep public class com.android.installreferrer.** { *; } ``` - - +#### Huawei Referrer API As of v4.22.0, the Adjust SDK supports install tracking on Huawei devices using Huawei App Gallery v10.4 and later. You don't need to make any changes to start using the Huawei Referrer API. - - +#### Meta referrer integration + + + +The Adjust SDK bundles the `` elements [required by Meta](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps). You don't need to add these to your `AndroidManifest.xml`. + + + + + +The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer) in v4.37.0 and above. To enable this feature: + + + +1. Find your Meta app ID in your [App Dashboard](https://developers.facebook.com/apps). See Meta's [App Dashboard documentation](https://developers.facebook.com/docs/development/create-an-app/app-dashboard) for more information. +2. Pass your App ID as a __string__ argument to the `AdjustConfig.setFbAppId` method. + + ```jsx {6} + const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox + ); + //... + adjustConfig.setFbAppId(""); + //... + Adjust.create(adjustConfig); + ``` ## 5. Add iOS frameworks diff --git a/src/content/docs/sdk/unity/index.mdx b/src/content/docs/sdk/unity/index.mdx index 46709efb7..76152902a 100644 --- a/src/content/docs/sdk/unity/index.mdx +++ b/src/content/docs/sdk/unity/index.mdx @@ -124,8 +124,7 @@ The install referrer is a unique identifier which you can use to attribute an ap - Use the [Google Play Referrer API](https://developer.android.com/google/play/installreferrer). - Use the Huawei Referrer API. - - +#### Google Play Referrer API There are 2 ways to add support for the Google Play Referrer API: @@ -139,13 +138,40 @@ dependencies { 2. Download the install referrer library from [Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer) and put the ARR (Android Archive) file in your `Plugins/Android` folder. - - +#### Huawei Referrer API As of v4.21.1, the Adjust SDK supports install tracking on Huawei devices using Huawei App Gallery v10.4 and later. You don't need to make any changes to start using the Huawei Referrer API. - - +#### Meta referrer integration + + + +The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer) in v4.36.0 and above. To enable this feature: + + + +1. Find your Meta app ID in your [App Dashboard](https://developers.facebook.com/apps). See Meta's [App Dashboard documentation](https://developers.facebook.com/docs/development/create-an-app/app-dashboard) for more information. +2. [Add the Meta apps to your `AndroidManifest.xml` file](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps). + + ```xml title="AndroidManifest.xml" + + + + + + + + ``` + +3. Pass your App ID as a __string__ argument to the `AdjustConfig.setFbAppId` method. + + ```cs {3} + AdjustConfig config = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); + //... + config.setFbAppId("{FB_APP_ID_STRING}"); + //... + Adjust.start(config); + ``` ## 4. Build your app @@ -173,15 +199,11 @@ The iOS post-build process makes the following changes to your generated Xcode p You can enable the following frameworks to access iOS features: -**AdServices.framework**: Required for Apple Search Ads tracking - -**AdSupport.framework**: Required to read the device IDFA - -**AppTrackingTransparency.framework**: Required to ask for user's consent to be tracked and obtain consent status - -**StoreKit.framework**: Required to communicate with the SKAdNetwork framework. - -**iAd.framework** Deprecated: Use `AdServices.framework` +- `AdServices.framework`: Required for Apple Search Ads tracking +- `AdSupport.framework`: Required to read the device IDFA +- `AppTrackingTransparency.framework`: Required to ask for user's consent to be tracked and obtain consent status +- `StoreKit.framework`: Required to communicate with the SKAdNetwork framework. +- `iAd.framework` __Deprecated__: Use `AdServices.framework` #### App Tracking Transparency consent dialog @@ -191,11 +213,9 @@ If you are using the ATT (App Tracking Transparency) wrapper, enter a **User Tra To enable deep linking, add the following information: -**iOS Universal Links Domain**: The associated domain used for universal links. - -**iOS URL Identifier**: Your app's bundle ID. - -**iOS URL Schemes**: The URL scheme associated with your app. +- `iOS Universal Links Domain`: The associated domain used for universal links. +- `iOS URL Identifier`: Your app's bundle ID. +- `iOS URL Schemes`: The URL scheme associated with your app. @@ -206,13 +226,10 @@ The Android post-build process checks for an `AndroidManifest.xml` file in `Asse You can enable the following permissions to access Android features: -**android.permission.INTERNET**: Required to connect to the internet. - -**android.permission.ACCESS_NETWORK_STATE**: Required to read the type of network the device is connected to. - -**com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE** Deprecated: Required to fetch install referrer information via Google Play Store intent. - -**com.google.android.gms.permission.AD_ID**: Required to read the device advertising ID on Android 12 (API level 31) and above. See [Google's `AdvertisingIdClient.info` documentation](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid) for more information. +- `android.permission.INTERNET`: Required to connect to the internet. +- `android.permission.ACCESS_NETWORK_STATE`: Required to read the type of network the device is connected to. +- `com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE` __Deprecated__: Required to fetch install referrer information via Google Play Store intent. +- `com.google.android.gms.permission.AD_ID`: Required to read the device advertising ID on Android 12 (API level 31) and above. See [Google's `AdvertisingIdClient.info` documentation](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid) for more information. #### Deep linking From 61211e24baee0d30f702ee7c711f5ea32b457456 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Wed, 28 Feb 2024 13:20:44 +0100 Subject: [PATCH 2/2] Address feedback --- src/content/docs/sdk/android/index.mdx | 4 ++-- src/content/docs/sdk/flutter/index.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/content/docs/sdk/android/index.mdx b/src/content/docs/sdk/android/index.mdx index fe9ee6aa4..ce8eafbc0 100644 --- a/src/content/docs/sdk/android/index.mdx +++ b/src/content/docs/sdk/android/index.mdx @@ -165,7 +165,7 @@ The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook. ```kotlin {2} val config = AdjustConfig(this, appToken, environment) -config.setFbAppId(); +config.setFbAppId() Adjust.onCreate(config) ``` @@ -174,7 +174,7 @@ Adjust.onCreate(config) ```java {2} AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setFbAppId() +config.setFbAppId(); Adjust.onCreate(config); ``` diff --git a/src/content/docs/sdk/flutter/index.mdx b/src/content/docs/sdk/flutter/index.mdx index 197be15d7..18328676d 100644 --- a/src/content/docs/sdk/flutter/index.mdx +++ b/src/content/docs/sdk/flutter/index.mdx @@ -149,7 +149,7 @@ The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook. ```dart {2} AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); - config.fbAppId = "" + config.fbAppId = ""; ``` ## 3. Add iOS frameworks