Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MIR referrer details for each SDK #497

Merged
merged 4 commits into from
Mar 25, 2024
Merged

Add MIR referrer details for each SDK #497

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
135d52e
Add MIR referrer details for each SDK
Sporiff Feb 27, 2024
61211e2
Address feedback
Sporiff Feb 28, 2024
a545f2b
Merge branch 'main' into mir-referrer-update
Sporiff Mar 25, 2024
fed73c8
Merge branch 'main' into mir-referrer-update
Sporiff Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 40 additions & 3 deletions src/content/docs/sdk/android/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Callout type="note">

The Adjust SDK bundles the `<queries>` 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`.

</Callout>

<MinorVersion added="v4.36.0">

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:

</MinorVersion>

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.

<Tabs>
<Tab title="Kotlin" sync="kotlin">

```kotlin {2}
val config = AdjustConfig(this, appToken, environment)
config.setFbAppId(<FB_APP_ID_STRING>)
Adjust.onCreate(config)
```

</Tab>
<Tab title="Java" sync="java">

```java {2}
AdjustConfig config = new AdjustConfig(this, appToken, environment);
config.setFbAppId(<FB_APP_ID_STRING>);
Adjust.onCreate(config);
```

</Tab>
</Tabs>

## 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:

Expand Down
33 changes: 27 additions & 6 deletions src/content/docs/sdk/flutter/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,7 @@ The install referrer is a unique identifier which you can use to attribute an ap

</Callout>

<Tabs>
<Tab title="Google Play Referrer API">
#### Google Play Referrer API

To support the Google Play Referrer API, add the following in your `build.gradle` file:

Expand All @@ -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.** { *; }
```

</Tab>
<Tab title="Huawei Referrer API">
#### Huawei Referrer API

<MinorVersion added="v4.22.0">

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.

</Tab>
</Tabs>
</MinorVersion>

#### Meta referrer integration

<Callout type="note">

The Adjust SDK bundles the `<queries>` 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`.

</Callout>

<MinorVersion added="v4.36.0">

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:

</MinorVersion>

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 = "<FB_APP_ID_STRING>";
```

## 3. Add iOS frameworks

Expand Down
43 changes: 32 additions & 11 deletions src/content/docs/sdk/react-native/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,17 +159,14 @@ Although install referrer isn't required, it's highly recommended to improve att

</Callout>

<Tabs>
<Tab title="Google Play Referrer API">

<Callout type="note">
#### Google Play Referrer API

This feature is supported in Adjust SDK v4.12.0 and later.

</Callout>
<MinorVersion added="v4.12.0">

To support the [Google Play Referrer API](https://developer.android.com/google/play/installreferrer):

</MinorVersion>

1. Add the following line in the **dependencies block** of your top-level `build.gradle` file:

```groovy title="build.gradle"
Expand Down Expand Up @@ -199,13 +196,37 @@ allprojects {
-keep public class com.android.installreferrer.** { *; }
```

</Tab>
<Tab title="Huawei Referrer API">
#### 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.

</Tab>
</Tabs>
#### Meta referrer integration

<Callout type="note">

The Adjust SDK bundles the `<queries>` 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`.

</Callout>

<MinorVersion added="v4.37.0">

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:

</MinorVersion>

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("<FB_APP_ID_STRING>");
//...
Adjust.create(adjustConfig);
```

## 5. Add iOS frameworks

Expand Down
71 changes: 44 additions & 27 deletions src/content/docs/sdk/unity/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Tabs>
<Tab title="Google Play Referrer API">
#### Google Play Referrer API

There are 2 ways to add support for the Google Play Referrer API:

Expand All @@ -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.

</Tab>
<Tab title="Huawei Referrer API">
#### 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.

</Tab>
</Tabs>
#### Meta referrer integration

<MinorVersion added="v4.36.0">

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:

</MinorVersion>

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"
<queries>
<package android:name="com.facebook.katana" />
</queries>

<queries>
<package android:name="com.instagram.android" />
</queries>
```

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

Expand Down Expand Up @@ -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** <Badge color="warning">Deprecated</Badge>: 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

Expand All @@ -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.

</Tab>
<Tab title="Android" icon="PlatformAndroid">
Expand All @@ -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** <Badge color="warning">Deprecated</Badge>: 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

Expand Down
Loading