diff --git a/src/content/docs/ja/sdk/android/v5/index.mdoc b/src/content/docs/ja/sdk/android/v5/index.mdoc index e3b8eb19f..45e768df6 100644 --- a/src/content/docs/ja/sdk/android/v5/index.mdoc +++ b/src/content/docs/ja/sdk/android/v5/index.mdoc @@ -1,26 +1,27 @@ --- -title: Android SDK連携ガイド -description: Android SDKを使用して、AndroidアプリでAdjustの機能にアクセスしましょう。 -category-title: Android SDK -slug: ja/sdk/android +title: "Android SDK連携ガイド" +description: "Android SDKを使用して、AndroidアプリでAdjustの機能にアクセスしましょう。" +category-title: "Android SDK" +slug: "en/sdk/android" sidebar-position: 1 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ja/sdk/android/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/android/v4" --- - Adjust Android SDKを実装することで、アトリビューション、イベント、さらにその他のさまざまなデータをAndroidアプリで記録できます。Adjust SDKをアプリに実装するには、以下の手順に従ってください。 -{% callout type="important" %} -Adjust SDKは、Android APIレベル21(Lollipop)以降に対応しています。 -{% /callout %} +\{% callout type="important" %\} +Adjust SDKは、Android APIレベル21(Lollipop)以降に対応しています。\{% /callout %\} -## 1. 環境を設定する {% #set-up-your-environment %} +1\. 環境を設定する \{% \#set\-up\-your\-environment %\} +------------------------------------------------------- Adjust SDKを使い始めるには、SDKをdependencyとしてプロジェクトに追加してください。Adjust SDKは[Maven](https://maven.apache.org)で利用可能です。 @@ -37,7 +38,8 @@ Adjust SDKを使い始めるには、SDKをdependencyとしてプロジェクト } ``` -## 2. Google Play 開発者サービスを追加する {% #add-google-play-services %} +2\. Google Play 開発者サービスを追加する \{% \#add\-google\-play\-services %\} +------------------------------------------------------------------------- Google Playストアを対象とするアプリは、`gps_adid`(Google広告ID)を使用してデバイスを識別する必要があります。`gps_adid`にアクセスするには、`play-services-ads-identifier`AARをプロジェクトに追加する必要があります。 @@ -49,7 +51,8 @@ dependencies { } ``` -## 3. パーミッションを追加する {% #add-permissions %} +3\. パーミッションを追加する \{% \#add\-permissions %\} +------------------------------------------------ Adjust SDKがデバイス情報にアクセスできるようにするには、アプリが必要とするパーミッションを宣言する必要があります。これを行うには、`AndroidManifest.xml`ファイルにパーミッションを追加します。 @@ -72,7 +75,8 @@ Adjust SDKには、デフォルトで`com.google.android.gms.AD_ID`パーミッ ``` -## 4. Proguardを設定する {% #set-up-proguard %} +4\. Proguardを設定する \{% \#set\-up\-proguard %\} +--------------------------------------------------- Proguardを使ってアプリを最適化する場合は、Proguardがクラスを削除しないようにルールを追加する必要があります。 @@ -97,11 +101,12 @@ Google Play ストアでアプリを公開していない場合は、以下の -keep public class com.adjust.sdk.** { *; } ``` -## 5. インストールリファラーを設定する {% #set-up-install-referrer %} +5\. インストールリファラーを設定する \{% \#set\-up\-install\-referrer %\} +---------------------------------------------------------------- インストールリファラーは、インストールをソースにアトリビュートするために使用される一意の識別子です。Adjust SDKは、アトリビューションを実行するためにこの情報を必要とします。インストールのリファラー情報を取得するには、以下のいずれかの方法を使用します: -### Google Play Referrer API {% #google-play-referrer-api %} +### Google Play Referrer API \{% \#google\-play\-referrer\-api %\} Google Play Referrer APIは、Google Play ストアを対象とするアプリで使用できます。 @@ -119,7 +124,7 @@ Proguardを使用している場合は、依存関係が削除されないよう -keep public class com.android.installreferrer.** { *; } ``` -### Huawei Referrer API {% #huawei-referrer-api %} +### Huawei Referrer API \{% \#huawei\-referrer\-api %\} Huawei Referrer APIは、Huaweiデバイスを対象とするアプリで使用できます。Adjust SDKは、Adjust Huawei Referrerプラグインを使用して、Huaweiデバイスでのインストールを記録します。 @@ -131,36 +136,38 @@ dependencies { } ``` -### Xiaomiリファラープラグイン {% #xiaomi-referrer-plugin %} +### Xiaomiリファラープラグイン \{% \#xiaomi\-referrer\-plugin %\} -Xiaomiリファラープラグインを使用すると、Xiaomiデバイスを対象とするアプリのインストールリファラー値を記録できます。インストール情報については、[プラグインに関するドキュメント](/ja/sdk/android/plugins/xiaomi-referrer)を参照してください。 +Xiaomiリファラープラグインを使用すると、Xiaomiデバイスを対象とするアプリのインストールリファラー値を記録できます。インストール情報については、[プラグインに関するドキュメント](/en/sdk/android/plugins/xiaomi-referrer)を参照してください。 -### Samsungリファラープラグイン {% #samsung-referrer-plugin %} +### Samsungリファラープラグイン \{% \#samsung\-referrer\-plugin %\} -Samsungリファラープラグインを使用すると、Samsung Galaxyストアを対象とするアプリのインストールリファラー値を記録できます。インストール情報については、[プラグインに関するドキュメント](/ja/sdk/android/plugins/samsung-referrer-plugin)を参照してください。 +Samsungリファラープラグインを使用すると、Samsung Galaxyストアを対象とするアプリのインストールリファラー値を記録できます。インストール情報については、[プラグインに関するドキュメント](/en/sdk/android/plugins/samsung-referrer-plugin)を参照してください。 -### Metaとのリファラー連携 {% #meta-referrer-integration %} +### Metaとのリファラー連携 \{% \#meta\-referrer\-integration %\} -AdjustSDKはAdjustのMetaインストールリファラーを使用して[Metaインストールリファラー](https://developers.facebook.com/docs/app-ads/meta-install-referrer)をサポートしています。[連携の詳細については、ドキュメントをご覧ください](/ja/sdk/android/plugins/meta-referrer-plugin)。 +AdjustSDKはAdjustのMetaインストールリファラーを使用して[Metaインストールリファラー](https://developers.facebook.com/docs/app-ads/meta-install-referrer)をサポートしています。[連携の詳細については、ドキュメントをご覧ください](/en/sdk/android/plugins/meta-referrer-plugin)。 -## 6. SDKシグネチャーを設定する {% #set-up-sdk-signature %} +6\. SDKシグネチャーを設定する \{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------------- -Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/ja/article/sdk-signature)の手順に従ってください。 +Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/en/article/sdk-signature)の手順に従ってください。 -## 7. Adjust SDKを実装する {% #integrate-the-adjust-sdk %} +7\. Adjust SDKを実装する \{% \#integrate\-the\-adjust\-sdk %\} +---------------------------------------------------------------- Adjust SDKを初期化するには以下の情報が必要です: -* `appToken`: お客様の[Adjustアプリトークン](https://help.adjust.com/ja/article/app-settings#view-your-app-token)。 +* `appToken`: お客様の[Adjustアプリトークン](https://help.adjust.com/en/article/app-settings#view-your-app-token)。 * `environment`: アプリの実行環境。アプリをローカルでテストするには、これを`AdjustConfig.ENVIRONMENT_SANDBOX`に設定します。 Adjust SDKを初期化する推奨の方法は、グローバルAndroid[アプリケーションクラス](http://developer.android.com/reference/android/app/Application.html)内です。まだこれをアプリに設定していない場合は、以下の手順に従ってください: 1. `Application`を継承したクラスを作成します。 -1. `AndroidManifest.xml` ファイルを開き、 ``エレメントを確認します。 +2. `AndroidManifest.xml` ファイルを開き、 ``エレメントを確認します。 -1. `android:name`アトリビュートを``要素に追加し、アプリケーションクラスの名前に設定します。例えば、`Application`クラスの名前が`GlobalApplication`の場合、以下を設定します: +3. `android:name`アトリビュートを``要素に追加し、アプリケーションクラスの名前に設定します。例えば、`Application`クラスの名前が`GlobalApplication`の場合、以下を設定します: ```xml @@ -168,14 +175,14 @@ Adjust SDKを初期化する推奨の方法は、グローバルAndroid[アプ ``` -1. `Application`クラスで`initSdk`メソッドを見つけるか、存在しない場合は追加してください。以下のパラメーターをパスしてAdjust SDKを初期化します。 +4. `Application`クラスで`initSdk`メソッドを見つけるか、存在しない場合は追加してください。以下のパラメーターをパスしてAdjust SDKを初期化します。 * チーム編成 `appToken` * アプリを実行したい`environment` * 記録したい`LogLevel` -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; @@ -192,9 +199,11 @@ class GlobalApplication : Application () { } } ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; @@ -212,25 +221,25 @@ public class GlobalApplication extends Application { } } ``` -{% /tab %} -{% /tabs %} -### Adjust Web View SDKを実装する {% #integrate-the-adjust-web-view-sdk %} +\{% /tab %\}\{% /tabs %\} + +### Adjust Web View SDKを実装する \{% \#integrate\-the\-adjust\-web\-view\-sdk %\} アプリがWeb viewを使用している場合、Adjust Web View SDKを使って情報を記録する必要があります。`WebView`オブジェクトへのリファレンスを取得する必要があります。これが完了したら、以下の手順に従ってください: 1. `webView.getSettings().setJavaScriptEnabled(true)`を呼び出して、WebビューでJavascriptを有効にします。 -1. `AdjustBridge.registerAndGetInstance(getApplication(), webview)`を呼び出して、デフォルトの`AdjustBridgeInstance`を起動します。これにより、AdjustブリッジがJavascriptインターフェイスとしてWeb viewに登録されます。 +2. `AdjustBridge.registerAndGetInstance(getApplication(), webview)`を呼び出して、デフォルトの`AdjustBridgeInstance`を起動します。これにより、AdjustブリッジがJavascriptインターフェイスとしてWeb viewに登録されます。 -1. `AdjustBridge.setWebView()`を呼び出し、新しい`WebView`を設定します。 +3. `AdjustBridge.setWebView()`を呼び出し、新しい`WebView`を設定します。 -1. `AdjustBridge.unregister()`を呼び出し、`AdjustBridgeInstance`と`WebView`の登録を解除します。 +4. `AdjustBridge.unregister()`を呼び出し、`AdjustBridgeInstance`と`WebView`の登録を解除します。 -1. 以下は完全な設定の例です。 +5. 以下は完全な設定の例です。 + + \{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} - {% tabs %} - {% tab title="Kotlin" sync="kotlin" %} ```kotlin class MainActivity : Activity() { override fun onCreate(savedInstanceState: Bundle?) { @@ -257,9 +266,11 @@ public class GlobalApplication extends Application { } } ``` - {% /tab %} - {% tab title="Java" sync="java" %} + \{% /tab %\} + + \{% tab title="Java" sync="java" %\} + ```java public class MainActivity extends Activity { @Override @@ -288,10 +299,9 @@ public class GlobalApplication extends Application { } } ``` - {% /tab %} - {% /tabs %} -1. HTMLにAdjust Javascriptファイルをインポートします: + \{% /tab %\}\{% /tabs %\} +6. HTMLにAdjust Javascriptファイルをインポートします: ```html @@ -300,7 +310,7 @@ public class GlobalApplication extends Application { ``` -1. `appToken`と`environment`を`AdjustConfig`クラスにパスすることで、Web viewでAdjust SDKを初期化することができます: +7. `appToken`と`environment`を`AdjustConfig`クラスにパスすることで、Web viewでAdjust SDKを初期化することができます: ```js let yourAppToken = "{YourAppToken}"; @@ -310,32 +320,35 @@ public class GlobalApplication extends Application { Adjust.initSdk(adjustConfig); ``` -## 8. 本番用にアプリをビルドする {% #build-your-app-for-production %} +8\. 本番用にアプリをビルドする \{% \#build\-your\-app\-for\-production %\} +--------------------------------------------------------------------- テストが終わったら、本番用にアプリをビルドできます。そのためには、configオブジェクトを更新する必要があります。 1. 必要なものだけを返すようにログレベルを調整します。 +2. `environment`を`AdjustConfig.ENVIRONMENT_PRODUCTION`に設定します。 -1. `environment`を`AdjustConfig.ENVIRONMENT_PRODUCTION`に設定します。 +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} - {% tabs %} - {% tab title="Kotlin" sync="kotlin" %} - ```kotlin - val appToken = "{YourAppToken}" - val environment = AdjustConfig.ENVIRONMENT_PRODUCTION; - val config = AdjustConfig(this, appToken, environment) - config.setLogLevel(LogLevel.WARN) - Adjust.initSdk(config) - ``` - {% /tab %} +```kotlin +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_PRODUCTION; +val config = AdjustConfig(this, appToken, environment) +config.setLogLevel(LogLevel.WARN) +Adjust.initSdk(config) +``` + +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + +```java +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_PRODUCTION; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setLogLevel(LogLevel.WARN) +Adjust.initSdk(config); +``` + +\{% /tab %\}\{% /tabs %\} - {% tab title="Java" sync="java" %} - ```java - String appToken = "{YourAppToken}"; - String environment = AdjustConfig.ENVIRONMENT_PRODUCTION; - AdjustConfig config = new AdjustConfig(this, appToken, environment); - config.setLogLevel(LogLevel.WARN) - Adjust.initSdk(config); - ``` - {% /tab %} - {% /tabs %} diff --git a/src/content/docs/ja/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc b/src/content/docs/ja/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc index b713fd8be..29d85376e 100644 --- a/src/content/docs/ja/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc +++ b/src/content/docs/ja/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc @@ -1,30 +1,33 @@ --- -title: Samsung リファラー -description: Samsungのリファラープラグインを使用して、Samsung の情報をAdjustに送信します。 -slug: ja/sdk/android/plugins/samsung-referrer-plugin -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ja/sdk/android/v4/plugins/samsung-referrer-plugin +title: "Samsung リファラー" +description: "Samsungのリファラープラグインを使用して、Samsung の情報をAdjustに送信します。" +slug: "en/sdk/android/plugins/samsung-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/android/v4/plugins/samsung-referrer-plugin" --- - Samsungリファラープラグインは、Adjust SDKがデバイス上のSamsung Galaxyストアのインストールリファラー値を読み取ることを可能にします。SDKはこの情報をインストールペイロードの一部として、Adjustサーバーに送信します。 Samsungインストールリファラーは、Samsungインストールリファラーライブラリをサポートしている全てのデバイスで利用が可能です。 -## 事前準備 {% #before-you-begin %} +事前準備 \{% \#before\-you\-begin %\} +-------------------------------------- -[開始ガイド](/ja/sdk/android)に従ってAdjust SDKをアプリに実装してください。 +[開始ガイド](/en/sdk/android)に従ってAdjust SDKをアプリに実装してください。 -## Samsungリファラープラグインをインストールする {% #install-the-samsung-referrer-plugin %} +Samsungリファラープラグインをインストールする \{% \#install\-the\-samsung\-referrer\-plugin %\} +----------------------------------------------------------------------------------- Samsungリファラープラグインをインストールする方法は2つあります。 -### Maven {% #maven %} +### Maven \{% \#maven %\} Adjust SDK宣言にある`build.gradle`ファイルに以下のdependencyを追加してください。 @@ -33,11 +36,12 @@ implementation 'com.adjust.sdk:adjust-android:{% $versions.android.v5 %}' implementation 'com.adjust.sdk:adjust-android-samsung-referrer:{% $versions.android.v5 %}' ``` -### JAR {% #jar %} +### JAR \{% \#jar %\} Samsungリファラープラグインについては[GitHubリリースページ](https://github.com/adjust/android_sdk/releases/latest)をご覧ください。 -## Samsungインストールリファラーライブラリを追加する {% #add-the-samsung-install-referrer-library %} +Samsungインストールリファラーライブラリを追加する \{% \#add\-the\-samsung\-install\-referrer\-library %\} +-------------------------------------------------------------------------------------------- アプリがリファラー値を読み取るには、Samsungインストールリファラーを追加する必要があります。詳細は、Samsungの担当者または[support@samsungdevelopers.com](mailto:support@samsungdevelopers.com)までお問い合わせください。 @@ -47,7 +51,8 @@ Samsung インストールリファラーライブラリをインストールす implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:3.0.1' ``` -## Proguardの設定 {% #proguard-settings %} +Proguardの設定 \{% \#proguard\-settings %\} +-------------------------------------------- Proguardを使用している場合は、ビルド時に重要なクラスが削除されないようにするためにルールを追加してください。 @@ -63,42 +68,48 @@ Samsungインストールリファラーライブラリを保存するため、 -keep class com.sec.android.app.samsungapps.installreferrer.** { *; } ``` -## プラグインを使用する {% #use-the-plugin %} +プラグインを使用する \{% \#use\-the\-plugin %\} +------------------------------------------ Samsungリファラープラグインは、デフォルトで **有効** になっています。`AdjustSamsungReferrer`クラスメソッドを使用して、Samsungインストールのリファラー情報の読み取りをONまたはOFFにすることができます。 インストールリファラーの読み取りを **無効化** するには、SDKを初期化する **前** に`AdjustSamsungReferrer.doNotReadSamsungReferrer()`を呼び出します。 -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin AdjustSamsungReferrer.doNotReadSamsungReferrer() Adjust.initSdk(adjustConfig) ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java AdjustSamsungReferrer.doNotReadSamsungReferrer(); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} インストールリファラーの読み取りを **無効化** するには、SDKを初期化する **前** に`AdjustSamsungReferrer.readSamsungReferrer(applicationContext)`を呼び出します。 -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin AdjustSamsungReferrer.readSamsungReferrer(applicationContext) Adjust.initSdk(adjustConfig) ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java AdjustSamsungReferrer.readSamsungReferrer(applicationContext); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} + diff --git a/src/content/docs/ja/sdk/cordova/v5/index.mdoc b/src/content/docs/ja/sdk/cordova/v5/index.mdoc index abd7c12cc..9532ff019 100644 --- a/src/content/docs/ja/sdk/cordova/v5/index.mdoc +++ b/src/content/docs/ja/sdk/cordova/v5/index.mdoc @@ -1,22 +1,24 @@ --- -title: Cordova SDK 連携ガイド -description: Cordova SDKを使用して、CordovaアプリでAdjustの機能にアクセスしましょう。 -category-title: Cordova SDK -slug: ja/sdk/cordova +title: "Cordova SDK 連携ガイド" +description: "Cordova SDKを使用して、CordovaアプリでAdjustの機能にアクセスしましょう。" +category-title: "Cordova SDK" +slug: "en/sdk/cordova" sidebar-position: 6 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ja/sdk/cordova/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/cordova/v4" --- - Adjust Cordova SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをCordovaアプリで計測できます。以下の手順に従って、Adjust SDKをアプリに実装してください。また、[GitHub](https://github.com/adjust/cordova_sdk/tree/master/example-cordova)のサンプルアプリもご覧ください。 -## 1. プロジェクトにSDKを追加する {% #add-the-sdk-to-your-project %} +1\. プロジェクトにSDKを追加する \{% \#add\-the\-sdk\-to\-your\-project %\} +----------------------------------------------------------------------- Adjust Cordova SDKは、npmのプラグインとして提供されています。これをプロジェクトに追加するには、 @@ -40,9 +42,10 @@ Ionicを使用してアプリを開発する場合は、以下のコマンドを > ionic cordova plugin add com.adjust.sdk ``` -## 2. Androidデバイスを設定する {% #set-up-android-devices %} +2\. Androidデバイスを設定する \{% \#set\-up\-android\-devices %\} +--------------------------------------------------------------- -### パーミッションを追加する {% #add-permissions %} +### パーミッションを追加する \{% \#add\-permissions %\} Adjust SDKには、デフォルトで`com.google.android.gms.AD_ID`と`android.permission.INTERNET`パーミッションが含まれています。アプリをCOPPA準拠にする必要がある場合や、Google Playストアをターゲットにしない場合は、`remove`ディレクティブを追加することで`AD_ID`パーミッションを削除できます。 @@ -52,44 +55,44 @@ Adjust SDKには、デフォルトで`com.google.android.gms.AD_ID`と`android.p ``` -{% callout type="seealso" %} -このパーミッションに関する詳細は、Googleの[`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)をご参照ください。{% callout /%} +\{% callout type="seealso" %\} +このパーミッションに関する詳細は、Googleの[`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)をご参照ください。\{% /callout %\} -### インストールリファラーを設定する {% #set-up-install-referrer %} +### インストールリファラーを設定する \{% \#set\-up\-install\-referrer %\} -The Adjust SDK enables support for the [Google Play Referrer API](https://developer.android.com/google/play/installreferrer) by default. The Meta Install Referrer is available as a plugin for Android. [See the Cordova Meta Install Referrer plugin for integration details](/ja/sdk/cordova/plugins/meta-referrer-plugin). +Adjust SDKは、[Google Play Referrer API](https://developer.android.com/google/play/installreferrer)をデフォルトでサポートしています。MetaインストールリファラーはAndroidのプラグインとして利用可能です。[連携の詳細については、Cordova Meta インストール リファラープラグインをご覧ください。](/en/sdk/cordova/plugins/meta-referrer-plugin) -## 3. iOS frameworksを追加する {% #add-ios-frameworks %} +3\. iOS frameworksを追加する \{% \#add\-ios\-frameworks %\} +------------------------------------------------------------ Adjust SDKは、iOSデバイスで以下のフレームワークを自動的にリンクします。 -| Framework | 説明 | 注意 | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `AdSupport.framework` | デバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | -| `AdServices.framework` | Apple Search Adsのアトリビューションを処理します。 | | -| `StoreKit.framework` | SKAdNetworkフレームワークにアクセスできるようにします。 | iOS14以降のデバイスでAdjust SDKがSKAdNetworkとのコミュニケーションを行うために必要です。 | -| `AppTrackingTransparency.framework` | Adjust SDKがユーザーのトラッキング同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | - -## 4. SDKシグネチャーを設定する {% #set-up-sdk-signature %} - -Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/ja/article/sdk-signature)の手順に従ってください。 +| Framework | 説明 | 注意 | +|-------------------------------------|-------------------------------------------------------------------------------|-----------------------------------------------------------| +| `AdSupport.framework` | デバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | +| `AdServices.framework` | Apple Search Adsのアトリビューションを処理します。 | | +| `StoreKit.framework` | SKAdNetworkフレームワークにアクセスできるようにします。 | iOS14以降のデバイスでAdjust SDKがSKAdNetworkとのコミュニケーションを行うために必要です。 | +| `AppTrackingTransparency.framework` | Adjust SDKがユーザーのトラッキング同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | -## 5. Adjust SDKを初期化する {% #initialize-the-adjust-sdk %} +4\. SDKシグネチャーを設定する \{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------------- +Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/en/article/sdk-signature)の手順に従ってください。 +5\. Adjust SDKを初期化する \{% \#initialize\-the\-adjust\-sdk %\} +------------------------------------------------------------------ -{% callout type="important" %} +\{% callout type="important" %\} テストを実施する際は、環境が`AdjustConfig.EnvironmentSandbox`に設定されているようにしてください。アプリをアプリストアに提出する前に、これを`AdjustConfig.EnvironmentProduction`に変更してください。 -{% /callout %} +\{% /callout %\} Cordovaアプリ内で、即座にAdjust SDKを初期化するようにしてください。これを行うには、以下の手順に従ってください。 -1. 次の情報を使用して`AdjustConfig`オブジェクトをインスタンス化します。 - - * `appToken`: お客様の[Adjustアプリトークン](https://help.adjust.com/ja/article/app-settings#view-your-app-token)。 +1. 次の情報を使用して`AdjustConfig`オブジェクトをインスタンス化します。 + * `appToken`: お客様の[Adjustアプリトークン](https://help.adjust.com/en/article/app-settings#view-your-app-token)。 * `environment`: アプリの実行環境。アプリをローカルでテストするには、これを`AdjustConfig.EnvironmentSandbox`に設定します。 -1. SDKを初期化するには、`AdjustConfig`インスタンスを`Adjust.initSdk`メソッドにパスします。 +2. SDKを初期化するには、`AdjustConfig`インスタンスを`Adjust.initSdk`メソッドにパスします。 ```js var adjustConfig = new AdjustConfig( @@ -99,13 +102,15 @@ var adjustConfig = new AdjustConfig( Adjust.initSdk(adjustConfig); ``` -## 6. アプリをビルドする {% #build-your-app %} +6\. アプリをビルドする \{% \#build\-your\-app %\} +---------------------------------------------- これで、Cordovaアプリをビルドして実行できるようになります。ログを有効化して、問題がないか確認してください。また、ログの`Install tracked`メッセージもご覧ください。 Adjust SDKを使用してユーザーをアトリビューションできるようになりました。 -## 7. 連携をテストする {% #test-your-integration %} +7\. 連携をテストする \{% \#test\-your\-integration %\} +---------------------------------------------------- Adjust SDKは、実装をテストとトラブルシューティングのためのツールを提供します。以下の手順に従って、実装をテストしてください。 @@ -115,9 +120,9 @@ Adjust SDKは、実装をテストとトラブルシューティングのため 問題が発生した場合は、全ての詳細情報とログを添付し、[support@adjust.com](mailto:support@adjust.com)までメールをお送りください。 -### Google Play 開発者サービスの連携をテストする {% #test-google-play-services-integration %} +### Google Play 開発者サービスの連携をテストする \{% \#test\-google\-play\-services\-integration %\} -Adjust SDKがデバイスのGoogle広告IDを受信できるかどうかテストするには、ログレベルを **verbose** に、環境を **Sandbox** に設定します。アプリを起動してセッションまたはイベントを計測します。SDKが広告IDを読み取った場合、SDKは`gps_adid`(Google Play開発者サービス広告ID)パラメーターをログに記録します。 +Adjust SDKがデバイスのGoogle広告IDを受信できるかどうかテストするには、ログレベルを **verbose** に、環境を **Sandbox** に設定します。アプリを起動してセッションまたはイベントを計測します。SDKが広告IDを読み取った場合、SDKは`gps_adid`(Google Play開発者サービス広告ID\)パラメーターをログに記録します。 Google広告IDを取得する際に問題が発生した場合は、SDK [Githubリポジトリ](https://github.com/adjust/cordova_sdk)で質問を投稿するか、[support@adjust.com](mailto:support@adjust.com)までお問い合わせください。 -{% /callout %} + diff --git a/src/content/docs/ja/sdk/cordova/v5/plugins/index.mdoc b/src/content/docs/ja/sdk/cordova/v5/plugins/index.mdoc new file mode 100644 index 000000000..caadc4d06 --- /dev/null +++ b/src/content/docs/ja/sdk/cordova/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "サードパーティプラグイン" +description: "サードパーティSDKからAdjustに情報をパスするには、サードパーティプラグインを使用します。" +category-title: "プラグイン" +slug: "en/sdk/cordova/plugins" +type: "category" +sidebar-position: 5 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/cordova/v4" +--- +プラグインを使用して、サードパーティのプラグインに情報をパスします。 + diff --git a/src/content/docs/ja/sdk/cordova/v5/plugins/meta-install-referrer.mdoc b/src/content/docs/ja/sdk/cordova/v5/plugins/meta-install-referrer.mdoc new file mode 100644 index 000000000..dff72f0b2 --- /dev/null +++ b/src/content/docs/ja/sdk/cordova/v5/plugins/meta-install-referrer.mdoc @@ -0,0 +1,44 @@ +--- +title: "Meta インストールリファラー" +description: "Metaインストールリファラープラグインを使用して、 Metaインストールリファラー情報をAdjustに送信します。" +slug: "en/sdk/cordova/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/cordova/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +[Metaの要件](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)により、Adjust SDKは``エレメントをバンドルしています。これらを`AndroidManifest.xml`に追加する必要はありません。 +\{% /callout %\} + +Metaインストールリファラープラグインは、Adjust SDKがデバイス上のMetaインストールリファラー値を読み取ることを可能にします。その後、SDKはこの情報をインストールペイロードの一部として、Adjustサーバーに送信します。 + +プラグインをアプリに追加する方法: + +1. `build.gradle`ファイルに以下のdependencyを追加します: + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. [App Dashboard](https://developers.facebook.com/apps)でMetaアプリIDを検索します。詳しくはMetaの[アプリダッシュボードのドキュメント](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)をご覧ください。 + +3. `AdjustConfig`インスタンスの`fbAppId`プロパティにアプリIDを割り当てます。 + + ```js + var adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox, + ); + adjustConfig.setFbAppId("FB_APP_ID"); + Adjust.initSdk(adjustConfig); + ``` + diff --git a/src/content/docs/ja/sdk/flutter/v5/index.mdoc b/src/content/docs/ja/sdk/flutter/v5/index.mdoc index ca2b6b9f6..319c528d1 100644 --- a/src/content/docs/ja/sdk/flutter/v5/index.mdoc +++ b/src/content/docs/ja/sdk/flutter/v5/index.mdoc @@ -1,26 +1,28 @@ --- -title: Flutter SDK 連携ガイド -description: Flutter SDKを使用して、FlutterアプリでAdjustの機能にアクセスしましょう。 -category-title: Flutter SDK -slug: ja/sdk/flutter +title: "Flutter SDK 連携ガイド" +description: "Flutter SDKを使用して、FlutterアプリでAdjustの機能にアクセスしましょう。" +category-title: "Flutter SDK" +slug: "en/sdk/flutter" sidebar-position: 5 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ja/sdk/flutter/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/flutter/v4" --- - Adjust Unity SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをUnityアプリで計測できます。Adjust SDKをアプリに実装するには、以下の手順に従ってください。また、[GitHub](https://github.com/adjust/flutter_sdk/tree/master/example)でサンプルアプリも確認できます。 -{% callout type="important" %} +\{% callout type="important" %\} Adjust SDKは、iOS 12以降またはAndroid APIレベル21(Lollipop)以降に対応しています。 -{% /callout %} +\{% /callout %\} -## 1. プロジェクトにSDKを追加する {% #add-the-sdk-to-your-project %} +1\. プロジェクトにSDKを追加する \{% \#add\-the\-sdk\-to\-your\-project %\} +----------------------------------------------------------------------- Flutterアプリで[Adjust Flutter SDK](https://github.com/adjust/flutter_sdk/releases)を使用するには、それをプロジェクトに追加する必要があります。 @@ -33,15 +35,16 @@ Adjust SDKをFlutterプロジェクトに連携させるには、次のステッ adjust_sdk: ^{% $versions.flutter.v5 %} ``` -1. プロジェクトに移動して、次のコマンドを実行します。Visual Studioは、`pubspec.yaml`ファイルが編集された後に、このコマンドを自動的に実行します。 +2. プロジェクトに移動して、次のコマンドを実行します。Visual Studioは、`pubspec.yaml`ファイルが編集された後に、このコマンドを自動的に実行します。 ```console $ flutter packages get ``` -## 2. Androidデバイスを設定する {% #set-up-android-devices %} +2\. Androidデバイスを設定する \{% \#set\-up\-android\-devices %\} +--------------------------------------------------------------- -### Google Play 開発者サービスを追加する {% #add-google-play-services %} +### Google Play 開発者サービスを追加する \{% \#add\-google\-play\-services %\} Google Playストアを対象とするアプリは、[Google広告ID](https://support.google.com/googleplay/android-developer/answer/6048248?hl=en)(`gps_adid`)を使用してデバイスを識別する必要があります。これを行うには、以下のdependencyを`build.gradle`ファイルの `dependencies`セクションに追加してください。 @@ -49,11 +52,11 @@ Google Playストアを対象とするアプリは、[Google広告ID](https://su implementation 'com.google.android.gms:play-services-ads-identifier:18.1.0' ``` -{% callout type="note" %} +\{% callout type="note" %\} Adjust SDKは、`play-services-ads-identifier`dependencyのどのバージョンとも関連付けられていません。Google Play 開発者サービスのライブラリの任意のバージョンを使用できます。 -{% /callout %} +\{% /callout %\} -### パーミッションを追加する {% #add-permissions %} +### パーミッションを追加する \{% \#add\-permissions %\} Adjust SDKには以下のパーミッションが必要です。まだ存在しない場合は、`AndroidManifest.xml`ファイルに追加してください。 @@ -67,11 +70,10 @@ Adjust SDKには、デフォルトで`com.google.android.gms.AD_ID`パーミッ ``` -{% callout type="seealso" %} -このパーミッションに関する詳細は、Googleの[`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)をご参照ください。 -{% /callout %} +\{% callout type="seealso" %\} +このパーミッションに関する詳細は、Googleの[`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)をご参照ください。\{% /callout %\} -### インストールリファラーを設定する {% #set-up-install-referrer %} +### インストールリファラーを設定する \{% \#set\-up\-install\-referrer %\} インストールリファラーは、アプリインストールをソースにアトリビュートするために使用できる一意の識別子です。Adjust SDKは、アトリビューションを実行するためにこの情報を必要とします。 @@ -87,43 +89,48 @@ implementation 'com.android.installreferrer:installreferrer:2.2' #### Metaとのリファラー連携 -Adjust SDKは、Adjust Metaインストールリファラープラグインを使用して[Metaインストールリファラー](https://developers.facebook.com/docs/app-ads/meta-install-referrer)をサポートしています。[連携の詳細については、Flutter Meta インストール リファラープラグインをご覧ください](/ja/sdk/flutter/plugins/meta-referrer-plugin)。 +Adjust SDKは、Adjust Metaインストールリファラープラグインを使用して[Metaインストールリファラー](https://developers.facebook.com/docs/app-ads/meta-install-referrer)をサポートしています。[連携の詳細については、Flutter Meta インストール リファラープラグインをご覧ください](/en/sdk/flutter/plugins/meta-referrer-plugin)。 -## 3. iOS frameworksを追加する {% #add-ios-frameworks %} +3\. iOS frameworksを追加する \{% \#add\-ios\-frameworks %\} +------------------------------------------------------------ -特定のiOS frameworksをアプリに実装すると、Adjust SDKは追加の情報を取得できます。これらのframeworksによって特定のSDK機能を有効にできますが、SDKが正常に動作するために必須というわけではありません。 フレームワークを追加し、その後、 **Project Settings --> Build Phases --> Link Binary With Libraries** で **Optional** としてマークすることができます。 +特定のiOS frameworksをアプリに実装すると、Adjust SDKは追加の情報を取得できます。これらのframeworksによって特定のSDK機能を有効にできますが、SDKが正常に動作するために必須というわけではありません。 フレームワークを追加し、その後、 **Project Settings \-\-> Build Phases \-\-> Link Binary With Libraries** で **Optional** としてマークすることができます。 -| Framework | 説明 | 注意 | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `AdSupport.framework` | デバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | -| `AdServices.framework` | Apple Search Adsのアトリビューションを処理します。 | | -| `StoreKit.framework` | SKAdNetworkフレームワークにアクセスできるようにします。 | iOS14以降のデバイスでAdjust SDKがSKAdNetworkとのコミュニケーションを行うために必要です。 | -| `AppTrackingTransparency.framework` | Adjust SDKがユーザーのATT同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | +| Framework | 説明 | 注意 | +|-------------------------------------|----------------------------------------------------------------------------|-----------------------------------------------------------| +| `AdSupport.framework` | デバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | +| `AdServices.framework` | Apple Search Adsのアトリビューションを処理します。 | | +| `StoreKit.framework` | SKAdNetworkフレームワークにアクセスできるようにします。 | iOS14以降のデバイスでAdjust SDKがSKAdNetworkとのコミュニケーションを行うために必要です。 | +| `AppTrackingTransparency.framework` | Adjust SDKがユーザーのATT同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | -## 4. SDKシグネチャーを設定する {% #set-up-sdk-signature %} +4\. SDKシグネチャーを設定する \{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------------- -Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/ja/article/sdk-signature)の手順に従ってください。 +Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/en/article/sdk-signature)の手順に従ってください。 -## 5. Adjust SDKを初期化する {% #initialize-the-adjust-sdk %} +5\. Adjust SDKを初期化する \{% \#initialize\-the\-adjust\-sdk %\} +------------------------------------------------------------------ Flutterアプリ内で、出来るだけ早くAdjust SDKを初期化するようにしてください。これを行うには、アプリトークンを使ってConfigオブジェクトとアプリを実行したい環境を初期化します。 -{% callout type="important" %} +\{% callout type="important" %\} テストを実施する際は、環境が`AdjustEnvironment.sandbox`に設定されているようにしてください。アプリをアプリストアに提出する前に、これを`AdjustEnvironment.production`に変更してください。 -{% /callout %} +\{% /callout %\} ```dart AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); Adjust.initSdk(config); ``` -## 6. アプリをビルドする {% #build-your-app %} +6\. アプリをビルドする \{% \#build\-your\-app %\} +---------------------------------------------- 設定が完了しました。これでFlutterアプリのビルドと実行が可能になります。ログを有効化して、問題がないか確認してください。ログに、`Install tracked`メッセージがあるか確認してください。 Adjust SDKを使用してユーザーをアトリビューションできるようになりました。 -## 7. 連携をテストする {% #test-your-integration %} +7\. 連携をテストする \{% \#test\-your\-integration %\} +---------------------------------------------------- Adjust SDKは、実装をテストとトラブルシューティングのためのツールを提供します。以下の手順に従って、実装をテストしてください。 @@ -131,12 +138,13 @@ Adjust SDKは、実装をテストとトラブルシューティングのため * Adjustダッシュボードにサンドボックスフィルターを追加します。 * ログレベルを`AdjustLogLevel.verbose`に設定します。 -{% callout type="tip" %} +\{% callout type="tip" %\} 問題が発生した場合は、全ての詳細情報とログを添付し、[support@adjust.com](mailto:support@adjust.com)までメールをお送りください。 -{% /callout %} +\{% /callout %\} -### Google Play 開発者サービスの連携をテストする {% #test-google-play-services-integration %} +### Google Play 開発者サービスの連携をテストする \{% \#test\-google\-play\-services\-integration %\} -Adjust SDKがデバイスのGoogle広告IDを受信できるかどうかテストするには、ログレベルを`AdjustLogLevel.verbose`に、環境を`AdjustEnvironment.sandbox`に設定します。アプリを起動してセッションまたはイベントを計測します。SDKが広告IDを読み取った場合、SDKは`gps_adid`(Google Play開発者サービス広告ID)パラメーターをログに記録します。 +Adjust SDKがデバイスのGoogle広告IDを受信できるかどうかテストするには、ログレベルを`AdjustLogLevel.verbose`に、環境を`AdjustEnvironment.sandbox`に設定します。アプリを起動してセッションまたはイベントを計測します。SDKが広告IDを読み取った場合、SDKは`gps_adid`(Google Play開発者サービス広告ID\)パラメーターをログに記録します。 Google広告IDを取得する際に問題が発生した場合は、SDK [Githubリポジトリ](https://github.com/adjust/flutter_sdk)で質問を投稿するか、[support@adjust.com](mailto:support@adjust.com)までお問い合わせください。 + diff --git a/src/content/docs/ja/sdk/flutter/v5/plugins/index.mdoc b/src/content/docs/ja/sdk/flutter/v5/plugins/index.mdoc new file mode 100644 index 000000000..a77efb1ef --- /dev/null +++ b/src/content/docs/ja/sdk/flutter/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "サードパーティプラグイン" +description: "サードパーティSDKからAdjustに情報をパスするには、サードパーティプラグインを使用します。" +category-title: "プラグイン" +slug: "en/sdk/flutter/plugins" +type: "category" +sidebar-position: 5 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/flutter/v4" +--- +プラグインを使用して、サードパーティのプラグインに情報をパスします。 + diff --git a/src/content/docs/ja/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc b/src/content/docs/ja/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc new file mode 100644 index 000000000..10a7ef1b3 --- /dev/null +++ b/src/content/docs/ja/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc @@ -0,0 +1,41 @@ +--- +title: "Meta インストールリファラー" +description: "Metaインストールリファラープラグインを使用して、 Metaインストールリファラー情報をAdjustに送信します。" +slug: "en/sdk/flutter/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/flutter/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +[Metaの要件](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)により、Adjust SDKは``エレメントをバンドルしています。これらを`AndroidManifest.xml`に追加する必要はありません。 +\{% /callout %\} + +Metaインストールリファラープラグインは、Adjust SDKがデバイス上のMetaインストールリファラー値を読み取ることを可能にします。その後、SDKはこの情報をインストールペイロードの一部として、Adjustサーバーに送信します。 + +プラグインをアプリに追加する方法: + +1. `build.gradle`ファイルに以下のdependencyを追加します: + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. [App Dashboard](https://developers.facebook.com/apps)でMetaアプリIDを検索します。詳しくはMetaの[アプリダッシュボードのドキュメント](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)をご覧ください。 + +3. `AdjustConfig`インスタンスの`fbAppId`プロパティにアプリIDを割り当てます。 + + ```dart + AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); + config.fbAppId = ""; + Adjust.initSdk(AdjustConfig); + ``` + diff --git a/src/content/docs/ja/sdk/ios/v5/index.mdoc b/src/content/docs/ja/sdk/ios/v5/index.mdoc index fc2a60781..b97ce1b90 100644 --- a/src/content/docs/ja/sdk/ios/v5/index.mdoc +++ b/src/content/docs/ja/sdk/ios/v5/index.mdoc @@ -1,39 +1,41 @@ --- -title: iOS SDK連携ガイド -description: iOS SDKを使用して、iOSアプリでAdjustの機能にアクセスしましょう。 -category-title: iOS SDK -slug: ja/sdk/ios +title: "iOS SDK連携ガイド" +description: "iOS SDKを使用して、iOSアプリでAdjustの機能にアクセスしましょう。" +category-title: "iOS SDK" +slug: "en/sdk/ios" sidebar-position: 2 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ja/sdk/ios/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/ios/v4" --- - Adjust iOS SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをWebアプリで記録できます。このガイドでは、Adjust SDKをアプリに実装する方法を紹介します。 -{% callout type="important" %} +\{% callout type="important" %\} Adjust SDKはiOS 12以降のバージョンに対応しています。 -{% /callout %} +\{% /callout %\} -## 1. プロジェクトにSDKを追加する {% #add-the-sdk-to-your-project %} +1\. プロジェクトにSDKを追加する \{% \#add\-the\-sdk\-to\-your\-project %\} +----------------------------------------------------------------------- iOSアプリでAdjust SDKを使うには、Xcodeプロジェクトに追加する必要があります。 Swift Package Managerを使ってSDKを追加するには、以下の手順に従ってください。 -1. **File --> Swift Packages --> Add Package Dependency** を選択します。 -1. 表示されたボックスに、SDKのGitHubのアドレスを入力します。 `https://github.com/adjust/ios_sdk` -1. **Version** ドロップダウンで、使用したいAdjust SDKのバージョンを選択します。最新のパージョンは[リリースページ](https://github.com/adjust/ios_sdk/releases)からご確認ください。 +1. **File \-\-> Swift Packages \-\-> Add Package Dependency** を選択します。 +2. 表示されたボックスに、SDKのGitHubのアドレスを入力します。 `https://github.com/adjust/ios_sdk` +3. **Version** ドロップダウンで、使用したいAdjust SDKのバージョンを選択します。最新のパージョンは[リリースページ](https://github.com/adjust/ios_sdk/releases)からご確認ください。 -### その他のインストール方法 {% #alternative-installation-methods %} +### その他のインストール方法 \{% \#alternative\-installation\-methods %\} -{% tabs %} -{% tab title="Cocoapods" sync="cocoapods" %} +\{% tabs %\} +\{% tab title="Cocoapods" sync="cocoapods" %\} Cocoapodsを使ってSDKを追加するには、`Podfile`で使用したいバージョンを指定します。 ```rb @@ -46,71 +48,77 @@ pod 'Adjust', '~> {% $versions.ios.v5 %}' ```rb pod 'Adjust/AdjustWebBridge', '~> {% $versions.ios.v5 %}' ``` -{% /tab %} -{% tab title="Carthage" sync="carthage" %} +\{% /tab %\} + +\{% tab title="Carthage" sync="carthage" %\} Carthageを使ってSDKを追加するには、以下を`Cartfile`に追加します。 ```text github "adjust/ios_sdk" ``` -{% /tab %} -{% /tabs %} -## 2. Adjust SDKを実装する {% #integrate-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} + +2\. Adjust SDKを実装する \{% \#integrate\-the\-adjust\-sdk %\} +---------------------------------------------------------------- Adjust SDKを`Xcode`プロジェクトに追加したら、それをアプリで実装する必要があります。 プロジェクトファイルに関連するimport statement(インポートステートメント)を追加します。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\} +\{% tab title="Swift" sync="swift" %\} Adjust SDKをインポートするには、以下をbridging headerファイルに追加します。 ```swift import AdjustSdk ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} Adjust SDKをインポートするには、以下を`AppDelegate.h`ファイルに追加します。 ```objc #import ``` -{% /tab %} -{% /tabs %} -## 3. iOS frameworksを追加する {% #add-ios-frameworks %} +\{% /tab %\}\{% /tabs %\} + +3\. iOS frameworksを追加する \{% \#add\-ios\-frameworks %\} +------------------------------------------------------------ Adjust SDKは、特定のデバイス情報にアクセスするためにフレームワークに依存しています。この情報を読み取れるようにするには、フレームワークを追加してそれらを **オプション** として表示します。 -| Framework | 説明 | 注意 | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `AdSupport.framework` | デバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | -| `AdServices.framework` | ASAアトリビューションを処理します。 | | -| `StoreKit.framework` | SKAdNetworkフレームワークにアクセスできるようにします。 | iOS14以降のデバイスでAdjust SDKがSKAdNetworkとの通信を処理するために必要です。 | -| `AppTrackingTransparency.framework` | Adjust SDKがユーザーのATT同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | -| `WebKit.framework` | アプリでWeb viewを使用できるようにします。 | アプリがWeb viewを使用している場合にのみ必要です。 | +| Framework | 説明 | 注意 | +|-------------------------------------|----------------------------------------------------------------------------|------------------------------------------------------| +| `AdSupport.framework` | デバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | +| `AdServices.framework` | ASAアトリビューションを処理します。 | | +| `StoreKit.framework` | SKAdNetworkフレームワークにアクセスできるようにします。 | iOS14以降のデバイスでAdjust SDKがSKAdNetworkとの通信を処理するために必要です。 | +| `AppTrackingTransparency.framework` | Adjust SDKがユーザーのATT同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。 | アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。 | +| `WebKit.framework` | アプリでWeb viewを使用できるようにします。 | アプリがWeb viewを使用している場合にのみ必要です。 | -## 4. SDKシグネチャーを設定する {% #set-up-sdk-signature %} +4\. SDKシグネチャーを設定する \{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------------- -Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/ja/article/sdk-signature)の手順に従ってください。 +Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/en/article/sdk-signature)の手順に従ってください。 -## 5.(オプション)Adjust Web Bridgeを設定する {% #set-up-web-bridge %} +5\.(オプション)Adjust Web Bridgeを設定する \{% \#set\-up\-web\-bridge %\} +---------------------------------------------------------------------- アプリがWeb viewを使用している場合、Adjust Web Bridgeを設定してWeb view内のアクティビティを記録する必要があります。 -### `AdjustBridge`をアプリに実装する {% #integrate-adjustbridge-into-your-app %} +### `AdjustBridge`をアプリに実装する \{% \#integrate\-adjustbridge\-into\-your\-app %\} プロジェクトナビゲータにて: 1. View Controllerのソースファイルを開きます。 -1. ファイルの最上部に`import`ステートメントを追加します。 -1. Web View Delegateの`viewDidLoad`または`viewWillAppear`メソッドの`AdjustBridge`に以下のコールを追加します。 +2. ファイルの最上部に`import`ステートメントを追加します。 +3. Web View Delegateの`viewDidLoad`または`viewWillAppear`メソッドの`AdjustBridge`に以下のコールを追加します。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -121,9 +129,11 @@ func viewWillAppear(_ animated: Bool) { adjustBridge.loadWKWebViewBridge(webView) } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import "" @@ -136,39 +146,40 @@ func viewWillAppear(_ animated: Bool) { // Your code here ``` -{% /tab %} -{% /tabs %} -#### `AdjustBridge`をWeb viewに実装する {% #integrate-adjustbridge-into-your-web-view %} +\{% /tab %\}\{% /tabs %\} + +#### `AdjustBridge`をWeb viewに実装する \{% \#integrate\-adjustbridge\-into\-your\-web\-view %\} Web viewでJavascriptを使用するには、bridgeを設定する必要があります。Adjust iOSのWeb bridgeを初期化するには、以下のJavascriptコードを追加してください。 -{% tabs %} -{% tab title="Javascript" sync="js" %} +\{% tabs %\}\{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -## 6. Adjust SDKを初期化する {% #initialize-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} + +6\. Adjust SDKを初期化する \{% \#initialize\-the\-adjust\-sdk %\} +------------------------------------------------------------------ Adjust SDKを初期化するには、configオブジェクトを作成する必要があります。このオブジェクトには、Adjust SDKの動作をコントロールする設定オプションが含まれています。最小限の設定を行うために、以下の引数をパスします。 -* `appToken`: [アプリトークン](https://help.adjust.com/ja/article/app-settings#view-your-app-token)。 +* `appToken`: [アプリトークン](https://help.adjust.com/en/article/app-settings#view-your-app-token)。 * `environment`: SDKを実行したい環境。`ADJEnvironmentSandbox`に設定します。 ConfigオブジェクトでAdjust SDKを初期化: 1. アプリデリゲートの`didFinishLaunching`または`didFinishLaunchingWithOptions`メソッド内のconfigオブジェクトを宣言します。 -1. Configオブジェクトの`logLevel`プロパティを`ADJLogLevelVerbose`(verbose)に設定します。デバイス情報を取得するには、verboseロギングを有効化する必要があります。 -1. Configオブジェクトを引数として`initSdk`メソッドにパスします。 +2. Configオブジェクトの`logLevel`プロパティを`ADJLogLevelVerbose`(verbose)に設定します。デバイス情報を取得するには、verboseロギングを有効化する必要があります。 +3. Configオブジェクトを引数として`initSdk`メソッドにパスします。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -184,9 +195,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -201,37 +214,38 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% tab title="Javascript" sync="js" %} +\{% /tab %\} + +\{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -### iMessageアプリを設定する {% #set-up-your-imessage-app %} +\{% /tab %\}\{% /tabs %\} + +### iMessageアプリを設定する \{% \#set\-up\-your\-imessage\-app %\} -{% callout type="important" %} -iMessageの拡張機能は、アプリとは異なるバンドル識別子を持ち、別のメモリースペースで実行されます。同じトークンで両方を設定した場合、SDKはミックスデータを返します。AdjustダッシュボードでiMessageアプリ用に別のアプリを作成し、Adjust SDKを初期化する際にそのトークンを使用する必要があります。\ -{% /callout %} +\{% callout type="important" %\} +iMessageの拡張機能は、アプリとは異なるバンドル識別子を持ち、別のメモリースペースで実行されます。同じトークンで両方を設定した場合、SDKはミックスデータを返します。AdjustダッシュボードでiMessageアプリ用に別のアプリを作成し、Adjust SDKを初期化する際にそのトークンを使用する必要があります。\{% /callout %\} アプリがiMessageをターゲティングしている場合、いくつか追加の設定を行う必要があります。 * ソースからAdjust SDKを追加した場合、`ADJUST_IM=1`プリプロセッサマクロをiMessageプロジェクトの設定に追加してください。 * Adjust SDKをフレームワークとして追加した場合、 **ビルドフェーズ** プロジェクト設定で **新規コピーファイルフェーズ(New Copy Files Phases)** を追加します。`AdjustSdkIm.framework`をフレームワークフォルダーにコピーするように設定してください。 -#### セッションを記録する {% #record-sessions %} +#### セッションを記録する \{% \#record\-sessions %\} Adjust SDKはiMessageアプリのiOSシステム通知を受け取りません。アプリがフォアグラウンドに入った、またはフォアグラウンドから離れたことをAdjust SDKに通知するには、`trackSubsessionStart`と`trackSubsessionEnd`メソッドを呼び出す必要があります。 `didBecomeActiveWithConversation:`メソッド内で`trackSubsessionStart`へのコールを追加します。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func didBecomeActive(with conversation: MSConversation) { // Called when the extension is about to move from the inactive to active state. @@ -241,9 +255,11 @@ func didBecomeActive(with conversation: MSConversation) { Adjust.trackSubsessionStart() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)didBecomeActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the inactive to active state. @@ -253,13 +269,13 @@ func didBecomeActive(with conversation: MSConversation) { [Adjust trackSubsessionStart]; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} `willResignActiveWithConversation:`メソッド内で`trackSubsessionEnd`へのコールを追加します。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func willResignActive(with conversation: MSConversation) { // Called when the extension is about to move from the active to inactive state. @@ -273,9 +289,11 @@ func willResignActive(with conversation: MSConversation) { Adjust.trackSubsessionEnd() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)willResignActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the active to inactive state. @@ -289,30 +307,33 @@ func willResignActive(with conversation: MSConversation) { [Adjust trackSubsessionEnd]; } ``` -{% /tab %} -{% /tabs %} -## 7. Adjust SDKを設定する {% #configure-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} -Configオブジェクトと初期化ロジックを追加したら、Adjust SDKを設定してアプリの様々な部分に関する情報を記録することができます。[設定ガイド](/ja/sdk/ios/configuration)と[機能ガイド](/ja/sdk/ios/features)を参照し、記録したいデータを正確に設定してください。 +7\. Adjust SDKを設定する \{% \#configure\-the\-adjust\-sdk %\} +---------------------------------------------------------------- -## 8. Adjust SDKをテストする {% #test-the-adjust-sdk %} +Configオブジェクトと初期化ロジックを追加したら、Adjust SDKを設定してアプリの様々な部分に関する情報を記録することができます。[設定ガイド](/en/sdk/ios/configuration)と[機能ガイド](/en/sdk/ios/features)を参照し、記録したいデータを正確に設定してください。 -アプリの情報を記録するようにAdjust SDKを設定したら、次はテストを行います。Adjustは、アプリのテストに役立つ[テストコンソール](https://help.adjust.com/ja/article/testing-console)と[デバイスAPI](https://help.adjust.com/ja/article/device-api)を提供しています。 +8\. Adjust SDKをテストする \{% \#test\-the\-adjust\-sdk %\} +------------------------------------------------------------ -[テストガイド](https://help.adjust.com/ja/article/test-the-adjust-sdk)に従って、Adjustがアプリから想定どおりの値を受け取ることを確認してください。 +アプリの情報を記録するようにAdjust SDKを設定したら、次はテストを行います。Adjustは、アプリのテストに役立つ[テストコンソール](https://help.adjust.com/en/article/testing-console)と[デバイスAPI](https://help.adjust.com/en/article/device-api)を提供しています。 -## 9. 本番用にアプリをビルドする {% #build-your-app-for-production %} +[テストガイド](https://help.adjust.com/en/article/test-the-adjust-sdk)に従って、Adjustがアプリから想定どおりの値を受け取ることを確認してください。 + +9\. 本番用にアプリをビルドする \{% \#build\-your\-app\-for\-production %\} +--------------------------------------------------------------------- テストが終わったら、本番用にアプリをビルドできます。そのためには、configオブジェクトを更新する必要があります。 以下の値を更新します。 * `environment`: `ADJEnvironmentProduction`に設定します。 -* `logLevel`: [ログレベル](/ja/sdk/ios/configuration#set-your-logging-level)を選択するか、configプロジェクトに`allowSuppressLogLevel`引数をパスしてログを完全に無効化します。 +* `logLevel`: [ログレベル](/en/sdk/ios/configuration#set-your-logging-level)を選択するか、configプロジェクトに`allowSuppressLogLevel`引数をパスしてログを完全に無効化します。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -331,9 +352,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -350,13 +373,13 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} `Xcode`のビルドフラグを使用して、debug buildと本番ビルドのどちらを作成するかに応じて、動的に設定を更新することができます。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { // Override point for customization after application launch. @@ -382,9 +405,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -409,5 +434,6 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} + diff --git a/src/content/docs/ja/sdk/unity/v4/plugins/index.mdoc b/src/content/docs/ja/sdk/unity/v4/plugins/index.mdoc new file mode 100644 index 000000000..5f36da5c2 --- /dev/null +++ b/src/content/docs/ja/sdk/unity/v4/plugins/index.mdoc @@ -0,0 +1,19 @@ +--- +title: "サードパーティプラグイン" +description: "サードパーティSDKからAdjustに情報をパスするには、サードパーティプラグインを使用します。" +category-title: "プラグイン" +type: "category" +sidebar-position: 4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v5: "/en/sdk/unity/plugins" +--- +プラグインを使用して、サードパーティのプラグインに情報をパスします。 + diff --git a/src/content/docs/ja/sdk/unity/v5/index.mdoc b/src/content/docs/ja/sdk/unity/v5/index.mdoc index 93769f1d1..521c62f02 100644 --- a/src/content/docs/ja/sdk/unity/v5/index.mdoc +++ b/src/content/docs/ja/sdk/unity/v5/index.mdoc @@ -1,78 +1,81 @@ --- -title: Unity SDK 連携ガイド -description: Unity SDKを使用して、UnityアプリでAdjust機能にアクセスしましょう。 -category-title: Unity SDK -slug: ja/sdk/unity +title: "Unity SDK 連携ガイド" +description: "Unity SDKを使用して、UnityアプリでAdjust機能にアクセスしましょう。" +category-title: "Unity SDK" +slug: "en/sdk/unity" sidebar-position: 3 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ja/sdk/unity/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/unity/v4" --- - Adjust Unity SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをUnityアプリで記録できます。Adjust SDKをアプリに実装するには、以下の手順に従ってください。 -{% callout type="note" %} -Adjust SDKは、iOS 12以降またはAndroid APIレベル21(Lollipop)以降に対応しています。 -{% /callout %} +事前準備 \{% \#before\-you\-begin %\} +-------------------------------------- + +事前準備として、以下の内容をご確認ください。 + +* Adjust SDKは、iOS 12以降またはAndroid APIレベル21(Lollipop)以降に対応しています。 +* Adjust SDKはUnity Editor 2018\.2以降に対応しています。 -## 1. Adjust SDKを取得する {% #get-the-adjust-sdk %} +1\. Adjust SDKを取得する \{% \#get\-the\-adjust\-sdk %\} +---------------------------------------------------------- Adjust SDKをインストールするには、次のいずれかのメソッドを選択します。 -### Unityのパッケージをインストールする {% #install-unity-package %} +### Unityのパッケージをインストールする \{% \#install\-unity\-package %\} UnityアプリでAdjust SDKを使うには、プロジェクトに追加する必要があります。[GitHubのリリースページ](https://github.com/adjust/adjust_unity_sdk/releases/latest)から最新バージョンをダウンロードできます。 以下の手順に従って、Adjust SDKをUnityプロジェクトにインポートしてください。 1. Unityエディター(Unity Editor)を開きます。 -1. **Assets --> Import Package --> Custom Package** を選択します。 -1. ダウンロードしたSDKパッケージを選択します。 +2. **Assets \-\-> Import Package \-\-> Custom Package** を選択します。 +3. ダウンロードしたSDKパッケージを選択します。 -### UnityのPackage Managerを使用する {% #use-the-unity-package-manager %} +### UnityのPackage Managerを使用する \{% \#use\-the\-unity\-package\-manager %\} Unity Package Managerを使用してAdjust SDKをインストールするには、以下の手順に従ってください。 1. Unity editorで、 **Package Manager** ウィンドウを選択します。 -1. **Add package from git URLを** 選択します。 -1. 次のURLを入力します:`https://github.com/adjust/unity_sdk.git?path=Assets/Adjust`。 - -## 2. iOSとAndroid SDKをインストールする {% #install-ios-and-android-sdks %} - -SDK v5は、iOSとAndroid SDKをバイナリ依存として使用しなくなりました。基盤となるiOSおよびAndroid SDKをインストールするには、[External Dependency Manager for Unity (EDM4U)](https://github.com/googlesamples/unity-jar-resolver)を使用して、CocoaPodsとMavenからパッケージをインストールする必要があります。 - -iOS向けにプライバシーマニフェストとフレームワークが正しく読み込まれるようにするには、静的リンクを無効にする必要があります。これを行うには、以下の手順に従ってください。 +2. **Add package from git URLを** 選択します。 +3. 次のURLを入力します:`https://github.com/adjust/unity_sdk.git?path=Assets/Adjust`。 -1. **Assets -> External Dependency Manager -> iOS Resolver -> Settings** を選択します。 -1. **Link frameworks statically** オプションを見つけ、チェックを外します。 +2\. iOSとAndroid SDKをインストールする \{% \#install\-ios\-and\-android\-sdks %\} +------------------------------------------------------------------------------- -![A screenshot of the resolver settings menu](@images/unity/link-frameworks-statically.png) +\{% minorversion +changed="v5\.0\.4" +link="[https://github.com/adjust/unity\_sdk/releases/tag/v5\.0\.4](https://github.com/adjust/unity_sdk/releases/tag/v5.0.4)" %\} +SDK v5では、iOSおよびAndroid SDKがバイナリー依存関係として使用されなくなりました。iOSおよびAndroid SDKをインストールするには、[External Dependency Manager for Unity \(EDM4U\)](https://github.com/googlesamples/unity-jar-resolver)を使用して、CocoaPodsおよびMavenからパッケージをインストールする必要があります。 +\{% /minorversion %\} -## 3. SDKを実装する {% #integrate-the-sdk %} +3\. SDKを実装する \{% \#integrate\-the\-sdk %\} +------------------------------------------------ Adjust SDKには、ゲームオブジェクトのテンプレートとAdjustスクリプトを含むUnity[プレハブ(Prefab)](https://docs.unity3d.com/Manual/Prefabs.html)が格納されています。このスクリプトを使用してSDKを設定できます。Unityエディターでプレハブを開くには、以下の手順に従ってください。 1. `Assets/Adjust/Adjust.prefab`のプレハブを1番目のシーンに追加します。 -1. プレハブのInspector Menuを開きます。 -1. プレハブのメニューには、Adjust SDKの動作を制御する編集可能なフィールドが含まれています。 +2. プレハブのInspector Menuを開きます。 +3. プレハブのメニューには、Adjust SDKの動作を制御する編集可能なフィールドが含まれています。 ![UnityエディターのAdjust SDK プレハブ構成スクリプト](@images/unity/1-prefab.png) 以下の情報を入力して、Adjust SDKを設定します。 1. **アプリトークン** 。アプリトークンの確認方法については、アプリ設定をご覧ください。 - -1. **環境** : - +2. **環境** : * アプリをテスト中で、テストデータを送信する必要がある場合は、 **サンドボックス** を選択します。テストデータを表示するには、ダッシュボードでサンドボックスモードを有効にする必要があります。 * テストが完了し、アプリを公開する準備が整ったら、 **本番用** を選択します。 -1. **ログレベル** 。ログレベルは、受け取るログの内容を制御します。詳しくは、[ログレベルの設定](/ja/sdk/unity/configuration#set-your-logging-level)をご覧ください。 +3. **ログレベル** 。ログレベルは、受け取るログの内容を制御します。詳しくは、[ログレベルの設定](/en/sdk/unity/configuration#set-your-logging-level)をご覧ください。 Adjust SDKは、アプリのAwakeイベントが発生したときにデフォルトで開始します。この動作をオーバーライドするには、 **START SDK MANUALLY** オプションをONにしてください。これにより、configインスタンスを引数として`Adjust.InitSdk`を呼び出すことで、Adjust SDKを初期化できます。 @@ -81,14 +84,15 @@ AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment Adjust.InitSdk(adjustConfig); ``` -## 4. Androidデバイスを設定する {% #set-up-android-devices %} +4\. Androidデバイスを設定する \{% \#set\-up\-android\-devices %\} +--------------------------------------------------------------- -### Google Play 開発者サービスを追加する {% #add-google-play-services %} +### Google Play 開発者サービスを追加する \{% \#add\-google\-play\-services %\} -Google Playストアを対象とするアプリは、gps_adid(Google広告ID)を使用してデバイスを識別する必要があります。`gps_adid`にアクセスするには、`play-services-ads-identifier` AARをプロジェクトに追加する必要があります。 +Google Playストアを対象とするアプリは、gps\_adid(Google広告ID)を使用してデバイスを識別する必要があります。`gps_adid`にアクセスするには、`play-services-ads-identifier` AARをプロジェクトに追加する必要があります。 -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} [External Dependency Managerプラグイン](https://developers.google.com/unity/archive#external_dependency_manager_for_unity)を使用している場合は、`Dependencies.xml`ファイルに以下を追加します。 ```xml @@ -96,19 +100,20 @@ Google Playストアを対象とするアプリは、gps_adid(Google広告ID ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} ARR(Android Archive)を手動でインストールするには、[Mavenからダウンロード](https://maven.google.com/web/index.html#com.google.android.gms:play-services-ads-identifier:18.0.1 "MavenのAARアーティファクトへのリンク。")して`Assets/Plugins/Android`ディレクトリに追加してください。 -{% /tab %} -{% /tabs %} +\{% /tab %\} +\{% /tabs %\} -### アプリセットIDを収集する {% #collect-app-set-identifier %} +### アプリセットIDを収集する \{% \#collect\-app\-set\-identifier %\} [アプリセットID](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId) は、ユーザーがデバイスにインストールしたアプリの情報を計測するための一意の識別子です。同じ開発者のアプリは全て同じアプリセットIDを共有しているため、全てのアプリのユーザーから有意義なインサイトを収集できます。 -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} デバイスのApp Set IDを記録するには、以下のdependencyを`Dependencies.xml`ファイルに追加する必要があります。 ```xml @@ -116,12 +121,13 @@ ARR(Android Archive)を手動でインストールするには、[Mavenか ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} ARR(Android Archive)を手動でインストールするには、[Mavenからダウンロード](https://maven.google.com/web/index.html#com.google.android.gms:play-services-appset:16.0.2 "MavenのAARアーティファクトへのリンク。")して`Assets/Plugins/Android`ディレクトリに追加してください。 -{% /tab %} -{% /tabs %} +\{% /tab %\} +\{% /tabs %\} ### インストールリファラーを設定する @@ -129,8 +135,8 @@ ARR(Android Archive)を手動でインストールするには、[Mavenか Google Play Referrer APIをサポートするには、以下の2つの方法があります。 -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} [カスタム`build.gradle`ファイル](https://docs.unity3d.com/2023.1/Documentation/Manual/android-gradle-overview.html)に、インストールリファラーライブラリをdependencyとして追加します。 ```groovy @@ -138,22 +144,25 @@ dependencies { implementation 'com.android.installreferrer:installreferrer:2.2' } ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} [Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer)からインストールリファラーライブラリをダウンロードし、ARR(Android Archive)ファイルを`Plugins/Android`フォルダーに入れてください。 -{% /tab %} -{% /tabs %} +\{% /tab %\} +\{% /tabs %\} #### Metaとのリファラー連携 -Adjust SDKは、Adjust Metaインストールリファラープラグインを使用して[Metaインストールリファラー](https://developers.facebook.com/docs/app-ads/meta-install-referrer)をサポートしています。[連携の詳細については、Metaインストール リファラープラグインをご覧ください](/ja/sdk/unity/plugins/meta-referrer-plugin)。 +Adjust SDKは、Adjust Metaインストールリファラープラグインを使用して[Metaインストールリファラー](https://developers.facebook.com/docs/app-ads/meta-install-referrer)をサポートしています。[連携の詳細については、Metaインストール リファラープラグインをご覧ください](/en/sdk/unity/plugins/meta-referrer-plugin)。 -## 5. SDKシグネチャーを設定する {% #set-up-sdk-signature %} +5\. SDKシグネチャーを設定する \{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------------- -Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/ja/article/sdk-signature)の手順に従ってください。 +Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/en/article/sdk-signature)の手順に従ってください。 -## 6. アプリをビルドする {% #build-your-app %} +6\. アプリをビルドする \{% \#build\-your\-app %\} +---------------------------------------------- アプリのビルドプロセスを完了し、アプリ内でAdjust SDKが動作することを確実にするため、Adjust Unityのパッケージはポストビルドを実行します。 このプロセスは、`AdjustEditor.cs`の`OnPostprocessBuild`メソッドによって実行されます。 @@ -161,17 +170,17 @@ Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグ ![UnityエディターのAdjust SDK ポストビルド構成スクリプト](@images/unity/2-postbuild.png) -{% tabs %} -{% tab title="iOS" icon="PlatformIos" %} -{% callout type="important" %} +\{% tabs %\} +\{% tab title="iOS" icon="PlatformIos" %\} +\{% callout type="important" %\} iOSポストビルドプロセスを実行するには、Unityエディターに **iOSビルドサポート** がインストールされていることを確認してください。 -{% /callout %} +\{% /callout %\} iOSのポストビルドプロセスは、生成したXcodeプロジェクトを次のように変更します。 -* Objective-C exceptionsを有効にします。 +* Objective\-C exceptionsを有効にします。 -#### フレームワーク {% #frameworks %} +#### フレームワーク \{% \#frameworks %\} iOS機能にアクセスするために、以下のフレームワークを有効にすることができます。 @@ -180,23 +189,22 @@ iOS機能にアクセスするために、以下のフレームワークを有 * `AppTrackingTransparency.framework`: ユーザーに計測への同意を求め、その同意ステータスを取得するために必要。 * `StoreKit.framework`: SKAdNetworkフレームワークとの通信に必要。 -#### AppTrackingTransparencyの同意ダイアログ {% #app-tracking-transparency-consent-dialog %} +#### AppTrackingTransparencyの同意ダイアログ \{% \#app\-tracking\-transparency\-consent\-dialog %\} ATT(App Tracking Transparency)ラッパーを使用している場合は、 **User Tracking Description** メッセージを入力します。このメッセージは、ATT同意ダイアログをユーザーに示す場合に表示されます。 -#### ディープリンク {% #deep-linking %} +#### ディープリンク \{% \#deep\-linking %\} ディープリンクを有効化するには、次の情報を追加します。 * **iOSユニバーサルリンクドメイン** :ユニバーサルリンクに使用されるAssociated Domain。 * **iOS URL Identifier** :アプリのバンドルID。 -* \**iOS URLスキーム*\* :アプリに関連するURLスキーム。 -{% /tab %} +* **iOS URLスキーム** :アプリに関連するURLスキーム。 \{% /tab %\} -{% tab title="Android" icon="PlatformAndroid" %} +\{% tab title="Android" icon="PlatformAndroid" %\} Androidのポストビルドプロセスは、 `Assets/Plugins/Android/`内の `AndroidManifest.xml`ファイルを確認します。このファイルが存在しない場合、[`AdjustAndroidManifest.xml`](https://github.com/adjust/unity_sdk/blob/master/Assets/Adjust/Native/Android/AdjustAndroidManifest.xml "GitHubのAdjustAndroidManifestファイルへのリンク")からコピーを作成します。 -#### パーミッション {% #permissions %} +#### パーミッション \{% \#permissions %\} Android機能にアクセスするには、以下のパーミッションを有効にしてください。 @@ -205,30 +213,31 @@ Android機能にアクセスするには、以下のパーミッションを有 * `com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE` **(廃止済み)** :Google Play Storeインテント経由でインストールリファラー情報を取得するのに必要 * `com.google.android.gms.permission.AD_ID`: 詳細は、[Googleの`AdvertisingIdClient.info`ドキュメント](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)を参照してください。 -#### ディープリンク {% #deep-linking-1 %} +#### ディープリンク \{% \#deep\-linking\-1 %\} ディープリンクを有効化するには、次の情報を追加します。 **Android URIスキーム** :ディープリンクの遷移先。 -{% /tab %} -{% /tabs %} +\{% /tab %\}\{% /tabs %\} プロセスの出力は、Unity IDEコンソールウィンドウに表示されます。 -## 7. 連携をテストする {% #test-your-integration %} +7\. 連携をテストする \{% \#test\-your\-integration %\} +---------------------------------------------------- -{% callout type="tip" %} +\{% callout type="tip" %\} 問題が発生した場合は、全ての詳細情報とログを添付し、[support@adjust.com](mailto:support@adjust.com)までメールをお送りください。 -{% /callout %} +\{% /callout %\} Adjust SDKは、実装をテストとトラブルシューティングのためのツールを提供します。以下の手順に従って、実装をテストしてください。 * 環境を`AdjustEnvironment.Sandbox`に設定します。 * Adjustダッシュボードにサンドボックスフィルターを追加します。 -* [ログレベル](/ja/sdk/unity/configuration#set-your-logging-level)を`AdjustLogLevel.Verbose`に設定します。 +* [ログレベル](/en/sdk/unity/configuration#set-your-logging-level)を`AdjustLogLevel.Verbose`に設定します。 -### Google Play 開発者サービスの連携をテストする {% #test-google-play-services-integration %} +### Google Play 開発者サービスの連携をテストする \{% \#test\-google\-play\-services\-integration %\} -Adjust SDKがデバイスのGoogle広告IDを受信できるかどうかテストするには、[ログレベル](/ja/sdk/unity/configuration#set-your-logging-level)を`AdjustLogLevel.Verbose`に、環境を`AdjustEnvironment.Sandbox`に設定します。アプリを起動して`session`またはイベントを計測します。SDKが広告IDを読み取った場合、SDKはgps_adid(Google Play 開発者サービス広告ID)パラメーターをログに記録します。 +Adjust SDKがデバイスのGoogle広告IDを受信できるかどうかテストするには、[ログレベル](/en/sdk/unity/configuration#set-your-logging-level)を`AdjustLogLevel.Verbose`に、環境を`AdjustEnvironment.Sandbox`に設定します。アプリを起動して`session`またはイベントを計測します。SDKが広告IDを読み取った場合、SDKはgps\_adid(Google Play 開発者サービス広告ID\)パラメーターをログに記録します。 Google広告IDを取得する際に問題が発生した場合は、[Githubリポジトリ](https://github.com/adjust/unity_sdk)で質問を投稿するか、[support@adjust.com](mailto:support@adjust.com)までお問い合わせください。 + diff --git a/src/content/docs/ja/sdk/unity/v5/plugins/index.mdoc b/src/content/docs/ja/sdk/unity/v5/plugins/index.mdoc new file mode 100644 index 000000000..e6b4da6b0 --- /dev/null +++ b/src/content/docs/ja/sdk/unity/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "サードパーティプラグイン" +description: "サードパーティSDKからAdjustに情報をパスするには、サードパーティプラグインを使用します。" +category-title: "プラグイン" +slug: "en/sdk/unity/plugins" +type: "category" +sidebar-position: 4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/unity/v4/plugins" +--- +プラグインを使用して、サードパーティのプラグインに情報をパスします。 + diff --git a/src/content/docs/ja/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc b/src/content/docs/ja/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc new file mode 100644 index 000000000..47d729ed2 --- /dev/null +++ b/src/content/docs/ja/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc @@ -0,0 +1,49 @@ +--- +title: "Meta インストールリファラー" +description: "Metaインストールリファラープラグインを使用して、 Metaインストールリファラー情報をAdjustに送信します。" +slug: "en/sdk/unity/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/unity/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +[Metaの要件](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)により、Adjust SDKは``エレメントをバンドルしています。これらを`AndroidManifest.xml`に追加する必要はありません。 +\{% /callout %\} + +Metaインストールリファラープラグインは、Adjust SDKがデバイス上のMetaインストールリファラー値を読み取ることを可能にします。その後、SDKはこの情報をインストールペイロードの一部として、Adjustサーバーに送信します。 + +プラグインをアプリに追加する方法: + +1. `Dependencies.xml`ファイルに以下のdependencyを追加します: + + ```xml + + ``` + + または、Android Studioで`build.gradle`ファイルに以下のdependencyを追加することもできます。 + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. [App Dashboard](https://developers.facebook.com/apps)でMetaアプリIDを検索します。詳しくはMetaの[アプリダッシュボードのドキュメント](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)をご覧ください。 + +3. `AdjustConfig`インスタンスの`FbAppId`プロパティにアプリIDを割り当てます。 + + ```cs + AdjustConfig config = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); + //... + config.FbAppId = "{FB_APP_ID_STRING}"; + //... + Adjust.InitSdk(config); + ``` + diff --git a/src/content/docs/ko/sdk/android/v5/index.mdoc b/src/content/docs/ko/sdk/android/v5/index.mdoc index 1bd6f538f..44c0c3d81 100644 --- a/src/content/docs/ko/sdk/android/v5/index.mdoc +++ b/src/content/docs/ko/sdk/android/v5/index.mdoc @@ -1,26 +1,28 @@ --- -title: Android SDK 연동 가이드 -description: Android SDK를 사용하여 Android 앱에서 Adjust의 기능에 액세스 -category-title: Android SDK -slug: ko/sdk/android +title: "Android SDK 연동 가이드" +description: "Android SDK를 사용하여 Android 앱에서 Adjust의 기능에 액세스" +category-title: "Android SDK" +slug: "en/sdk/android" sidebar-position: 1 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ko/sdk/android/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/android/v4" --- - Adjust Android SDK를 사용하면 Android 앱에서의 어트리뷰션, 이벤트 등을 기록할 수 있습니다. 본 가이드의 단계를 수행하여 Adjust SDK와 연동되도록 앱을 설정하시기 바랍니다. -{% callout type="important" %} -Adjust SDK는 Android API level 21(Lollipop) 이상을 지원합니다. -{% /callout %} +\{% callout type="important" %\} +Adjust SDK는 Android API level 21\(Lollipop\) 이상을 지원합니다. +\{% /callout %\} -## 1. 환경 설정 {% #set-up-your-environment %} +1\. 환경 설정 \{% \#set\-up\-your\-environment %\} +----------------------------------------------------- Adjust SDK를 사용하려면 프로젝트에 Adjust SDK를 디펜던시로 추가해야 합니다. Adjust SDK는 [Maven](https://maven.apache.org)에서 사용 가능합니다. @@ -37,9 +39,10 @@ Adjust SDK를 사용하려면 프로젝트에 Adjust SDK를 디펜던시로 추 } ``` -## 2. Google 플레이 서비스 추가 {% #add-google-play-services %} +2\. Google 플레이 서비스 추가 \{% \#add\-google\-play\-services %\} +------------------------------------------------------------------ -Google 플레이 스토어를 타겟으로 하는 앱은 기기 식별을 위해 `gps_adid`(Google 광고 ID)를 사용해야 합니다. `gps_adid`에 액세스하기 위해 프로젝트에 `play-services-ads-identifier` AAR을 추가해야 합니다. +Google 플레이 스토어를 타겟으로 하는 앱은 기기 식별을 위해 `gps_adid`\(Google 광고 ID\)를 사용해야 합니다. `gps_adid`에 액세스하기 위해 프로젝트에 `play-services-ads-identifier` AAR을 추가해야 합니다. Maven을 사용하는 경우, `build.gradle` 파일에 다음을 추가합니다. @@ -49,7 +52,8 @@ dependencies { } ``` -## 3. 권한 추가 {% #add-permissions %} +3\. 권한 추가 \{% \#add\-permissions %\} +----------------------------------------- Adjust SDK에 기기 정보에 대한 액세스 권한을 부여하려면 앱에서 요구하는 권한을 선언해야 합니다. 이를 위해 `AndroidManifest.xml` 파일에 권한을 추가합니다. @@ -66,13 +70,14 @@ Adjust SDK에 기기 정보에 대한 액세스 권한을 부여하려면 앱에 ``` -Adjust SDK에는 `com.google.android.gms.AD_ID` 권한이 기본값으로 포함됩니다. 앱이 COPPA(Children's Online Privacy Protection Act, 어린이 온라인 개인정보 보호법) 준수 대상이거나 Google 플레이 스토어를 타겟으로하지 않는 경우 `remove`를 사용하여 이 권한을 삭제해야 합니다. +Adjust SDK에는 `com.google.android.gms.AD_ID` 권한이 기본값으로 포함됩니다. 앱이 COPPA\(Children's Online Privacy Protection Act, 어린이 온라인 개인정보 보호법\) 준수 대상이거나 Google 플레이 스토어를 타겟으로하지 않는 경우 `remove`를 사용하여 이 권한을 삭제해야 합니다. ```xml ``` -## 4. Proguard 설정 {% #set-up-proguard %} +4\. Proguard 설정 \{% \#set\-up\-proguard %\} +------------------------------------------------- 앱 최적화를 위해 Proguard를 사용하는 경우 Proguard가 클래스를 삭제하는 것을 방지하는 규칙을 추가해야 합니다. @@ -97,11 +102,12 @@ Google 플레이 스토어에서 앱을 게시하지 않는 경우 다음의 규 -keep public class com.adjust.sdk.** { *; } ``` -## 5. 설치 리퍼러 설정 {% #set-up-install-referrer %} +5\. 설치 리퍼러 설정 \{% \#set\-up\-install\-referrer %\} +--------------------------------------------------------- 설치 리퍼러는 설치를 소스에 어트리뷰션하는 데 사용할 수 있는 고유한 식별자입니다. Adjust SDK는 어트리뷰션을 위해 이 정보가 필요합니다. 다음 메서드 중 하나를 사용하여 설치 리퍼러 정보를 조회하시기 바랍니다. -### Google Play Referrer API {% #google-play-referrer-api %} +### Google Play Referrer API \{% \#google\-play\-referrer\-api %\} Google Play 리퍼러 API는 Google 플레이 스토어를 타겟으로 하는 앱에서 사용할 수 있습니다. @@ -119,7 +125,7 @@ Proguard를 사용하는 경우 dependency가 삭제되는 것을 방지하는 -keep public class com.android.installreferrer.** { *; } ``` -### Huawei 리퍼러 API {% #huawei-referrer-api %} +### Huawei 리퍼러 API \{% \#huawei\-referrer\-api %\} Huawei 리퍼러 API는 Huawei 기기를 타겟으로 하는 앱에서 사용할 수 있습니다. Adjust SDK는 Adjust Huawei 리퍼러 플러그인을 사용하는 Huawei 기기에서의 설치를 기록할 수 있습니다. @@ -131,36 +137,38 @@ dependencies { } ``` -### Xiaomi 리퍼러 플러그인 {% #xiaomi-referrer-plugin %} +### Xiaomi 리퍼러 플러그인 \{% \#xiaomi\-referrer\-plugin %\} -Xiaomi 리퍼러 플러그인을 사용하면 Xiaomi 기기를 타겟으로 하는 앱의 설치 리퍼러 값을 기록할 수 있습니다. 자세한 설치 방법은 [플러그인 문서](/ko/sdk/android/plugins/xiaomi-referrer)를 참조하시기 바랍니다. +Xiaomi 리퍼러 플러그인을 사용하면 Xiaomi 기기를 타겟으로 하는 앱의 설치 리퍼러 값을 기록할 수 있습니다. 자세한 설치 방법은 [플러그인 문서](/en/sdk/android/plugins/xiaomi-referrer)를 참조하시기 바랍니다. -### 삼성 리퍼러 플러그인 {% #samsung-referrer-plugin %} +### 삼성 리퍼러 플러그인 \{% \#samsung\-referrer\-plugin %\} -Samsung 리퍼러 플러그인을 사용하면 Samsung Galaxy 스토어를 타겟으로 하는 앱의 설치 리퍼러 값을 기록할 수 있습니다. 자세한 설치 방법은 [플러그인 문서](/ko/sdk/android/plugins/samsung-referrer-plugin)를 참조하시기 바랍니다. +Samsung 리퍼러 플러그인을 사용하면 Samsung Galaxy 스토어를 타겟으로 하는 앱의 설치 리퍼러 값을 기록할 수 있습니다. 자세한 설치 방법은 [플러그인 문서](/en/sdk/android/plugins/samsung-referrer-plugin)를 참조하시기 바랍니다. -### Meta 리퍼러 연동 {% #meta-referrer-integration %} +### Meta 리퍼러 연동 \{% \#meta\-referrer\-integration %\} -Adjust SDK는 Adjust Meta 설치 리퍼러 플러그인을 사용하는 [Meta 설치 리퍼러](https://developers.facebook.com/docs/app-ads/meta-install-referrer)를 지원합니다. [연동 세부 정보에 관한 문서를 참조하시기 바랍니다](/ko/sdk/android/plugins/meta-referrer-plugin). +Adjust SDK는 Adjust Meta 설치 리퍼러 플러그인을 사용하는 [Meta 설치 리퍼러](https://developers.facebook.com/docs/app-ads/meta-install-referrer)를 지원합니다. [연동 세부 정보에 관한 문서를 참조하시기 바랍니다](/en/sdk/android/plugins/meta-referrer-plugin). -## 6. SDK 서명 설정 {% #set-up-sdk-signature %} +6\. SDK 서명 설정 \{% \#set\-up\-sdk\-signature %\} +------------------------------------------------------ -Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/ko/article/sdk-signature)의 지침을 따르시기 바랍니다. +Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/en/article/sdk-signature)의 지침을 따르시기 바랍니다. -## 7. Adjust SDK 연동 {% #integrate-the-adjust-sdk %} +7\. Adjust SDK 연동 \{% \#integrate\-the\-adjust\-sdk %\} +-------------------------------------------------------------- Adjust SDK를 초기화하려면 다음 정보가 필요합니다. -* `appToken`: [Adjust 앱 토큰](https://help.adjust.com/ko/article/app-settings#view-your-app-token)입니다. +* `appToken`: [Adjust 앱 토큰](https://help.adjust.com/en/article/app-settings#view-your-app-token)입니다. * `environment`: 앱이 실행 중인 환경. 로컬에서 앱을 테스트하려면 이 값을 `AdjustConfig.ENVIRONMENT_SANDBOX` 로 설정하시기 바랍니다. Adjust SDK를 초기화하는 권장 방식은 글로벌 Android [애플리케이션 클래스](http://developer.android.com/reference/android/app/Application.html)에서 수행하는 것입니다. 아직 설정하지 않은 경우 다음 단계에 따라 앱을 설정하시기 바랍니다. 1. `Application`을 확장하는 클래스를 생성합니다. -1. `AndroidManifest.xml` 파일을 열고 `` 요소를 찾습니다. +2. `AndroidManifest.xml` 파일을 열고 `` 요소를 찾습니다. -1. `` 요소에 `android:name` 어트리뷰션을 추가하고 애플리케이션 클래스의 이름으로 설정합니다. 예를 들어 `Application` 클래스 이름이 `GlobalApplication`인 경우 다음과 같이 설정합니다. +3. `` 요소에 `android:name` 어트리뷰션을 추가하고 애플리케이션 클래스의 이름으로 설정합니다. 예를 들어 `Application` 클래스 이름이 `GlobalApplication`인 경우 다음과 같이 설정합니다. ```xml @@ -168,14 +176,14 @@ Adjust SDK를 초기화하는 권장 방식은 글로벌 Android [애플리케 ``` -1. `Application` 클래스에서 `initSdk` 메서드를 찾거나 존재하지 않는 경우 메서드를 추가합니다. 다음 파라미터를 전달하여 Adjust SDK를 초기화합니다. +4. `Application` 클래스에서 `initSdk` 메서드를 찾거나 존재하지 않는 경우 메서드를 추가합니다. 다음 파라미터를 전달하여 Adjust SDK를 초기화합니다. * 고객사 전담팀 `appToken` * 앱을 실행할 `environment` * 기록할 `LogLevel` -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\} \{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; @@ -192,9 +200,11 @@ class GlobalApplication : Application () { } } ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; @@ -212,25 +222,25 @@ public class GlobalApplication extends Application { } } ``` -{% /tab %} -{% /tabs %} -### Adjust 웹뷰 SDK 연동 {% #integrate-the-adjust-web-view-sdk %} +\{% /tab %\} \{% /tabs %\} + +### Adjust 웹뷰 SDK 연동 \{% \#integrate\-the\-adjust\-web\-view\-sdk %\} 앱이 웹뷰를 사용하는 경우 Adjust 웹뷰 SDK를 사용하여 정보를 기록해야 합니다. 먼저 `WebView` 객체에 대한 레퍼런스를 얻은 후에 다음 단계를 수행합니다. 1. `webView.getSettings().setJavaScriptEnabled(true)`를 호출하여 웹뷰에서 자바스크립트를 활성화합니다. -1. `AdjustBridge.registerAndGetInstance(getApplication(), webview)`를 호출하여 디폴트 `AdjustBridgeInstance`를 시작합니다. 이는 Adjust 브릿지를 웹뷰에서 자바스크립트 인터페이스로 등록합니다. +2. `AdjustBridge.registerAndGetInstance(getApplication(), webview)`를 호출하여 디폴트 `AdjustBridgeInstance`를 시작합니다. 이는 Adjust 브릿지를 웹뷰에서 자바스크립트 인터페이스로 등록합니다. + +3. `AdjustBridge.setWebView()`를 호출하여 새로운`WebView`를 설정합니다. -1. `AdjustBridge.setWebView()`를 호출하여 새로운`WebView`를 설정합니다. +4. `AdjustBridge.unregister()`를 호출하여 `AdjustBridgeInstance` 및 `WebView`의 등록을 취소합니다. -1. `AdjustBridge.unregister()`를 호출하여 `AdjustBridgeInstance` 및 `WebView`의 등록을 취소합니다. +5. 전체 설정에 대한 예시는 다음과 같습니다. -1. 전체 설정에 대한 예시는 다음과 같습니다. + \{% tabs %\} \{% tab title="Kotlin" sync="kotlin" %\} - {% tabs %} - {% tab title="Kotlin" sync="kotlin" %} ```kotlin class MainActivity : Activity() { override fun onCreate(savedInstanceState: Bundle?) { @@ -257,9 +267,11 @@ public class GlobalApplication extends Application { } } ``` - {% /tab %} - {% tab title="Java" sync="java" %} + \{% /tab %\} + + \{% tab title="Java" sync="java" %\} + ```java public class MainActivity extends Activity { @Override @@ -288,10 +300,9 @@ public class GlobalApplication extends Application { } } ``` - {% /tab %} - {% /tabs %} -1. HTML로 Adjust 자바스크립트 파일을 가져옵니다. + \{% /tab %\} \{% /tabs %\} +6. HTML로 Adjust 자바스크립트 파일을 가져옵니다. ```html @@ -300,7 +311,7 @@ public class GlobalApplication extends Application { ``` -1. 이제 `appToken` 및 `environment`를 `AdjustConfig` 클래스로 전달하여 웹뷰에서 Adjust SDK를 초기화할 수 있습니다. +7. 이제 `appToken` 및 `environment`를 `AdjustConfig` 클래스로 전달하여 웹뷰에서 Adjust SDK를 초기화할 수 있습니다. ```js let yourAppToken = "{YourAppToken}"; @@ -310,15 +321,16 @@ public class GlobalApplication extends Application { Adjust.initSdk(adjustConfig); ``` -## 8. 프로덕션을 위한 앱 빌드 {% #build-your-app-for-production %} +8\. 프로덕션을 위한 앱 빌드 \{% \#build\-your\-app\-for\-production %\} +--------------------------------------------------------------------- 테스트를 완료한 후에 프로덕션을 위한 앱을 빌드할 수 있습니다. 이를 위해 config 객체를 업데이트해야 합니다. 1. 필요한 항목만 반환하도록 로그 수준을 조정합니다. -1. `environment`를 `AdjustConfig.ENVIRONMENT_PRODUCTION`로 설정합니다. +2. `environment`를 `AdjustConfig.ENVIRONMENT_PRODUCTION`로 설정합니다. + +\{% tabs %\} \{% tab title="Kotlin" sync="kotlin" %\} -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} ```kotlin val appToken = "{YourAppToken}" val environment = AdjustConfig.ENVIRONMENT_PRODUCTION; @@ -326,9 +338,11 @@ val config = AdjustConfig(this, appToken, environment) config.setLogLevel(LogLevel.WARN) Adjust.initSdk(config) ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java String appToken = "{YourAppToken}"; String environment = AdjustConfig.ENVIRONMENT_PRODUCTION; @@ -336,5 +350,6 @@ AdjustConfig config = new AdjustConfig(this, appToken, environment); config.setLogLevel(LogLevel.WARN) Adjust.initSdk(config); ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\} \{% /tabs %\} + diff --git a/src/content/docs/ko/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc b/src/content/docs/ko/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc index e28ef5744..9f5c79ded 100644 --- a/src/content/docs/ko/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc +++ b/src/content/docs/ko/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc @@ -1,30 +1,33 @@ --- -title: 삼성 리퍼러 -description: 삼성 리퍼러 플러그인을 사용하여 삼성 정보를 Adjust로 전달합니다. -slug: ko/sdk/android/plugins/samsung-referrer-plugin -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ko/sdk/android/v4/plugins/samsung-referrer-plugin +title: "삼성 리퍼러" +description: "삼성 리퍼러 플러그인을 사용하여 삼성 정보를 Adjust로 전달합니다." +slug: "en/sdk/android/plugins/samsung-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/android/v4/plugins/samsung-referrer-plugin" --- - 삼성 리퍼러 플러그인은 Adjust SDK가 디바이스에서 삼성 갤럭시 스토어 설치 리퍼러 값을 읽을 수 있도록 해줍니다. SDK는 해당 정보를 설치 페이로드의 일부로서 Adjust 서버에 전송합니다. 삼성 설치 리퍼러는 삼성 설치 리퍼러 라이브러리를 사용하는 모든 기기에서 이용 가능합니다. -## 시작에 앞서 {% #before-you-begin %} +시작에 앞서 \{% \#before\-you\-begin %\} +---------------------------------------- -앱에 Adjust SDK를 연동하려면 [시작 가이드](/ko/sdk/android)를 참조하시기 바랍니다. +앱에 Adjust SDK를 연동하려면 [시작 가이드](/en/sdk/android)를 참조하시기 바랍니다. -## 삼성 리퍼러 플러그인 설치하기 {% #install-the-samsung-referrer-plugin %} +삼성 리퍼러 플러그인 설치하기 \{% \#install\-the\-samsung\-referrer\-plugin %\} +------------------------------------------------------------------------- 삼성 리퍼러 플러그인은 두 가지 방식으로 설치할 수 있습니다. -### Maven {% #maven %} +### Maven \{% \#maven %\} Adjust SDK 선언 아래의 `build.gradle` 파일에 다음의 디펜던시를 추가합니다. @@ -33,11 +36,12 @@ implementation 'com.adjust.sdk:adjust-android:{% $versions.android.v5 %}' implementation 'com.adjust.sdk:adjust-android-samsung-referrer:{% $versions.android.v5 %}' ``` -### JAR {% #jar %} +### JAR \{% \#jar %\} 삼성 리퍼러 플러그인은 GitHub [릴리스 페이지](https://github.com/adjust/android_sdk/releases/latest)에서 이용할 수 있습니다. -## 삼성 설치 리퍼러 라이브러리 추가 {% #add-the-samsung-install-referrer-library %} +삼성 설치 리퍼러 라이브러리 추가 \{% \#add\-the\-samsung\-install\-referrer\-library %\} +---------------------------------------------------------------------------------- 리퍼러 값을 읽으려면 삼성 설치 리퍼러를 반드시 앱에 추가해야 합니다. 자세한 정보는 삼성 담당자 또는 [support@samsungdevelopers.com](mailto:support@samsungdevelopers.com)으로 문의주시기 바랍니다. @@ -47,7 +51,8 @@ implementation 'com.adjust.sdk:adjust-android-samsung-referrer:{% $versions.andr implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:3.0.1' ``` -## Proguard 설정 {% #proguard-settings %} +Proguard 설정 \{% \#proguard\-settings %\} +-------------------------------------------- Proguard를 사용하는 경우, 빌드 중 중요한 클래스가 삭제되지 않도록 반드시 규칙을 추가해야 합니다. @@ -63,42 +68,48 @@ Proguard를 사용하는 경우, 빌드 중 중요한 클래스가 삭제되지 -keep class com.sec.android.app.samsungapps.installreferrer.** { *; } ``` -## 플러그인 사용 {% #use-the-plugin %} +플러그인 사용 \{% \#use\-the\-plugin %\} +--------------------------------------- 삼성 리퍼러 플러그인은 기본값에 따라 **활성화** 되어 있습니다. `AdjustSamsungReferrer` 클래스 메서드를 사용하여 삼성 설치 리퍼러 정보 읽기를 켜거나 끌 수 있습니다. 설치 리퍼러 읽기를 **비활성화** 하려면 SDK 초기화 **전에** `AdjustSamsungReferrer.doNotReadSamsungReferrer()`를 호출합니다. -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\} \{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin AdjustSamsungReferrer.doNotReadSamsungReferrer() Adjust.initSdk(adjustConfig) ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java AdjustSamsungReferrer.doNotReadSamsungReferrer(); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\} \{% /tabs %\} 설치 리퍼러 읽기를 **재활성화** 하려면 SDK 초기화 **전에** `AdjustSamsungReferrer.readSamsungReferrer(applicationContext)` 를 호출합니다. -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\} \{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin AdjustSamsungReferrer.readSamsungReferrer(applicationContext) Adjust.initSdk(adjustConfig) ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java AdjustSamsungReferrer.readSamsungReferrer(applicationContext); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\} \{% /tabs %\} + diff --git a/src/content/docs/ko/sdk/cordova/v5/index.mdoc b/src/content/docs/ko/sdk/cordova/v5/index.mdoc index d8032df7d..665dca990 100644 --- a/src/content/docs/ko/sdk/cordova/v5/index.mdoc +++ b/src/content/docs/ko/sdk/cordova/v5/index.mdoc @@ -1,26 +1,28 @@ --- -title: Cordova SDK 연동 가이드 -description: Use the Cordova SDK to access Adjust's features in your Cordova apps -category-title: Cordova SDK -slug: ko/sdk/cordova +title: "Cordova SDK 연동 가이드" +description: "Cordova SDK를 사용하여 Cordova 앱에서 Adjust 기능에 액세스" +category-title: "Cordova SDK" +slug: "en/sdk/cordova" sidebar-position: 6 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ko/sdk/cordova/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/cordova/v4" --- - Adjust Cordova SDK를 사용하면 Cordova 앱에서의 어트리뷰션, 이벤트 등을 측정할 수 있습니다. 본 가이드의 단계를 수행하여 Adjust SDK와 연동되도록 앱을 설정하시기 바랍니다. 이에 대한 예시는 [GitHub](https://github.com/adjust/cordova_sdk/tree/master/example-cordova)에서 확인하실 수 있습니다. -## 1. 프로젝트에 SDK 추가 {% #add-the-sdk-to-your-project %} +1\. 프로젝트에 SDK 추가 \{% \#add\-the\-sdk\-to\-your\-project %\} +-------------------------------------------------------------------- -Adjust Cordova SDK는 npm에서 플러그인으로 이용 가능합니다. 프로젝트에 추가하려면 다음을 수행하시기 바랍니다. +Adjust Cordova SDK는 npm에서 플러그인으로 이용 가능합니다. 프로젝트에 추가하려면 다음을 수행하시기 바랍니다. -### Cordova plugin +### Cordova 플러그인 Cordova 플러그인에 Adjust Cordova SDK를 추가하려면 다음 명령을 실행합니다. @@ -33,18 +35,19 @@ Installing "com.adjust.sdk" for ios ### Ionic -If you use Ionic to build your app, add the SDK and its TypeScript typings from the [`awesome-cordova-plugins` repository](https://github.com/danielsogl/awesome-cordova-plugins) by running the following commands: +앱을 빌드할 때 Ionic을 사용하는 경우 다음 명령을 실행하여 [`awesome-cordova-plugins` 리포지토리](https://github.com/danielsogl/awesome-cordova-plugins)로부터 SDK를 추가합니다. ```console > npm install @awesome-cordova-plugins/adjust --save > ionic cordova plugin add com.adjust.sdk ``` -## 2. Android 기기 설정 {% #set-up-android-devices %} +2\. Android 기기 설정 \{% \#set\-up\-android\-devices %\} +------------------------------------------------------------ -### 권한 추가 {% #add-permissions %} +### 권한 추가 \{% \#add\-permissions %\} -The Adjust SDK includes the `com.google.android.gms.AD_ID` and `android.permission.INTERNET` permissions by default. You can remove the `AD_ID` permission by adding a `remove` directive if need to make your app COPPA-compliant or if you don't target the Google Play Store. +Adjust SDK에는 `com.google.android.gms.AD_ID` 권한이 기본값으로 포함됩니다. 앱이 COPPA 준수 대상이거나 Google 플레이 스토어를 타겟으로 하지 않는 경우, `android.permission.INTERNET`를 추가하여 이 권한을 제거할 수 있습니다. ```xml @@ -52,43 +55,45 @@ The Adjust SDK includes the `com.google.android.gms.AD_ID` and `android.permissi ``` -{% callout type="seealso" %} -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 about this permission. -{% /callout %} - -### 설치 리퍼러 설정 {% #set-up-install-referrer %} +\{% callout type="seealso" %\} +이 권한에 대한 자세한 내용은 Google의 [`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)을 참조하시기 바랍니다. +\{% /callout %\} -The Adjust SDK enables support for the [Google Play Referrer API](https://developer.android.com/google/play/installreferrer) by default. The Meta Install Referrer is available as a plugin for Android. [See the Cordova Meta Install Referrer plugin for integration details](/ko/sdk/cordova/plugins/meta-referrer-plugin). +### 설치 리퍼러 설정 \{% \#set\-up\-install\-referrer %\} -## 3. iOS 프레임워크 추가 {% #add-ios-frameworks %} +Adjust SDK는 기본 설정에 따라 [Google Play Referrer API](https://developer.android.com/google/play/installreferrer) 에 대한 지원을 활성화합니다. Meta 설치 리퍼러는 Android용 플러그인으로 이용 가능합니다. [연동에 대한 자세한 내용은 Cordova Meta 설치 리퍼러 플러그인 페이지를 참조하시기 바랍니다](/en/sdk/cordova/plugins/meta-referrer-plugin). -The Adjust SDK automatically links the frameworks listed below on iOS devices. +3\. iOS 프레임워크 추가 \{% \#add\-ios\-frameworks %\} +----------------------------------------------------- -| 프레임워크 | 설명 | 참고 사항 | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `AdSupport.framework` | 디바이스 IDFA에 대한 액세스와, iOS 14 이하 버전의 기기에서 LAT에 대한 액세스도 활성화합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | -| `AdServices.framework` | Apple 검색 광고 어트리뷰션 처리 | | -| `StoreKit.framework` | SKAdNetwork 프레임워크에 대한 액세스 활성화 | Adjust SDK가 iOS 14 이상 버전의 기기에서 SKAdNetwork와의 커뮤니케이션을 처리하도록 허용하기 위해 필요합니다. | -| `AppTrackingTransparency.framework` | Adjust SDK가 iOS 14 이상 버전의 기기에서 사용자 트래킹 동의 다이얼로그 및 액세스 동의 응답을 래핑하도록 허용하기 위해 필요합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | +Adjust SDK는 iOS 기기에서 아래의 프레임워크를 자동으로 연결합니다. -## 4. SDK 서명 설정 {% #set-up-sdk-signature %} +| 프레임워크 | 설명 | 참고 사항 | +|-------------------------------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| `AdSupport.framework` | 디바이스 IDFA에 대한 액세스와, iOS 14 이하 버전의 기기에서 LAT에 대한 액세스도 활성화합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | +| `AdServices.framework` | Apple 검색 광고 어트리뷰션 처리 | | +| `StoreKit.framework` | SKAdNetwork 프레임워크에 대한 액세스 활성화 | Adjust SDK가 iOS 14 이상 버전의 기기에서 SKAdNetwork와의 커뮤니케이션을 처리하도록 허용하기 위해 필요합니다. | +| `AppTrackingTransparency.framework` | Adjust SDK가 iOS 14 이상 버전의 기기에서 사용자 트래킹 동의 다이얼로그 및 액세스 동의 응답을 래핑하도록 허용하기 위해 필요합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | -Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/ko/article/sdk-signature)의 지침을 따르시기 바랍니다. +4\. SDK 서명 설정 \{% \#set\-up\-sdk\-signature %\} +------------------------------------------------------ -## 5. Adjust SDK 초기화 {% #initialize-the-adjust-sdk %} +Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/en/article/sdk-signature)의 지침을 따르시기 바랍니다. -{% callout type="important" %} -When running tests you should ensure that your environment is set to `AdjustConfig.EnvironmentSandbox`. Change this to `AdjustConfig.EnvironmentProduction` before you submit your application to the app store. -{% /callout %} +5\. Adjust SDK 초기화 \{% \#initialize\-the\-adjust\-sdk %\} +---------------------------------------------------------------- -Make sure you initialize the Adjust SDK as soon as possible in your Cordova app. To do this: +\{% callout type="important" %\} +테스트 시에는 반드시 환경이 `AdjustConfig.EnvironmentSandbox`로 설정되어야 합니다. 앱을 앱스토어에 제출하기 전에 이를 `AdjustConfig.EnvironmentProduction`로 변경합니다. +\{% /callout %\} -1. Instantiate an `AdjustConfig` object with the following information: +Cordova 앱에서 최대한 빨리 Adjust SDK를 초기화하시기 바랍니다. 이를 위해 다음을 수행하시기 바랍니다. - * `appToken`: [Adjust 앱 토큰](https://help.adjust.com/ko/article/app-settings#view-your-app-token)입니다. +1. 다음 인수를 사용하여 `AdjustConfig` 객체를 인스턴스화합니다. + * `appToken`: [Adjust 앱 토큰](https://help.adjust.com/en/article/app-settings#view-your-app-token)입니다. * `environment`: 앱이 실행 중인 환경. 로컬에서 앱을 테스트하려면 이 값을 `AdjustConfig.EnvironmentSandbox` 로 설정하시기 바랍니다. -1. Pass your `AdjustConfig` instance to the `Adjust.initSdk` method to initialize the SDK. +2. `AdjustConfig` 인스턴스를 `Adjust.initSdk` 메서드에 전달하여 SDK를 초기화합니다. ```js var adjustConfig = new AdjustConfig( @@ -98,13 +103,15 @@ var adjustConfig = new AdjustConfig( Adjust.initSdk(adjustConfig); ``` -## 6. 앱 빌드 {% #build-your-app %} +6\. 앱 빌드 \{% \#build\-your\-app %\} +----------------------------------------- -잘하셨습니다! 이제 Cordova 앱을 빌드하고 실행할 수 있을 것입니다. 로깅을 실행하여 문제가 있는지 확인합니다. 로그를 검토하여 `Install tracked` 메시지를 확인합니다. +잘하셨습니다\! 이제 Cordova 앱을 빌드하고 실행할 수 있을 것입니다. 로깅을 실행하여 문제가 있는지 확인합니다. 로그를 검토하여 `Install tracked` 메시지를 확인합니다. Adjust SDK를 통해 사용자 어트리뷰션을 시작할 수 있습니다. -## 7. 연동 테스트 {% #test-your-integration %} +7\. 연동 테스트 \{% \#test\-your\-integration %\} +-------------------------------------------------- Adjust SDK는 연동 테스트와 문제 해결 툴을 제공합니다. 다음과 같이 설정을 테스트하시기 바랍니다. @@ -114,8 +121,9 @@ Adjust SDK는 연동 테스트와 문제 해결 툴을 제공합니다. 다음 문제 발생 시, 모든 상세 내용과 로그를 [support@adjust.com](mailto:support@adjust.com)에 보내시기 바랍니다. -### Google Play Services 연동 테스트 {% #test-google-play-services-integration %} +### Google Play Services 연동 테스트 \{% \#test\-google\-play\-services\-integration %\} -Adjust SDK가 기기의 Google 광고 ID를 수신할 수 있는지 테스트하려면 로그 수준을 **verbose** 로 설정하고, 환경을 **Sandbox(샌드박스)** 로 설정합니다. 앱을 시작하고 세션이나 이벤트를 측정합니다. SDK가 광고 ID를 읽으면 `gps_adid`(Google 플레이 서비스 광고주 ID) 파라미터를 로깅합니다. +Adjust SDK가 기기의 Google 광고 ID를 수신할 수 있는지 테스트하려면 로그 수준을 **verbose** 로 설정하고, 환경을 **Sandbox\(샌드박스\)** 로 설정합니다. 앱을 시작하고 세션이나 이벤트를 측정합니다. SDK가 광고 ID를 읽으면 `gps_adid`\(Google 플레이 서비스 광고주 ID\) 파라미터를 로깅합니다. Google 광고 ID를 조회하는 데 문제가 있다면 SDK [Github repository](https://github.com/adjust/cordova_sdk)에 이슈를 제기하거나 [support@adjust.com](mailto:support@adjust.com)으로 문의해 주시기 바랍니다. + diff --git a/src/content/docs/ko/sdk/cordova/v5/plugins/index.mdoc b/src/content/docs/ko/sdk/cordova/v5/plugins/index.mdoc new file mode 100644 index 000000000..2bbc57d5b --- /dev/null +++ b/src/content/docs/ko/sdk/cordova/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "서드파티 플러그인" +description: "타사 플러그인을 사용하여 타사 SDK의 정보를 Adjust로 전달합니다." +category-title: "플러그인" +slug: "en/sdk/cordova/plugins" +type: "category" +sidebar-position: 5 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/cordova/v4" +--- +플러그인을 사용하여 정보를 타사 플러그인으로 전달합니다. + diff --git a/src/content/docs/ko/sdk/cordova/v5/plugins/meta-install-referrer.mdoc b/src/content/docs/ko/sdk/cordova/v5/plugins/meta-install-referrer.mdoc new file mode 100644 index 000000000..2c3a499e4 --- /dev/null +++ b/src/content/docs/ko/sdk/cordova/v5/plugins/meta-install-referrer.mdoc @@ -0,0 +1,44 @@ +--- +title: "Meta 설치 리퍼러" +description: "Meta 설치 리퍼러 플러그인을 사용하여 Meta 설치 리퍼러 정보를 Adjust에 전송합니다." +slug: "en/sdk/cordova/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/cordova/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +Adjust SDK는 [Meta가 요구](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)하는 `` 요소를 번들로 제공합니다. 이를 `AndroidManifest.xml`에 추가할 필요는 없습니다. +\{% /callout %\} + +Meta 설치 리퍼러 플러그인은 Adjust SDK가 기기에서 Meta 설치 리퍼러 값을 읽을 수 있도록 해줍니다. 이후 SDK는 해당 정보를 설치 페이로드의 일부로서 Adjust 서버에 전송합니다. + +앱에 플러그인을 추가하는 방법: + +1. 다음의 디펜던시를 `build.gradle` 파일에 추가합니다. + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. [앱 대시보드](https://developers.facebook.com/apps)에서 Meta 앱 ID를 확인합니다. 자세한 내용은 Meta의 [앱 대시보드 문서](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)를 참조하시기 바랍니다. + +3. 앱 ID를 `AdjustConfig` 인스턴스의 `fbAppId` 속성에 할당합니다. + + ```js + var adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox, + ); + adjustConfig.setFbAppId("FB_APP_ID"); + Adjust.initSdk(adjustConfig); + ``` + diff --git a/src/content/docs/ko/sdk/flutter/v5/index.mdoc b/src/content/docs/ko/sdk/flutter/v5/index.mdoc index 5e5fdce5d..75f7e72e4 100644 --- a/src/content/docs/ko/sdk/flutter/v5/index.mdoc +++ b/src/content/docs/ko/sdk/flutter/v5/index.mdoc @@ -1,26 +1,28 @@ --- -title: Flutter SDK 연동 가이드 -description: Flutter SDK를 사용하여 Flutter 앱에서 Adjust의 기능에 액세스 -category-title: Flutter SDK -slug: ko/sdk/flutter +title: "Flutter SDK 연동 가이드" +description: "Flutter SDK를 사용하여 Flutter 앱에서 Adjust의 기능에 액세스" +category-title: "Flutter SDK" +slug: "en/sdk/flutter" sidebar-position: 5 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ko/sdk/flutter/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/flutter/v4" --- +Adjust Flutter SDK를 사용하여 Flutter 앱에서 어트리뷰션, 이벤트 등을 측정할 수 있습니다. 본 가이드의 단계를 수행하여 Adjust SDK와 연동되도록 앱을 설정하시기 바랍니다. 이에 대한 예시는 [GitHub](https://github.com/adjust/flutter_sdk/tree/master/example)에서 확인하실 수 있습니다. -The Adjust Flutter SDK enables you to measure attribution, events, and much more in your Flutter app. Follow the steps in this guide to set up your app to work with the Adjust SDK. You can also check out the example app [on GitHub](https://github.com/adjust/flutter_sdk/tree/master/example). +\{% callout type="important" %\} +Adjust SDK는 iOS 12 이상 버전과 Android API level 21 \(Lollipop\) 이상을 지원합니다. +\{% /callout %\} -{% callout type="important" %} -The Adjust SDK supports iOS 12 or later and Android API level 21 (Lollipop) or later. -{% /callout %} - -## 1. 프로젝트에 SDK 추가 {% #add-the-sdk-to-your-project %} +1\. 프로젝트에 SDK 추가 \{% \#add\-the\-sdk\-to\-your\-project %\} +-------------------------------------------------------------------- Flutter 앱에서[Adjust Flutter SDK](https://github.com/adjust/flutter_sdk/releases)를 시작하려면 우선 프로젝트에 Adjust Flutter SDK를 추가해야 합니다. @@ -33,27 +35,28 @@ Flutter 프로젝트에 Adjust SDK를 가져오기 하려면 다음을 수행하 adjust_sdk: ^{% $versions.flutter.v5 %} ``` -1. 프로젝트로 이동하여 다음 명령을 실행합니다. `pubspec.yaml` 파일을 수정하면 Visual Studio가 자동으로 이 명령어를 실행합니다. +2. 프로젝트로 이동하여 다음 명령을 실행합니다. `pubspec.yaml` 파일을 수정하면 Visual Studio가 자동으로 이 명령어를 실행합니다. ```console $ flutter packages get ``` -## 2. Android 기기 설정 {% #set-up-android-devices %} +2\. Android 기기 설정 \{% \#set\-up\-android\-devices %\} +------------------------------------------------------------ -### Google Play Services 추가 {% #add-google-play-services %} +### Google Play Services 추가 \{% \#add\-google\-play\-services %\} -Google Play Store를 타겟팅하는 앱은 기기를 식별하기 위해 반드시 [Google Advertising ID](https://support.google.com/googleplay/android-developer/answer/6048248?hl=en) (`gps_adid`)를 사용해야 합니다. 이를 위해 `build.gradle` 파일의 `dependencies` 섹션에 다음의 디펜던시를 추가합니다. +Google Play Store를 타겟팅하는 앱은 기기를 식별하기 위해 반드시 [Google Advertising ID](https://support.google.com/googleplay/android-developer/answer/6048248?hl=en) \(`gps_adid`\)를 사용해야 합니다. 이를 위해 `build.gradle` 파일의 `dependencies` 섹션에 다음의 디펜던시를 추가합니다. ```groovy implementation 'com.google.android.gms:play-services-ads-identifier:18.1.0' ``` -{% callout type="note" %} -The Adjust SDK isn't tied to any version of the `play-services-ads-identifier` dependency. You can use any version of the Google Play Services library. -{% /callout %} +\{% callout type="note" %\} +Adjust SDK는 `play-services-ads-identifier` 디펜던시의 버전과 연결되어 있지 않습니다. 따라서 Google Play Services 라이브러리의 모든 버전을 사용할 수 있습니다. +\{% /callout %\} -### 권한 추가 {% #add-permissions %} +### 권한 추가 \{% \#add\-permissions %\} Adjust SDK는 다음의 권한을 필요로합니다. `AndroidManifest.xml` 파일이 아직 존재하지 않는다면 추가하시기 바랍니다. @@ -67,11 +70,11 @@ Adjust SDK에는 `com.google.android.gms.AD_ID` 권한이 기본값으로 포함 ``` -{% callout type="seealso" %} -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 about this permission. -{% /callout %} +\{% callout type="seealso" %\} +이 권한에 대한 자세한 내용은 Google의 [`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid) 을 참조하시기 바랍니다. +\{% /callout %\} -### 설치 리퍼러 설정 {% #set-up-install-referrer %} +### 설치 리퍼러 설정 \{% \#set\-up\-install\-referrer %\} 설치 리퍼러는 앱 설치를 소스에 어트리뷰션하는 데 사용할 수 있는 고유한 ID입니다. Adjust SDK는 어트리뷰션을 위해 이 정보가 필요합니다. @@ -87,43 +90,48 @@ implementation 'com.android.installreferrer:installreferrer:2.2' #### Meta 리퍼러 연동 -The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer) using the Adjust Meta Install Referrer plugin. [See the Flutter Meta Install Referrer plugin for integration details](/ko/sdk/flutter/plugins/meta-referrer-plugin). +Adjust SDK는 Adjust Meta 설치 리퍼러 플러그인을 사용하는 [Meta 설치 리퍼러](https://developers.facebook.com/docs/app-ads/meta-install-referrer)를 지원합니다. [연동에 대한 자세한 내용은 Flutter Meta 설치 리퍼러 플러그인을 참조하시기 바랍니다](/en/sdk/flutter/plugins/meta-referrer-plugin). -## 3. iOS 프레임워크 추가 {% #add-ios-frameworks %} +3\. iOS 프레임워크 추가 \{% \#add\-ios\-frameworks %\} +----------------------------------------------------- -Adjust SDK는 특정 iOS 프레임워크가 앱에 포함된 경우 추가적인 정보를 얻을 수 있습니다. 이러한 프레임워크는 특정 SDK 기능을 활성화하지만, SDK가 일반적으로 작동하기 위해 반드시 필요한 것은 아닙니다. **Project Settings --> Build Phases --> Link Binary With Libraries** 에서 프레임워크를 추가한 뒤 이를 **Optional** 로 지정할 수 있습니다. +Adjust SDK는 특정 iOS 프레임워크가 앱에 포함된 경우 추가적인 정보를 얻을 수 있습니다. 이러한 프레임워크는 특정 SDK 기능을 활성화하지만, SDK가 일반적으로 작동하기 위해 반드시 필요한 것은 아닙니다. **Project Settings \-\-> Build Phases \-\-> Link Binary With Libraries** 에서 프레임워크를 추가한 뒤 이를 **Optional** 로 지정할 수 있습니다. -| 프레임워크 | 설명 | 참고 사항 | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `AdSupport.framework` | 디바이스 IDFA에 대한 액세스와, iOS 14 이하 버전의 기기에서 LAT에 대한 액세스도 활성화합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | -| `AdServices.framework` | Apple 검색 광고 어트리뷰션 처리 | | -| `StoreKit.framework` | SKAdNetwork 프레임워크에 대한 액세스 활성화 | Adjust SDK가 iOS 14 이상 버전의 기기에서 SKAdNetwork와의 커뮤니케이션을 처리하도록 허용하기 위해 필요합니다. | -| `AppTrackingTransparency.framework` | Adjust SDK가 iOS 14 이상 버전의 기기에서 사용자 ATT 동의 다이얼로그 및 액세스 동의 응답을 래핑하도록 허용하기 위해 필요합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | +| 프레임워크 | 설명 | 참고 사항 | +|-------------------------------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| `AdSupport.framework` | 디바이스 IDFA에 대한 액세스와, iOS 14 이하 버전의 기기에서 LAT에 대한 액세스도 활성화합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | +| `AdServices.framework` | Apple 검색 광고 어트리뷰션 처리 | | +| `StoreKit.framework` | SKAdNetwork 프레임워크에 대한 액세스 활성화 | Adjust SDK가 iOS 14 이상 버전의 기기에서 SKAdNetwork와의 커뮤니케이션을 처리하도록 허용하기 위해 필요합니다. | +| `AppTrackingTransparency.framework` | Adjust SDK가 iOS 14 이상 버전의 기기에서 사용자 ATT 동의 다이얼로그 및 액세스 동의 응답을 래핑하도록 허용하기 위해 필요합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | -## 4. SDK 서명 설정 {% #set-up-sdk-signature %} +4\. SDK 서명 설정 \{% \#set\-up\-sdk\-signature %\} +------------------------------------------------------ -Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/ko/article/sdk-signature)의 지침을 따르시기 바랍니다. +Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/en/article/sdk-signature)의 지침을 따르시기 바랍니다. -## 5. Adjust SDK 초기화 {% #initialize-the-adjust-sdk %} +5\. Adjust SDK 초기화 \{% \#initialize\-the\-adjust\-sdk %\} +---------------------------------------------------------------- Flutter 앱에서 최대한 빨리 Adjust SDK를 초기화하시기 바랍니다. 이를 위해 앱 토큰 및 앱을 실행하고자 하는 환경과 함께 config 객체를 초기화하시기 바랍니다. -{% callout type="important" %} -When running tests you should ensure that your environment is set to `AdjustEnvironment.sandbox`. Change this to `AdjustEnvironment.production` before you submit your application to the app store. -{% /callout %} +\{% callout type="important" %\} +테스트 시에는 반드시 환경이 `AdjustEnvironment.sandbox`로 설정되어야 합니다. 앱을 앱스토어에 제출하기 전에 이를 `AdjustEnvironment.production`로 변경합니다. +\{% /callout %\} ```dart AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); Adjust.initSdk(config); ``` -## 6. 앱 빌드 {% #build-your-app %} +6\. 앱 빌드 \{% \#build\-your\-app %\} +----------------------------------------- -잘하셨습니다! 이제 Flutter 앱을 빌드하고 실행할 수 있습니다. 로깅을 실행하여 문제가 있는지 확인합니다. 로그를 검토하여 `Install tracked` 메시지를 확인합니다. +잘하셨습니다\! 이제 Flutter 앱을 빌드하고 실행할 수 있습니다. 로깅을 실행하여 문제가 있는지 확인합니다. 로그를 검토하여 `Install tracked` 메시지를 확인합니다. Adjust SDK를 통해 사용자 어트리뷰션을 시작할 수 있습니다. -## 7. 연동 테스트 {% #test-your-integration %} +7\. 연동 테스트 \{% \#test\-your\-integration %\} +-------------------------------------------------- Adjust SDK는 연동 테스트와 문제 해결 툴을 제공합니다. 다음과 같이 설정을 테스트하시기 바랍니다. @@ -131,12 +139,13 @@ Adjust SDK는 연동 테스트와 문제 해결 툴을 제공합니다. 다음 * Adjust 대시보드 결과에 샌드박스 필터를 추가합니다. * 로그 수준을 `AdjustLogLevel.verbose`로 설정합니다. -{% callout type="tip" %} -If you encounter any issues, email [support@adjust.com](mailto:support@adjust.com) with all details and logs. -{% /callout %} +\{% callout type="tip" %\} +문제 발생 시, 모든 상세 내용과 로그를 [support@adjust.com](mailto:support@adjust.com)으로 전송하시기 바랍니다. +\{% /callout %\} -### Google Play Services 연동 테스트 {% #test-google-play-services-integration %} +### Google Play Services 연동 테스트 \{% \#test\-google\-play\-services\-integration %\} -Adjust SDK가 기기의 Google 광고 ID를 수신할 수 있는지 테스트하려면 로그 수준을 `AdjustLogLevel.verbose`로 설정하고, 환경을 `AdjustEnvironment.sandbox`로 설정합니다. 앱을 시작하고 세션이나 이벤트를 측정합니다. SDK가 광고 ID를 읽으면 `gps_adid`(Google 플레이 서비스 광고주 ID) 파라미터를 로깅합니다. +Adjust SDK가 기기의 Google 광고 ID를 수신할 수 있는지 테스트하려면 로그 수준을 `AdjustLogLevel.verbose`로 설정하고, 환경을 `AdjustEnvironment.sandbox`로 설정합니다. 앱을 시작하고 세션이나 이벤트를 측정합니다. SDK가 광고 ID를 읽으면 `gps_adid`\(Google 플레이 서비스 광고주 ID\) 파라미터를 로깅합니다. Google 광고 ID를 조회하는 데 문제가 있다면 SDK [Github repository](https://github.com/adjust/flutter_sdk)에 이슈를 제기하거나 [support@adjust.com](mailto:support@adjust.com)으로 문의해 주시기 바랍니다. + diff --git a/src/content/docs/ko/sdk/flutter/v5/plugins/index.mdoc b/src/content/docs/ko/sdk/flutter/v5/plugins/index.mdoc new file mode 100644 index 000000000..e6efa3857 --- /dev/null +++ b/src/content/docs/ko/sdk/flutter/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "서드파티 플러그인" +description: "타사 플러그인을 사용하여 타사 SDK의 정보를 Adjust로 전달합니다." +category-title: "플러그인" +slug: "en/sdk/flutter/plugins" +type: "category" +sidebar-position: 5 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/flutter/v4" +--- +플러그인을 사용하여 정보를 타사 플러그인으로 전달합니다. + diff --git a/src/content/docs/ko/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc b/src/content/docs/ko/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc new file mode 100644 index 000000000..1cfd74078 --- /dev/null +++ b/src/content/docs/ko/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc @@ -0,0 +1,41 @@ +--- +title: "Meta 설치 리퍼러" +description: "Meta 설치 리퍼러 플러그인을 사용하여 Meta 설치 리퍼러 정보를 Adjust에 전송합니다." +slug: "en/sdk/flutter/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/flutter/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +Adjust SDK는 [Meta가 요구](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)하는 ``요소를 번들로 제공합니다. 이를 `AndroidManifest.xml`에 추가할 필요는 없습니다. +\{% /callout %\} + +Meta 설치 리퍼러 플러그인은 Adjust SDK가 기기에서 Meta 설치 리퍼러 값을 읽을 수 있도록 해줍니다. 이후 SDK는 해당 정보를 설치 페이로드의 일부로서 Adjust 서버에 전송합니다. + +앱에 플러그인을 추가하는 방법: + +1. 다음의 디펜던시를 `build.gradle` 파일에 추가합니다. + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. [앱 대시보드](https://developers.facebook.com/apps)에서 Meta 앱 ID를 확인합니다. 자세한 내용은 Meta의 [앱 대시보드 문서](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)를 참조하시기 바랍니다. + +3. 앱 ID를 `AdjustConfig` 인스턴스의 `fbAppId` 속성에 할당합니다. + + ```dart + AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); + config.fbAppId = ""; + Adjust.initSdk(AdjustConfig); + ``` + diff --git a/src/content/docs/ko/sdk/ios/v5/index.mdoc b/src/content/docs/ko/sdk/ios/v5/index.mdoc index 67cc497fd..31d7f3873 100644 --- a/src/content/docs/ko/sdk/ios/v5/index.mdoc +++ b/src/content/docs/ko/sdk/ios/v5/index.mdoc @@ -1,39 +1,41 @@ --- -title: iOS SDK 연동 가이드 -description: iOS SDK를 사용해 iOS 앱의 Adjust 기능에 액세스 -category-title: iOS SDK -slug: ko/sdk/ios +title: "iOS SDK 연동 가이드" +description: "iOS SDK를 사용해 iOS 앱의 Adjust 기능에 액세스" +category-title: "iOS SDK" +slug: "en/sdk/ios" sidebar-position: 2 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ko/sdk/ios/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/ios/v4" --- - Adjust iOS SDK를 사용하면 iOS 앱에서 어트리뷰션, 이벤트 등을 기록할 수 있습니다. 이 가이드에서는 Adjust SDK를 앱과 연동하는 방법이 다루어집니다. -{% callout type="important" %} +\{% callout type="important" %\} Adjust SDK는 iOS 12 이상 버전을 지원합니다. -{% /callout %} +\{% /callout %\} -## 1. 프로젝트에 SDK 추가 {% #add-the-sdk-to-your-project %} +1\. 프로젝트에 SDK 추가 \{% \#add\-the\-sdk\-to\-your\-project %\} +-------------------------------------------------------------------- iOS 앱에서 Adjust SDK를 사용하려면 우선 Xcode 프로젝트에 Adjust SDK를 추가해야 합니다. Swift 패키지 매니저를 사용하여 SDK를 추가하는 경우: -1. **File --> Swift Packages --> Add Package Dependency** 를 선택합니다. -1. 나타나는 창에 SDK의 GitHub 주소를 입력합니다. `https://github.com/adjust/ios_sdk` -1. **버전** 드롭다운 메뉴에서 사용을 원하는 Adjust SDK 버전을 선택합니다. 최신 버전은 [배포 페이지](https://github.com/adjust/ios_sdk/releases)에서 확인하실 수 있습니다. +1. **File \-\-> Swift Packages \-\-> Add Package Dependency** 를 선택합니다. +2. 나타나는 창에 SDK의 GitHub 주소를 입력합니다. `https://github.com/adjust/ios_sdk` +3. **버전** 드롭다운 메뉴에서 사용을 원하는 Adjust SDK 버전을 선택합니다. 최신 버전은 [배포 페이지](https://github.com/adjust/ios_sdk/releases)에서 확인하실 수 있습니다. -### 대체 설치 메서드 {% #alternative-installation-methods %} +### 대체 설치 메서드 \{% \#alternative\-installation\-methods %\} -{% tabs %} -{% tab title="Cocoapods" sync="cocoapods" %} +\{% tabs %\} +\{% tab title="Cocoapods" sync="cocoapods" %\} Cocoapods를 사용하여 SDK를 추가하려면 `Podfile`에서 사용하고자 하는 버전을 명시합니다. ```rb @@ -46,71 +48,77 @@ pod 'Adjust', '~> {% $versions.ios.v5 %}' ```rb pod 'Adjust/AdjustWebBridge', '~> {% $versions.ios.v5 %}' ``` -{% /tab %} -{% tab title="Carthage" sync="carthage" %} +\{% /tab %\} + +\{% tab title="Carthage" sync="carthage" %\} Carthage를 사용하여 SDK를 추가하려면 `Cartfile`에 다음을 추가합니다. ```text github "adjust/ios_sdk" ``` -{% /tab %} -{% /tabs %} -## 2. Adjust SDK 연동 {% #integrate-the-adjust-sdk %} +\{% /tab %\} \{% /tabs %\} + +2\. Adjust SDK 연동 \{% \#integrate\-the\-adjust\-sdk %\} +-------------------------------------------------------------- `Xcode` 프로젝트에 Adjust SDK를 추가하고 나면 앱에 연동해야 합니다. 프로젝트 파일에 관련 가져오기 명령어를 추가합니다. -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\} +\{% tab title="Swift" sync="swift" %\} Adjust SDK를 가져오기하려면 다음을 브리징 헤더 파일에 추가합니다. ```swift import AdjustSdk ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} Adjust SDK를 가져오기하려면 다음을 `AppDelegate.h` 파일에 추가합니다. ```objc #import ``` -{% /tab %} -{% /tabs %} -## 3. iOS 프레임워크 추가 {% #add-ios-frameworks %} +\{% /tab %\} \{% /tabs %\} + +3\. iOS 프레임워크 추가 \{% \#add\-ios\-frameworks %\} +----------------------------------------------------- Adjust SDK는 특정 기기 정보 액세스를 위해 프레임워크에 의존합니다. 이 정보 읽기를 활성화하려면 프레임워크를 추가하고 프레임워크를 **옵션** 으로 표시하시기 바랍니다. -| 프레임워크 | 설명 | 참고 사항 | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `AdSupport.framework` | 디바이스 IDFA에 대한 액세스와, iOS 14 이하 버전의 기기에서 LAT에 대한 액세스도 활성화합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | -| `AdServices.framework` | ASA 어트리뷰션을 취급합니다. | | -| `StoreKit.framework` | SKAdNetwork 프레임워크에 대한 액세스를 활성화합니다. | Adjust SDK가 iOS 14 이상 버전의 기기에서 SKAdNetwork와의 커뮤니케이션을 처리하도록 허용하기 위해 필요합니다. | -| `AppTrackingTransparency.framework` | Adjust SDK가 iOS 14 이상 버전의 기기에서 사용자 ATT 동의 다이얼로그 및 액세스 동의 응답을 래핑하도록 허용하기 위해 필요합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | -| `WebKit.framework` | 애플리케이션의 웹뷰 사용을 활성화합니다. | 앱이 웹뷰를 사용하는 경우에만 필요합니다. | +| 프레임워크 | 설명 | 참고 사항 | +|-------------------------------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| `AdSupport.framework` | 디바이스 IDFA에 대한 액세스와, iOS 14 이하 버전의 기기에서 LAT에 대한 액세스도 활성화합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | +| `AdServices.framework` | ASA 어트리뷰션을 취급합니다. | | +| `StoreKit.framework` | SKAdNetwork 프레임워크에 대한 액세스를 활성화합니다. | Adjust SDK가 iOS 14 이상 버전의 기기에서 SKAdNetwork와의 커뮤니케이션을 처리하도록 허용하기 위해 필요합니다. | +| `AppTrackingTransparency.framework` | Adjust SDK가 iOS 14 이상 버전의 기기에서 사용자 ATT 동의 다이얼로그 및 액세스 동의 응답을 래핑하도록 허용하기 위해 필요합니다. | 앱이 "아동" 카테고리를 타겟으로 하는 경우 이 프레임워크를 추가하지 않습니다. | +| `WebKit.framework` | 애플리케이션의 웹뷰 사용을 활성화합니다. | 앱이 웹뷰를 사용하는 경우에만 필요합니다. | -## 4. SDK 서명 설정 {% #set-up-sdk-signature %} +4\. SDK 서명 설정 \{% \#set\-up\-sdk\-signature %\} +------------------------------------------------------ -Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/ko/article/sdk-signature)의 지침을 따르시기 바랍니다. +Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/en/article/sdk-signature)의 지침을 따르시기 바랍니다. -## 5. (선택 사항) Adjust Web Bridge 설정 {% #set-up-web-bridge %} +5\. \(선택 사항\) Adjust Web Bridge 설정 \{% \#set\-up\-web\-bridge %\} +-------------------------------------------------------------------------- 앱이 웹뷰를 사용하는 경우 Adjust Web Bridge를 설정해 웹뷰 내 활동을 기록해야 합니다. -### 앱에 `AdjustBridge` 연동 {% #integrate-adjustbridge-into-your-app %} +### 앱에 `AdjustBridge` 연동 \{% \#integrate\-adjustbridge\-into\-your\-app %\} Project Navigator: 1. View Controller의 소스 파일을 엽니다. -1. 파일 가장 위에 `import` 명령어를 추가합니다. -1. `AdjustBridge`에 대해 웹뷰 델리게이트의 `viewDidLoad` 또는 `viewWillAppear` 메서드에서 다음의 콜을 추가합니다. +2. 파일 가장 위에 `import` 명령어를 추가합니다. +3. `AdjustBridge`에 대해 웹뷰 델리게이트의 `viewDidLoad` 또는 `viewWillAppear` 메서드에서 다음의 콜을 추가합니다. + +\{% tabs %\} \{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -121,9 +129,11 @@ func viewWillAppear(_ animated: Bool) { adjustBridge.loadWKWebViewBridge(webView) } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import "" @@ -136,39 +146,40 @@ func viewWillAppear(_ animated: Bool) { // Your code here ``` -{% /tab %} -{% /tabs %} -#### `AdjustBridge`를 웹뷰에 연동 {% #integrate-adjustbridge-into-your-web-view %} +\{% /tab %\} \{% /tabs %\} + +#### `AdjustBridge`를 웹뷰에 연동 \{% \#integrate\-adjustbridge\-into\-your\-web\-view %\} 웹뷰에서 자바스크립트 브릿지를 사용하려면 브릿지를 구성해야 합니다. 다음 자바스크립트 코드를 추가하여 Adjust iOS 웹브릿지를 초기화합니다: -{% tabs %} -{% tab title="Javascript" sync="js" %} +\{% tabs %\} \{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -## 6. Adjust SDK 초기화 {% #initialize-the-adjust-sdk %} +\{% /tab %\} \{% /tabs %\} + +6\. Adjust SDK 초기화 \{% \#initialize\-the\-adjust\-sdk %\} +---------------------------------------------------------------- Adjust SDK를 초기화하려면 config 객체를 만들어야 합니다. 이 객체에는 Adjust SDK 행동을 통제하는 구성 옵션이 포함되어 있습니다. 최소 설정을 위한 다음 인수를 전달합니다. -* `appToken`: 귀하의 [앱 토큰](https://help.adjust.com/ko/article/app-settings#view-your-app-token). +* `appToken`: 귀하의 [앱 토큰](https://help.adjust.com/en/article/app-settings#view-your-app-token). * `environment`: SDK를 실행할 환경. 이를 `ADJEnvironmentSandbox`로 설정합니다. 이 config 객체로 Adjust SDK 초기화: 1. 앱 델리게이트의 `didFinishLaunching` 또는 `didFinishLaunchingWithOptions` 메서드의 config 개체를 선언합니다. -1. `ADJLogLevelVerbose`(verbose)에 config 개체의 `logLevel` 속성을 설정합니다. 디바이스 정보를 검색하려면 verbose 로깅을 활성화해야 합니다. -1. `initSdk` 메서드에 인수로 config 개체를 전달합니다. +2. `ADJLogLevelVerbose`\(verbose\)에 config 개체의 `logLevel` 속성을 설정합니다. 디바이스 정보를 검색하려면 verbose 로깅을 활성화해야 합니다. +3. `initSdk` 메서드에 인수로 config 개체를 전달합니다. + +\{% tabs %\} \{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -184,9 +195,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -201,37 +214,38 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% tab title="Javascript" sync="js" %} +\{% /tab %\} + +\{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -### iMessage 앱 설정 {% #set-up-your-imessage-app %} +\{% /tab %\} \{% /tabs %\} + +### iMessage 앱 설정 \{% \#set\-up\-your\-imessage\-app %\} -{% callout type="important" %} -iMessage 확장 프로그램은 앱과 다른 번들 식별자를 가지며 다른 메모리 공간에서 실행됩니다. 동일한 토큰으로 두 가지를 모두 설정하는 경우 SDK는 혼합 데이터를 반환합니다. 따라서 Adjust 대시보드에서 iMessage 앱 전용으로 별도의 앱을 생성해야 하며, Adjust SDK를 초기화할 때 해당 토큰을 사용해야 합니다. -{% /callout %} +\{% callout type="important" %\} +iMessage 확장 프로그램은 앱과 다른 번들 식별자를 가지며 다른 메모리 공간에서 실행됩니다. 동일한 토큰으로 두 가지를 모두 설정하는 경우 SDK는 혼합 데이터를 반환합니다. 따라서 Adjust 대시보드에서 iMessage 앱 전용으로 별도의 앱을 생성해야 하며, Adjust SDK를 초기화할 때 해당 토큰을 사용해야 합니다.\{% /callout %\} 앱이 iMessage를 타겟으로 하는 경우 설정해야 하는 추가적인 설정이 몇 가지 있습니다. * 소스에서 Adjust SDK를 추가한 경우, iMessage 프로젝트 설정에 `ADJUST_IM=1` 프리프로세서 매크로를 추가합니다. * Adjust SDK를 프레임워크로 추가한 경우, **Build Phases** 프로젝트 설정에 **New Copy Files Phase** 를 추가해야 합니다. 프레임워크 폴더에 복사될 `AdjustSdkIm.framework`를 설정합니다. -#### 세션 기록 {% #record-sessions %} +#### 세션 기록 \{% \#record\-sessions %\} Adjust SDK는 iMessage 앱에서 iOS 시스템 알림을 구독하지 않습니다. 앱이 포그라운드에 진입했거나 나간 경우 Adjust SDK에 알리려면 `trackSubsessionStart` 및 `trackSubsessionEnd` 메서드를 콜해야 합니다. `didBecomeActiveWithConversation:` 메서드 안의 `trackSubsessionStart`에 콜을 추가합니다. -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\} \{% tab title="Swift" sync="swift" %\} + ```swift func didBecomeActive(with conversation: MSConversation) { // Called when the extension is about to move from the inactive to active state. @@ -241,9 +255,11 @@ func didBecomeActive(with conversation: MSConversation) { Adjust.trackSubsessionStart() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)didBecomeActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the inactive to active state. @@ -253,13 +269,13 @@ func didBecomeActive(with conversation: MSConversation) { [Adjust trackSubsessionStart]; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\} \{% /tabs %\} `willResignActiveWithConversation:` 메서드 안의 `trackSubsessionEnd`에 콜을 추가합니다. -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\} \{% tab title="Swift" sync="swift" %\} + ```swift func willResignActive(with conversation: MSConversation) { // Called when the extension is about to move from the active to inactive state. @@ -273,9 +289,11 @@ func willResignActive(with conversation: MSConversation) { Adjust.trackSubsessionEnd() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)willResignActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the active to inactive state. @@ -289,30 +307,33 @@ func willResignActive(with conversation: MSConversation) { [Adjust trackSubsessionEnd]; } ``` -{% /tab %} -{% /tabs %} -## 7. Adjust SDK 설정 {% #configure-the-adjust-sdk %} +\{% /tab %\} \{% /tabs %\} -config 개체와 초기화 로직을 추가하고 나면 Adjust SDK를 설정해 앱의 다양한 부분에 대한 정보를 기록할 수 있습니다. [구성 참조](/ko/sdk/ios/configuration) 및 [기능 가이드](/ko/sdk/ios/features)를 확인하여 기록할 항목을 정확히 설정합니다. +7\. Adjust SDK 설정 \{% \#configure\-the\-adjust\-sdk %\} +-------------------------------------------------------------- -## 8. Adjust SDK 테스트 {% #test-the-adjust-sdk %} +config 개체와 초기화 로직을 추가하고 나면 Adjust SDK를 설정해 앱의 다양한 부분에 대한 정보를 기록할 수 있습니다. [구성 참조](/en/sdk/ios/configuration) 및 [기능 가이드](/en/sdk/ios/features)를 확인하여 기록할 항목을 정확히 설정합니다. -Adjust SDK를 설정해 앱 정보를 기록할 수 있으므로 이제 테스트할 차례입니다. Adjust는 앱 테스트에 도움이 되는 [테스팅 콘솔](https://help.adjust.com/ko/article/testing-console)과 [Device API](https://help.adjust.com/ko/article/device-api)를 제공합니다. +8\. Adjust SDK 테스트 \{% \#test\-the\-adjust\-sdk %\} +---------------------------------------------------------- -[테스트 가이드](https://help.adjust.com/ko/article/test-the-adjust-sdk)를 따라 Adjust가 앱에서 예상값을 수신하는지 확인합니다. +Adjust SDK를 설정해 앱 정보를 기록할 수 있으므로 이제 테스트할 차례입니다. Adjust는 앱 테스트에 도움이 되는 [테스팅 콘솔](https://help.adjust.com/en/article/testing-console)과 [Device API](https://help.adjust.com/en/article/device-api)를 제공합니다. -## 9. 프로덕션을 위한 앱 빌드 {% #build-your-app-for-production %} +[테스트 가이드](https://help.adjust.com/en/article/test-the-adjust-sdk)를 따라 Adjust가 앱에서 예상값을 수신하는지 확인합니다. + +9\. 프로덕션을 위한 앱 빌드 \{% \#build\-your\-app\-for\-production %\} +--------------------------------------------------------------------- 테스트를 완료한 후에 프로덕션을 위한 앱을 빌드할 수 있습니다. 이를 위해 config 객체를 업데이트해야 합니다. 다음 값 업데이트: * `environment`: 이것을 `ADJEnvironmentProduction`으로 설정합니다. -* `logLevel`: [로깅 레벨](/ko/sdk/ios/configuration#set-your-logging-level)을 선택하거나 config 객체의 `allowSuppressLogLevel` 인수를 전달해 로깅을 완전히 비활성화합니다. +* `logLevel`: [로깅 레벨](/en/sdk/ios/configuration#set-your-logging-level)을 선택하거나 config 객체의 `allowSuppressLogLevel` 인수를 전달해 로깅을 완전히 비활성화합니다. + +\{% tabs %\} \{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -331,9 +352,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -350,13 +373,13 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\} \{% /tabs %\} 디버그 빌드 또는 프로덕션 빌드를 만들지 여부에 따라 `Xcode` 빌드 플래그를 사용해 config를 동적으로 업데이트할 수 있습니다. -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\} \{% tab title="Swift" sync="swift" %\} + ```swift func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { // Override point for customization after application launch. @@ -382,9 +405,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -409,5 +434,6 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\} \{% /tabs %\} + diff --git a/src/content/docs/ko/sdk/unity/v4/plugins/index.mdoc b/src/content/docs/ko/sdk/unity/v4/plugins/index.mdoc new file mode 100644 index 000000000..31be1abf4 --- /dev/null +++ b/src/content/docs/ko/sdk/unity/v4/plugins/index.mdoc @@ -0,0 +1,19 @@ +--- +title: "서드파티 플러그인" +description: "타사 플러그인을 사용하여 타사 SDK의 정보를 Adjust로 전달합니다." +category-title: "플러그인" +type: "category" +sidebar-position: 4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v5: "/ko/sdk/unity/plugins" +--- +플러그인을 사용하여 정보를 타사 플러그인으로 전달합니다. + diff --git a/src/content/docs/ko/sdk/unity/v5/index.mdoc b/src/content/docs/ko/sdk/unity/v5/index.mdoc index 28f52ac04..607a85ac6 100644 --- a/src/content/docs/ko/sdk/unity/v5/index.mdoc +++ b/src/content/docs/ko/sdk/unity/v5/index.mdoc @@ -1,78 +1,81 @@ --- -title: Unity SDK 연동 가이드 -description: Unity SDK를 사용하여 Unity 앱의 Adjust 기능에 액세스합니다. -category-title: Unity SDK -slug: ko/sdk/unity +title: "Unity SDK 연동 가이드" +description: "Unity SDK를 사용하여 Unity 앱의 Adjust 기능에 액세스합니다." +category-title: "Unity SDK" +slug: "en/sdk/unity" sidebar-position: 3 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ko/sdk/unity/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/unity/v4" --- - Adjust Unity SDK를 사용하면 Unity 앱에서 어트리뷰션, 이벤트 등을 기록할 수 있습니다. 본 가이드의 단계를 수행하여 Adjust SDK와 연동되도록 앱을 설정하시기 바랍니다. -{% callout type="note" %} -The Adjust SDK supports iOS 12 or later and Android API level 21 (Lollipop) or later. -{% /callout %} +시작에 앞서 \{% \#before\-you\-begin %\} +---------------------------------------- + +Here's what you need to know before you get started: + +* Adjust SDK는 iOS 12 이상 버전과 Android API level 21 \(Lollipop\) 이상을 지원합니다. +* The Adjust SDK is compatible with Unity Editor 2018\.2 or later. -## 1. Adjust SDK 설치 {% #get-the-adjust-sdk %} +1\. Adjust SDK 설치 \{% \#get\-the\-adjust\-sdk %\} +-------------------------------------------------------- -To install the Adjust SDK, choose one of the following methods. +Adjust SDK를 설치하려면 다음 방법 중 하나를 수행하시기 바랍니다. -### Unity 패키지 설치 {% #install-unity-package %} +### Unity 패키지 설치 \{% \#install\-unity\-package %\} Unity 앱에서 Adjust SDK를 시작하려면 우선 프로젝트에 Adjust SDK를 추가해야 합니다. [GitHub releases 페이지](https://github.com/adjust/adjust_unity_sdk/releases/latest)에서 최신 버전을 다운로드합니다. -To import the Adjust SDK into your Unity project: +Adjust SDK를 Unity 프로젝트로 불러오는 방법: 1. Unity Editor를 실행합니다. -1. **Assets --> Import Package --> Custom Package** 를 선택합니다. -1. 다운로드된 SDK 패키지를 선택합니다. +2. **Assets \-\-> Import Package \-\-> Custom Package** 를 선택합니다. +3. 다운로드된 SDK 패키지를 선택합니다. -### Unity 패키지 매니저 사용 {% #use-the-unity-package-manager %} +### Unity 패키지 매니저 사용 \{% \#use\-the\-unity\-package\-manager %\} -To install the Adjust SDK with the Unity Package Manager, follow these steps: +Unity 패키지 매니저로 Adjust SDK를 설치하려면 다음의 단계를 수행하시기 바랍니다. 1. Unity 에디터에서 **패키지 매니저** 창을 선택합니다. -1. **git URL에서 패키지 추가** 를 선택합니다. -1. 다음 URL을 입력합니다. `https://github.com/adjust/unity_sdk.git?path=Assets/Adjust` - -## 2. iOS와 Android SDK 설치 {% #install-ios-and-android-sdks %} - -SDK v5에서는 더 이상 iOS 및 Android SDK를 바이너리 디펜던시로 사용하지 않습니다. 기본 iOS 및 Android SDK를 설치하려면 [EDM4U(External Dependency Manager for Unity)](https://github.com/googlesamples/unity-jar-resolver)를 사용하여 CocoaPods 및 Maven의 패키지를 설치해야 합니다. - -To ensure that the Privacy Manifest and frameworks are loaded correctly for iOS, you need to disable static linking. To do this: +2. **git URL에서 패키지 추가** 를 선택합니다. +3. 다음 URL을 입력합니다. `https://github.com/adjust/unity_sdk.git?path=Assets/Adjust` -1. Select **Assets -> External Dependency Manager -> iOS Resolver -> Settings** . -1. Find the **Link frameworks statically** option and uncheck it. +2\. iOS와 Android SDK 설치 \{% \#install\-ios\-and\-android\-sdks %\} +-------------------------------------------------------------------------- -![A screenshot of the resolver settings menu](@images/unity/link-frameworks-statically.png) +\{% minorversion +changed="v5\.0\.4" +link="[https://github.com/adjust/unity\_sdk/releases/tag/v5\.0\.4](https://github.com/adjust/unity_sdk/releases/tag/v5.0.4)" %\} +SDK v5 no longer uses the iOS and Android SDKs as binary dependencies. To install the underlying iOS and Android SDKs, you need to use the [External Dependency Manager for Unity \(EDM4U\)](https://github.com/googlesamples/unity-jar-resolver) to install the packages from CocoaPods and Maven. +\{% /minorversion %\} -## 3. SDK 연동 {% #integrate-the-sdk %} +3\. SDK 연동 \{% \#integrate\-the\-sdk %\} +---------------------------------------------- -Adjust SDK는 Unity [프리팹(prefab)](https://docs.unity3d.com/Manual/Prefabs.html)을 포함하며, 프리팹에는 템플릿 게임 객체와 Adjust 스크립트가 있습니다. 이 스크립트를 사용해 SDK를 구성할 수 있습니다. Unity Editor에서 프리팹을 실행하려면 다음을 수행하시기 바랍니다. +Adjust SDK는 Unity [프리팹\(prefab\)](https://docs.unity3d.com/Manual/Prefabs.html)을 포함하며, 프리팹에는 템플릿 게임 객체와 Adjust 스크립트가 있습니다. 이 스크립트를 사용해 SDK를 구성할 수 있습니다. Unity Editor에서 프리팹을 실행하려면 다음을 수행하시기 바랍니다. 1. `Assets/Adjust/Adjust.prefab` 로부터의 프리팹을 첫 화면에 추가합니다. -1. 프리팹 Inspector Menu를 실행합니다. -1. 프리팹 메뉴는 Adjust SDK의 동작을 제어하는 편집 가능한 필드를 포함하고 있습니다. +2. 프리팹 Inspector Menu를 실행합니다. +3. 프리팹 메뉴는 Adjust SDK의 동작을 제어하는 편집 가능한 필드를 포함하고 있습니다. ![Unity Editor 내 Adjust SDK 프리팹 구성 스크립트의 스크린샷.](@images/unity/1-prefab.png) Adjust SDK를 설정하려면 다음의 정보를 입력하시기 바랍니다. 1. **앱 토큰** . 앱 토큰 확인 방법은 앱 설정 페이지를 참조하시기 바랍니다. - -1. **앱 환경** . - +2. **앱 환경** . * 앱을 테스트 중이며 테스트 데이터를 전송하고자 하는 경우 **샌드박스** 모드를 선택하시기 바랍니다. 테스트 데이터를 보려면 대시보드에서 샌드박스 모드를 활성화해야 합니다. * 테스트를 완료하고 앱 출시 준비가 된 경우 **프로덕션** 모드를 선택하시기 바랍니다. -1. **로그 수준** . 어느 로그를 받는지에 관한 것으로, 자세한 정보는 [로그 수준 설정 페이지](/ko/sdk/unity/configuration#set-your-logging-level)를 참조하시기 바랍니다. +3. **로그 수준** . 어느 로그를 받는지에 관한 것으로, 자세한 정보는 [로그 수준 설정 페이지](/en/sdk/unity/configuration#set-your-logging-level)를 참조하시기 바랍니다. Adjust SDK는 기본값 설정에 따라 앱의 Awake 이벤트가 발생한 경우 시작됩니다. 이 행동을 오버라이드하려면 **START SDK MANUALLY** 옵션을 확인하시기 바랍니다. 이를 통해 config 인스턴스를 인수로 `Adjust.InitSdk`를 호출하여 Adjust SDK를 초기화할 수 있습니다. @@ -81,47 +84,50 @@ AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment Adjust.InitSdk(adjustConfig); ``` -## 4. Android 기기 설정 {% #set-up-android-devices %} +4\. Android 기기 설정 \{% \#set\-up\-android\-devices %\} +------------------------------------------------------------ -### Google Play Services 추가 {% #add-google-play-services %} +### Google Play Services 추가 \{% \#add\-google\-play\-services %\} -Google 플레이 스토어를 타겟으로 하는 앱은 기기 식별을 위해 gps_adid(Google 광고 ID)를 사용해야 합니다. `gps_adid`에 액세스하기 위해 프로젝트에 `play-services-ads-identifier` AAR을 추가합니다. +Google 플레이 스토어를 타겟으로 하는 앱은 기기 식별을 위해 gps\_adid\(Google 광고 ID\)를 사용해야 합니다. `gps_adid`에 액세스하기 위해 프로젝트에 `play-services-ads-identifier` AAR을 추가합니다. -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} -If you are using the [External Dependency Manager plugin](https://developers.google.com/unity/archive#external_dependency_manager_for_unity), add the following to your `Dependencies.xml` file: +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} +[외부 디펜던시 매니저 플러그인](https://developers.google.com/unity/archive#external_dependency_manager_for_unity)을 사용하는 경우 `Dependencies.xml` 파일에 다음을 추가하시기 바랍니다. ```xml ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} -To install the ARR (Android Archive) manually, [download it from Maven](https://maven.google.com/web/index.html#com.google.android.gms:play-services-ads-identifier:18.0.1 "Maven 내 AAR 결과물(artifact) 링크.") and add it to the `Assets/Plugins/Android` directory. -{% /tab %} -{% /tabs %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} +ARR \(Android Archive\)을 수동으로 설치하려면, [Maven에서 다운로드](https://maven.google.com/web/index.html#com.google.android.gms:play-services-ads-identifier:18.0.1 "Maven 내 AAR 결과물(artifact) 링크.") 한 뒤 `Assets/Plugins/Android` 디렉토리에 추가하시기 바랍니다. +\{% /tab %\} +\{% /tabs %\} -### App Set ID 수집 {% #collect-app-set-identifier %} +### App Set ID 수집 \{% \#collect\-app\-set\-identifier %\} [앱 세트 ID](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId) 는 사용자가 기기에 설치한 앱 정보를 측정할 수 있도록 해주는 고유한 ID입니다. 동일한 개발자의 모든 앱은 App Set ID를 공유하기 때문에, 모든 앱 사용자로부터 유의미한 인사이트를 수집할 수 있습니다. -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} -To record a device's App Set ID, you need to add the following dependency to your `Dependencies.xml` file: +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} +기기의 App Set ID를 기록하려면 다음의 디펜던시를 `Dependencies.xml` 파일에 추가해야 합니다. ```xml ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} -To install the ARR (Android Archive) manually, [download it from Maven](https://maven.google.com/web/index.html#com.google.android.gms:play-services-appset:16.0.2 "Maven 내 AAR 결과물(artifact) 링크.") and add it to the `Assets/Plugins/Android` directory. -{% /tab %} -{% /tabs %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} +ARR \(Android Archive\)을 수동으로 설치하려면, [Maven에서 다운로드](https://maven.google.com/web/index.html#com.google.android.gms:play-services-appset:16.0.2 "Maven 내 AAR 결과물(artifact) 링크.") 한 뒤 `Assets/Plugins/Android` 디렉토리에 추가하시기 바랍니다. +\{% /tab %\} +\{% /tabs %\} ### 설치 리퍼러 설정 @@ -129,49 +135,52 @@ To install the ARR (Android Archive) manually, [download it from Maven](https:// Google Play Referrer API를 지원하는 방법에는 두 가지가 있습니다. -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} -Add the install referrer library as a dependency in a [custom `build.gradle` file](https://docs.unity3d.com/2023.1/Documentation/Manual/android-gradle-overview.html) +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} +[커스텀 `build.gradle` 파일](https://docs.unity3d.com/2023.1/Documentation/Manual/android-gradle-overview.html)에 설치 리퍼러 라이브러리를 디펜던시로 추가 ```groovy dependencies { implementation 'com.android.installreferrer:installreferrer:2.2' } ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} -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 %} -{% /tabs %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} +[Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer)에서 설치 리퍼러 라이브러리를 다운로드하고, AAR\(Android Archive\) 파일을 `Plugins/Android` 폴더에 넣기. +\{% /tab %\} +\{% /tabs %\} #### Meta 리퍼러 연동 -The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer) using the Adjust Meta Install Referrer plugin. [See the Unity Meta Install Referrer plugin for integration details](/ko/sdk/unity/plugins/meta-referrer-plugin). +Adjust SDK는 Adjust Meta 설치 리퍼러 플러그인을 사용하는 [Meta 설치 리퍼러](https://developers.facebook.com/docs/app-ads/meta-install-referrer)를 지원합니다. [연동에 대한 자세한 내용은 Unity Meta 설치 리퍼러 플러그인을 참조하시기 바랍니다](/en/sdk/unity/plugins/meta-referrer-plugin). -## 5. SDK 서명 설정 {% #set-up-sdk-signature %} +5\. SDK 서명 설정 \{% \#set\-up\-sdk\-signature %\} +------------------------------------------------------ -Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/ko/article/sdk-signature)의 지침을 따르시기 바랍니다. +Adjust SDK와 Adjust 서버 간 커뮤니케이션의 보안을 위해 SDK 서명 라이브러리를 사용하려면 [Adjust 헬프 센터에 있는 SDK 서명 가이드](https://help.adjust.com/en/article/sdk-signature)의 지침을 따르시기 바랍니다. -## 6. 앱 빌드 {% #build-your-app %} +6\. 앱 빌드 \{% \#build\-your\-app %\} +----------------------------------------- Adjust Unity 패키지를 사용하면 앱 빌드 절차를 완료하기 위해 빌드 완료 후 커스텀 작업을 수행하여, Adjust SDK가 앱 내에서 작동하도록 할 수 있습니다. 이 과정은 `OnPostprocessBuild` 메서드에 의해 `AdjustEditor.cs` 내에서 수행됩니다. -빌드 후(post-build) 옵션을 구성하여 앱 빌드를 맞춤화할 수 있습니다. +빌드 후\(post\-build\) 옵션을 구성하여 앱 빌드를 맞춤화할 수 있습니다. ![Unity Editor 내 Adjust SDK의 빌드 완료 후 구성 스크립의 스크린샷.](@images/unity/2-postbuild.png) -{% tabs %} -{% tab title="iOS" icon="PlatformIos" %} -{% callout type="important" %} -To run the iOS post-build process, make sure that you have **iOS build support** installed in the Unity Editor. -{% /callout %} +\{% tabs %\} +\{% tab title="iOS" icon="PlatformIos" %\} +\{% callout type="important" %\} +iOS 빌드 이후 절차를 진행하려면, Unity Editor에서 **iOS 빌드 지원** 이 되는지 확인하시기 바랍니다. +\{% /callout %\} iOS 빌드 후 절차는 생성한 Xcode 프로젝트를 다음과 같이 변경합니다. -* Objective-C exceptions 활성화. +* Objective\-C exceptions 활성화. -#### Frameworks {% #frameworks %} +#### 프레임워크 \{% \#frameworks %\} iOS 기능에 액세스하기 위해 다음의 프레임워크를 활성화할 수 있습니다. @@ -180,55 +189,55 @@ iOS 기능에 액세스하기 위해 다음의 프레임워크를 활성화할 * `AppTrackingTransparency.framework`: 사용자에게 측정 동의 여부를 묻기 위해 필요 * `StoreKit.framework`: SKAdNetwork 프레임워크와 통신하기 위해 필요 -#### App Tracking Transparency 동의 다이얼로그 {% #app-tracking-transparency-consent-dialog %} +#### App Tracking Transparency 동의 다이얼로그 \{% \#app\-tracking\-transparency\-consent\-dialog %\} -ATT(App Tracking Transparency) 래퍼를 사용하는 경우, **User Tracking Description** 메시지를 입력하시기 바랍니다. 이는 사용자 화면에 ATT 동의 다이얼로그를 표시할 때 나타납니다. +ATT\(App Tracking Transparency\) 래퍼를 사용하는 경우, **User Tracking Description** 메시지를 입력하시기 바랍니다. 이는 사용자 화면에 ATT 동의 다이얼로그를 표시할 때 나타납니다. -#### 딥링크 {% #deep-linking %} +#### 딥링크 \{% \#deep\-linking %\} 딥링크를 활성화하려면, 다음의 정보를 추가하시기 바랍니다. * **iOS 유니버설 링크 도메인** : 유니버설 링크에 사용되는 관련 도메인. * **iOS URL 식별자** : 앱의 번들 ID. -* \**iOS URL 스킴*\* : 앱과 관련된 URL 스킴. -{% /tab %} +* **iOS URL 스킴** : 앱과 관련된 URL 스킴. \{% /tab %\} -{% tab title="Android" icon="PlatformAndroid" %} -The Android post-build process checks for an `AndroidManifest.xml` file in `Assets/Plugins/Android/`. If this file isn't present, it creates a copy from [`AdjustAndroidManifest.xml`](https://github.com/adjust/unity_sdk/blob/master/Assets/Adjust/Native/Android/AdjustAndroidManifest.xml "GitHub 내 AdjustAndroidManifest 파일 링크"). +\{% tab title="Android" icon="PlatformAndroid" %\} +Android 빌드 후 과정에서는 `AndroidManifest.xml` 파일이 `Assets/Plugins/Android/` 안에 있는지 찾습니다. 이 파일이 없는 경우, [`AdjustAndroidManifest.xml`](https://github.com/adjust/unity_sdk/blob/master/Assets/Adjust/Native/Android/AdjustAndroidManifest.xml "GitHub 내 AdjustAndroidManifest 파일 링크") 사본을 생성합니다. -#### Permissions {% #permissions %} +#### 권한 \{% \#permissions %\} Android 기능에 액세스하려면 다음의 권한을 활성화하시기 바랍니다. -* `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. +* `android.permission.INTERNET`: 인터넷 연결에 필요. +* `android.permission.ACCESS_NETWORK_STATE`: 기기가 연결된 네트워크의 유형을 읽기 위해 필요. * `com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE` **지원 중단** : Google Play Store 인텐트를 통해 설치 리퍼러 정보를 가져오기 위해 필요. -* `com.google.android.gms.permission.AD_ID`: Android 12(API 레벨 31) 이상에서 기기의 광고 ID를 읽기 위해 필요. 자세한 정보는 [Google의 `AdvertisingIdClient.info` 문서](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)를 참조하시기 바랍니다. +* `com.google.android.gms.permission.AD_ID`: Android 12\(API 레벨 31\) 이상에서 기기의 광고 ID를 읽기 위해 필요. 자세한 정보는 [Google의 `AdvertisingIdClient.info` 문서](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)를 참조하시기 바랍니다. -#### 딥링크 {% #deep-linking-1 %} +#### 딥링크 \{% \#deep\-linking\-1 %\} 딥링크를 활성화하려면, 다음의 정보를 추가하시기 바랍니다. **Android URI Schemes** : 딥링크의 목적지. -{% /tab %} -{% /tabs %} +\{% /tab %\} \{% /tabs %\} -The output of the process is shown in the Unity IDE console window. +프로세스의 결과는 Unity IDE 콘솔 창에 표시됩니다. -## 7. 연동 테스트 {% #test-your-integration %} +7\. 연동 테스트 \{% \#test\-your\-integration %\} +-------------------------------------------------- -{% callout type="tip" %} -If you encounter any issues, email [support@adjust.com](mailto:support@adjust.com) with all details and logs. -{% /callout %} +\{% callout type="tip" %\} +문제 발생 시, 모든 상세 내용과 로그를 [support@adjust.com](mailto:support@adjust.com)로 전송하시기 바랍니다. +\{% /callout %\} Adjust SDK는 연동 테스트와 문제 해결 툴을 제공합니다. 다음과 같이 설정을 테스트하시기 바랍니다. * 환경을 `AdjustEnvironment.Sandbox`로 설정합니다. * Adjust 대시보드 결과에 샌드박스 필터를 추가합니다. -* [로그 수준](/ko/sdk/unity/configuration#set-your-logging-level)을 `AdjustLogLevel.Verbose`로 설정합니다. +* [로그 수준](/en/sdk/unity/configuration#set-your-logging-level)을 `AdjustLogLevel.Verbose`로 설정합니다. -### Google Play Services 연동 테스트 {% #test-google-play-services-integration %} +### Google Play Services 연동 테스트 \{% \#test\-google\-play\-services\-integration %\} -Adjust SDK가 기기의 Google 광고 ID를 수신할 수 있는지 테스트하려면 [로그 수준](/ko/sdk/unity/configuration#set-your-logging-level)을 `AdjustLogLevel.Verbose`로 설정하고, 환경을 `AdjustEnvironment.Sandbox`로 설정합니다. 앱을 시작하고 `session` 또는 이벤트를 측정합니다. SDK가 광고 ID를 읽으면 gps_adid(Google 플레이 서비스 광고주 ID) 파라미터를 로깅합니다. +Adjust SDK가 기기의 Google 광고 ID를 수신할 수 있는지 테스트하려면 [로그 수준](/en/sdk/unity/configuration#set-your-logging-level)을 `AdjustLogLevel.Verbose`로 설정하고, 환경을 `AdjustEnvironment.Sandbox`로 설정합니다. 앱을 시작하고 `session` 또는 이벤트를 측정합니다. SDK가 광고 ID를 읽으면 gps\_adid\(Google 플레이 서비스 광고주 ID\) 파라미터를 로깅합니다. Google광고 ID를 읽을 수 없다면 Adjust의 [Github repository](https://github.com/adjust/unity_sdk)에 이슈를 제기하거나 [support@adjust.com](mailto:support@adjust.com)으로 메일 주시기 바랍니다. + diff --git a/src/content/docs/ko/sdk/unity/v5/plugins/index.mdoc b/src/content/docs/ko/sdk/unity/v5/plugins/index.mdoc new file mode 100644 index 000000000..d281c849a --- /dev/null +++ b/src/content/docs/ko/sdk/unity/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "서드파티 플러그인" +description: "타사 플러그인을 사용하여 타사 SDK의 정보를 Adjust로 전달합니다." +category-title: "플러그인" +slug: "en/sdk/unity/plugins" +type: "category" +sidebar-position: 4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/unity/v4/plugins" +--- +플러그인을 사용하여 정보를 타사 플러그인으로 전달합니다. + diff --git a/src/content/docs/ko/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc b/src/content/docs/ko/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc new file mode 100644 index 000000000..9886f93a4 --- /dev/null +++ b/src/content/docs/ko/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc @@ -0,0 +1,49 @@ +--- +title: "Meta 설치 리퍼러" +description: "Meta 설치 리퍼러 플러그인을 사용하여 Meta 설치 리퍼러 정보를 Adjust에 전송합니다." +slug: "en/sdk/unity/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/ko/sdk/unity/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +Adjust SDK는 [Meta가 요구](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)하는 `` 요소를 번들로 제공합니다. 이를 `AndroidManifest.xml`에 추가할 필요는 없습니다. +\{% /callout %\} + +Meta 설치 리퍼러 플러그인은 Adjust SDK가 기기에서 Meta 설치 리퍼러 값을 읽을 수 있도록 해줍니다. 이후 SDK는 해당 정보를 설치 페이로드의 일부로서 Adjust 서버에 전송합니다. + +앱에 플러그인을 추가하는 방법: + +1. 다음의 디펜던시를 `Dependencies.xml` 파일에 추가합니다. + + ```xml + + ``` + + 또는 Android 스튜디오에서 `build.gradle` 파일에 다음의 디펜던시를 추가합니다. + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. [앱 대시보드](https://developers.facebook.com/apps)에서 Meta 앱 ID를 확인합니다. 자세한 내용은 Meta의 [앱 대시보드 문서](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)를 참조하시기 바랍니다. + +3. 앱 ID를 `AdjustConfig` 인스턴스의 `FbAppId` 속성에 할당합니다. + + ```cs + AdjustConfig config = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); + //... + config.FbAppId = "{FB_APP_ID_STRING}"; + //... + Adjust.InitSdk(config); + ``` + diff --git a/src/content/docs/zh/sdk/android/v5/index.mdoc b/src/content/docs/zh/sdk/android/v5/index.mdoc index 77491260a..716f4e1bf 100644 --- a/src/content/docs/zh/sdk/android/v5/index.mdoc +++ b/src/content/docs/zh/sdk/android/v5/index.mdoc @@ -1,26 +1,28 @@ --- -title: 安卓 SDK 集成指南 -description: 使用安卓 SDK 在您的安卓应用中使用 Adjust 功能 -category-title: 安卓 SDK -slug: zh/sdk/android +title: "安卓 SDK 集成指南" +description: "使用安卓 SDK 在您的安卓应用中使用 Adjust 功能" +category-title: "安卓 SDK" +slug: "en/sdk/android" sidebar-position: 1 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /zh/sdk/android/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/android/v4" --- - 通过 Adjust安卓SDK,您可以在安卓应用中记录归因、事件及更多数据。请按照本指南中说明的步骤操作,在应用内设置 Adjust SDK。 -{% callout type="important" %} -Adjust SDK 支持安卓 API 级别 21 (Lollipop) 或更高级别。 -{% /callout %} +\{% callout type="important" %\} +Adjust SDK 支持安卓 API 级别 21 \(Lollipop\) 或更高级别。 +\{% /callout %\} -## 1. 设置环境{% #set-up-your-environment %} +1\. 设置环境\{% \#set\-up\-your\-environment %\} +--------------------------------------------------- 要开始使用 Adjust SDK,您首先要将其作为依赖添加至项目中。Adjust SDK 可在[Maven](https://maven.apache.org)上使用。 @@ -37,9 +39,10 @@ Adjust SDK 支持安卓 API 级别 21 (Lollipop) 或更高级别。 } ``` -## 2. 添加 Google Play 服务{% #add-google-play-services %} +2\. 添加 Google Play 服务\{% \#add\-google\-play\-services %\} +----------------------------------------------------------------- -定向到 Google Play 商店的应用必须使用`gps_adid`(Google 广告 ID) 来识别设备。要访问 `gps_adid`,请向项目中添加 `play-services-ads-identifier` AAR。 +定向到 Google Play 商店的应用必须使用`gps_adid`\(Google 广告 ID\) 来识别设备。要访问 `gps_adid`,请向项目中添加 `play-services-ads-identifier` AAR。 如果您使用的是 Maven,请将以下行添加至您的 `build.gradle` 文件: @@ -49,7 +52,8 @@ dependencies { } ``` -## 3. 添加权限{% #add-permissions %} +3\. 添加权限\{% \#add\-permissions %\} +--------------------------------------- 要授予 Adjust SDK 读取设备信息的权限,您需要声明应用所需的权限。为此,请在 `AndroidManifest.xml` 文件中添加权限。 @@ -66,13 +70,14 @@ dependencies { ``` -Adjust SDK 默认包含 `com.google.android.gms.AD_ID` 权限。如果您要让应用符合 COPPA (儿童在线隐私保护法) 规定,或者应用并不面向 Google Play 商店,请务必使用 `remove` 命令移除权限。 +Adjust SDK 默认包含 `com.google.android.gms.AD_ID` 权限。如果您要让应用符合 COPPA \(儿童在线隐私保护法\) 规定,或者应用并不面向 Google Play 商店,请务必使用 `remove` 命令移除权限。 ```xml ``` -## 4. 设置 Proguard{% #set-up-proguard %} +4\. 设置 Proguard\{% \#set\-up\-proguard %\} +------------------------------------------------ 如果您使用 Proguard 优化应用,那么请务必添加规则,避免Proguard 移除类: @@ -97,11 +102,12 @@ Adjust SDK 默认包含 `com.google.android.gms.AD_ID` 权限。如果您要让 -keep public class com.adjust.sdk.** { *; } ``` -## 5. 设置 Install Referrer{% #set-up-install-referrer %} +5\. 设置 Install Referrer\{% \#set\-up\-install\-referrer %\} +------------------------------------------------------------------ Install Referrer 是一种唯一标识符,可用来将安装归因至来源。Adjust SDK 需要该信息进行归因。您可以使用下列方法之一调取 install referrer 信息: -### Google Play Referrer API{% #google-play-referrer-api %} +### Google Play Referrer API\{% \#google\-play\-referrer\-api %\} 面向 Google Play 商店的应用可以使用 Google Play Referrer API。 @@ -119,7 +125,7 @@ dependencies { -keep public class com.android.installreferrer.** { *; } ``` -### 华为 Referrer API{% #huawei-referrer-api %} +### 华为 Referrer API\{% \#huawei\-referrer\-api %\} 面向华为设备的应用可以使用华为 Referrer API。Adjust SDK 可以使用 Adjust Huawei Referrer 插件记录华为设备上的安装。 @@ -131,36 +137,38 @@ dependencies { } ``` -### 小米 referrer 插件{% #xiaomi-referrer-plugin %} +### 小米 referrer 插件\{% \#xiaomi\-referrer\-plugin %\} -借助小米 referrer 插件,您可以记录面向小米设备应用的 Install Referrer 值。请查看[插件相关文档](/zh/sdk/android/plugins/xiaomi-referrer),了解安装信息。 +借助小米 referrer 插件,您可以记录面向小米设备应用的 Install Referrer 值。请查看[插件相关文档](/en/sdk/android/plugins/xiaomi-referrer),了解安装信息。 -### Samsung referrer 插件{% #samsung-referrer-plugin %} +### Samsung referrer 插件\{% \#samsung\-referrer\-plugin %\} -借助 Samsung referrer 插件,您可以记录面向 Samsung Galaxy Store 的应用的 Install Referrer 值。请查看[插件相关文档](/zh/sdk/android/plugins/samsung-referrer-plugin),了解安装信息。 +借助 Samsung referrer 插件,您可以记录面向 Samsung Galaxy Store 的应用的 Install Referrer 值。请查看[插件相关文档](/en/sdk/android/plugins/samsung-referrer-plugin),了解安装信息。 -### Meta referrer 集成{% #meta-referrer-integration %} +### Meta referrer 集成\{% \#meta\-referrer\-integration %\} -通过 Adjust Meta Install Referrer 插件,Adjust SDK 可以支持 [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer)。[请参阅文档了解集成详情](/zh/sdk/android/plugins/meta-referrer-plugin)。 +通过 Adjust Meta Install Referrer 插件,Adjust SDK 可以支持 [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer)。[请参阅文档了解集成详情](/en/sdk/android/plugins/meta-referrer-plugin)。 -## 6. 设置 SDK 签名{% #set-up-sdk-signature %} +6\. 设置 SDK 签名\{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------- -如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/zh/article/sdk-signature)进行操作。 +如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/en/article/sdk-signature)进行操作。 -## 7. 集成 Adjust SDK{% #integrate-the-adjust-sdk %} +7\. 集成 Adjust SDK\{% \#integrate\-the\-adjust\-sdk %\} +------------------------------------------------------------- 初始化 Adjust SDK 必需信息如下: -* `appToken`: 您的 [Adjust 应用识别码](https://help.adjust.com/zh/article/app-settings#view-your-app-token)。 +* `appToken`: 您的 [Adjust 应用识别码](https://help.adjust.com/en/article/app-settings#view-your-app-token)。 * `environment`: 应用运行的环境。要在本地测试应用,请设置为`AdjustConfig.ENVIRONMENT_SANDBOX`。 我们建议您在全局安卓[Application 类](http://developer.android.com/reference/android/app/Application.html)中初始化 Adjust SDK。如果您还没有为自己的应用完成该设置,请按照下列步骤进行设置: 1. 创建一个扩展 `Application`的类。 -1. 打开 `AndroidManifest.xml` 文件,找到 `` 元素。 +2. 打开 `AndroidManifest.xml` 文件,找到 `` 元素。 -1. 添加 `android:name` 属性至 `` 元素,并将其设置为 Application 类的名称。例如,如果您的 `Application` 类名称为 `GlobalApplication`,那么您可以进行如下设置: +3. 添加 `android:name` 属性至 `` 元素,并将其设置为 Application 类的名称。例如,如果您的 `Application` 类名称为 `GlobalApplication`,那么您可以进行如下设置: ```xml @@ -168,14 +176,14 @@ dependencies { ``` -1. 在 `Application` 类中找到 `initSdk` 方法;如果方法不存在,请进行添加。传送下列参数,以初始化 Adjust SDK: +4. 在 `Application` 类中找到 `initSdk` 方法;如果方法不存在,请进行添加。传送下列参数,以初始化 Adjust SDK: * 您的 `appToken` * 应用运行预期 `environment` * 要记录的 `LogLevel` -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; @@ -192,9 +200,11 @@ class GlobalApplication : Application () { } } ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java import com.adjust.sdk.Adjust; import com.adjust.sdk.AdjustConfig; @@ -212,25 +222,25 @@ public class GlobalApplication extends Application { } } ``` -{% /tab %} -{% /tabs %} -### 集成 Adjust Web View SDK{% #integrate-the-adjust-web-view-sdk %} +\{% /tab %\}\{% /tabs %\} + +### 集成 Adjust Web View SDK\{% \#integrate\-the\-adjust\-web\-view\-sdk %\} 如果您的应用使用的是 web 视图,请通过 Adjust Web View SDK 记录信息。您需要获得对 `WebView` 对象的引用。完成后,请按照下列步骤操作: 1. 调用 `webView.getSettings().setJavaScriptEnabled(true)` 在 web view 中启用 Javascript。 -1. 调用 `AdjustBridge.registerAndGetInstance(getApplication(), webview)`,启动默认 `AdjustBridgeInstance`。这会将 Adjust bridge 注册为 web view 的 Javascript 接口。 +2. 调用 `AdjustBridge.registerAndGetInstance(getApplication(), webview)`,启动默认 `AdjustBridgeInstance`。这会将 Adjust bridge 注册为 web view 的 Javascript 接口。 -1. 调用 `AdjustBridge.setWebView()`,已设置新的 `WebView`。 +3. 调用 `AdjustBridge.setWebView()`,已设置新的 `WebView`。 -1. 调用 `AdjustBridge.unregister()` 来注销 `AdjustBridgeInstance` 和 `WebView` 。 +4. 调用 `AdjustBridge.unregister()` 来注销 `AdjustBridgeInstance` 和 `WebView` 。 -1. 完整设置示例如下: +5. 完整设置示例如下: + + \{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} - {% tabs %} - {% tab title="Kotlin" sync="kotlin" %} ```kotlin class MainActivity : Activity() { override fun onCreate(savedInstanceState: Bundle?) { @@ -257,9 +267,11 @@ public class GlobalApplication extends Application { } } ``` - {% /tab %} - {% tab title="Java" sync="java" %} + \{% /tab %\} + + \{% tab title="Java" sync="java" %\} + ```java public class MainActivity extends Activity { @Override @@ -288,10 +300,9 @@ public class GlobalApplication extends Application { } } ``` - {% /tab %} - {% /tabs %} -1. 在 HTML 中导入 Adjust Javascript 文件: + \{% /tab %\}\{% /tabs %\} +6. 在 HTML 中导入 Adjust Javascript 文件: ```html @@ -300,7 +311,7 @@ public class GlobalApplication extends Application { ``` -1. 现在,您可以将 `appToken` 和 `environment` 传送至 `AdjustConfig` 类,以在 web 视图中初始化 Adjust SDK: +7. 现在,您可以将 `appToken` 和 `environment` 传送至 `AdjustConfig` 类,以在 web 视图中初始化 Adjust SDK: ```js let yourAppToken = "{YourAppToken}"; @@ -310,32 +321,35 @@ public class GlobalApplication extends Application { Adjust.initSdk(adjustConfig); ``` -## 8. 针对生产环境构建应用{% #build-your-app-for-production %} +8\. 针对生产环境构建应用\{% \#build\-your\-app\-for\-production %\} +----------------------------------------------------------------- 完成测试后,您就可以针对生产环境构建应用了。为此,请更新您的 config 对象。 1. 调整日志等级,仅返回您需要的信息。 +2. 将您的 `environment` 设为 `AdjustConfig.ENVIRONMENT_PRODUCTION`。 -1. 将您的 `environment` 设为 `AdjustConfig.ENVIRONMENT_PRODUCTION`。 +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} - {% tabs %} - {% tab title="Kotlin" sync="kotlin" %} - ```kotlin - val appToken = "{YourAppToken}" - val environment = AdjustConfig.ENVIRONMENT_PRODUCTION; - val config = AdjustConfig(this, appToken, environment) - config.setLogLevel(LogLevel.WARN) - Adjust.initSdk(config) - ``` - {% /tab %} +```kotlin +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_PRODUCTION; +val config = AdjustConfig(this, appToken, environment) +config.setLogLevel(LogLevel.WARN) +Adjust.initSdk(config) +``` + +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + +```java +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_PRODUCTION; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setLogLevel(LogLevel.WARN) +Adjust.initSdk(config); +``` + +\{% /tab %\}\{% /tabs %\} - {% tab title="Java" sync="java" %} - ```java - String appToken = "{YourAppToken}"; - String environment = AdjustConfig.ENVIRONMENT_PRODUCTION; - AdjustConfig config = new AdjustConfig(this, appToken, environment); - config.setLogLevel(LogLevel.WARN) - Adjust.initSdk(config); - ``` - {% /tab %} - {% /tabs %} diff --git a/src/content/docs/zh/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc b/src/content/docs/zh/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc index ad8f66b89..789ed1628 100644 --- a/src/content/docs/zh/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc +++ b/src/content/docs/zh/sdk/android/v5/plugins/samsung-referrer-plugin.mdoc @@ -1,30 +1,33 @@ --- -title: Samsung referrer -description: 使用 Samsung referrer 将 Samsung 的信息发送至 Adjust。 -slug: zh/sdk/android/plugins/samsung-referrer-plugin -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /zh/sdk/android/v4/plugins/samsung-referrer-plugin +title: "Samsung referrer" +description: "使用 Samsung referrer 将 Samsung 的信息发送至 Adjust。" +slug: "en/sdk/android/plugins/samsung-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/android/v4/plugins/samsung-referrer-plugin" --- - 通过 Samsung referrer 插件,Adjust SDK 可以读取设备上的 amsung Galaxy store install referrer 值。SDK 随后会将此信息作为安装 payload 的一部分发送至 Adjust 服务器。 所有支持 Samsung install referrer 库的设备都有 Samsung install referrer。 -## 操作前须知 {% #before-you-begin %} +操作前须知 \{% \#before\-you\-begin %\} +--------------------------------------- -要将 Adjust SDK 集成进应用,请按[入门指南](/zh/sdk/android)中的说明操作。 +要将 Adjust SDK 集成进应用,请按[入门指南](/en/sdk/android)中的说明操作。 -## 安装 Samsung referrer 插件{% #install-the-samsung-referrer-plugin %} +安装 Samsung referrer 插件\{% \#install\-the\-samsung\-referrer\-plugin %\} +------------------------------------------------------------------------------ 安装 Samsung referrer 插件有两种方式: -### Maven {% #maven %} +### Maven \{% \#maven %\} 将以下依赖添加至 Adjust SDK 声明下的`build.gradle`文件。 @@ -33,11 +36,12 @@ implementation 'com.adjust.sdk:adjust-android:{% $versions.android.v5 %}' implementation 'com.adjust.sdk:adjust-android-samsung-referrer:{% $versions.android.v5 %}' ``` -### JAR {% #jar %} +### JAR \{% \#jar %\} 您可以在[GitHub 发布页面](https://github.com/adjust/android_sdk/releases/latest)找到 Samsung referrer 插件。 -## 添加 Samsung install referrer 库{% #add-the-samsung-install-referrer-library %} +添加 Samsung install referrer 库\{% \#add\-the\-samsung\-install\-referrer\-library %\} +-------------------------------------------------------------------------------------------- 要读取 referrer 值,您必须将 Samsung install referrer 添加至应用。要了解更多信息,请与 Samsung 联系人联系,或发送邮件至 [support@samsungdevelopers.com](mailto:support@samsungdevelopers.com)。 @@ -47,7 +51,8 @@ implementation 'com.adjust.sdk:adjust-android-samsung-referrer:{% $versions.andr implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:3.0.1' ``` -## ProGuard 设置{% #proguard-settings %} +ProGuard 设置\{% \#proguard\-settings %\} +------------------------------------------- 如果使用 Proguard,则必须添加规则,保证创建过程中重要的类不会被移除。 @@ -63,42 +68,48 @@ implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_instal -keep class com.sec.android.app.samsungapps.installreferrer.** { *; } ``` -## 使用插件{% #use-the-plugin %} +使用插件\{% \#use\-the\-plugin %\} +----------------------------------- Samnsung referrer 插件默认为 **开启** 状态。您可以使用 AdjustSamsungReferrer 类方法来开启或关闭`AdjustSamsungReferrer`的读取。 要 **禁用** install referrer 读取,请在初始化 SDK **之前** 调用 `AdjustSamsungReferrer.doNotReadSamsungReferrer()`。 -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin AdjustSamsungReferrer.doNotReadSamsungReferrer() Adjust.initSdk(adjustConfig) ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java AdjustSamsungReferrer.doNotReadSamsungReferrer(); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} 要 **启用** install referrer 读取,请在初始化 SDK **之前** 调用 `AdjustSamsungReferrer.readSamsungReferrer(applicationContext)`。 -{% tabs %} -{% tab title="Kotlin" sync="kotlin" %} +\{% tabs %\}\{% tab title="Kotlin" sync="kotlin" %\} + ```kotlin AdjustSamsungReferrer.readSamsungReferrer(applicationContext) Adjust.initSdk(adjustConfig) ``` -{% /tab %} -{% tab title="Java" sync="java" %} +\{% /tab %\} + +\{% tab title="Java" sync="java" %\} + ```java AdjustSamsungReferrer.readSamsungReferrer(applicationContext); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} + diff --git a/src/content/docs/zh/sdk/cordova/v5/index.mdoc b/src/content/docs/zh/sdk/cordova/v5/index.mdoc index effcc9386..29cb54b40 100644 --- a/src/content/docs/zh/sdk/cordova/v5/index.mdoc +++ b/src/content/docs/zh/sdk/cordova/v5/index.mdoc @@ -1,21 +1,24 @@ --- -title: Cordova SDK 集成指南 -description: 使用 Cordova SDK 在 Cordova 应用中访问 Adjust 功能 -category-title: Cordova SDK -slug: zh/sdk/cordova +title: "Cordova SDK 集成指南" +description: "使用 Cordova SDK 在 Cordova 应用中访问 Adjust 功能" +category-title: "Cordova SDK" +slug: "en/sdk/cordova" sidebar-position: 6 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /zh/sdk/cordova/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/cordova/v4" --- 通过 Adjust Cordova SDK,您可以在 Cordova 应用中监测归因、事件及更多数据。请按照本指南中说明的步骤操作,在应用内设置 Adjust SDK。您还可以在 [GitHub](https://github.com/adjust/cordova_sdk/tree/master/example-cordova) 上查看示例应用。 -## 1\. 添加 SDK 至您的项目{% #add-the-sdk-to-your-project %} +1\. 添加 SDK 至您的项目\{% \#add\-the\-sdk\-to\-your\-project %\} +------------------------------------------------------------------- Adjust Cordova SDK 在 npm 中作为插件提供。要将其添加到您的项目中, @@ -39,9 +42,10 @@ Installing "com.adjust.sdk" for ios > ionic cordova plugin add com.adjust.sdk ``` -## 2\. 设置安卓设备{% #set-up-android-devices %} +2\. 设置安卓设备\{% \#set\-up\-android\-devices %\} +---------------------------------------------------- -### 添加权限{% #add-permissions %} +### 添加权限\{% \#add\-permissions %\} Adjust SDK 默认包含 `com.google.android.gms.AD_ID`和`android.permission.INTERNET`权限。如果您的应用需要符合 COPPA 的要求或不针对 Google Play 商店,则可以通过添加`remove`指令将`AD_ID`删除。 @@ -51,15 +55,16 @@ Adjust SDK 默认包含 `com.google.android.gms.AD_ID`和`android.permission.INT ``` -{% callout type="seealso" %} +\{% callout type="seealso" %\} 请查看 Google 的[`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)文档,了解更多与该许可相关的信息。 -{% /callout %} +\{% /callout %\} -### 设置 Install Referrer{% #set-up-install-referrer %} +### 设置 Install Referrer\{% \#set\-up\-install\-referrer %\} -Adjust SDK 默认支持[Google Play Referrer API](https://developer.android.com/google/play/installreferrer)。Meta Install Referrer 可作为安卓插件使用。[要了解集成细节,请参考 Cordova Meta Install Referrer 插件。](/zh/sdk/cordova/plugins/meta-referrer-plugin) +Adjust SDK 默认支持[Google Play Referrer API](https://developer.android.com/google/play/installreferrer)。Meta Install Referrer 可作为安卓插件使用。[要了解集成细节,请参考 Cordova Meta Install Referrer 插件。](/en/sdk/cordova/plugins/meta-referrer-plugin) -## 3\. 添加 iOS 框架{% #add-ios-frameworks %} +3\. 添加 iOS 框架\{% \#add\-ios\-frameworks %\} +------------------------------------------------- Adjust SDK 会自动在 iOS 设备上关联下列框架。 @@ -70,22 +75,22 @@ Adjust SDK 会自动在 iOS 设备上关联下列框架。 | `StoreKit.framework` | 允许访问 SKAdNetwork 框架 | 若要允许 Adjust 处理 iOS 14 或更新操作版本设备上与 SKAdNetwork 的通讯,那么必须添加该框架。 | | `AppTrackingTransparency.framework` | 若要允许 Adjust SDK 包装用户跟踪许可对话,并读取 iOS 14 或更新操作版本设备的许可响应,那么必须添加该框架。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架 | -## 4\. 设置 SDK 签名{% #set-up-sdk-signature %} +4\. 设置 SDK 签名\{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------- -如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/zh/article/sdk-signature)进行操作。 +如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/en/article/sdk-signature)进行操作。 -## 5\. 初始化 Adjust SDK{% #initialize-the-adjust-sdk %} +5\. 初始化 Adjust SDK\{% \#initialize\-the\-adjust\-sdk %\} +--------------------------------------------------------------- - - -{% callout type="important" %} +\{% callout type="important" %\} 在进行测试时,应当确保将环境设置为 `AdjustConfig.EnvironmentSandbox`。请在向应用商店提交应用前将此设为 `AdjustConfig.EnvironmentProduction`。 -{% /callout %} +\{% /callout %\} 请确保在 Cordova 应用中尽快初始化 Adjust SDK。为此请进行下列操作: 1. 请使用以下信息实例化一个`AdjustConfig`对象: - * `appToken`: 您的 [Adjust 应用识别码](https://help.adjust.com/zh/article/app-settings#view-your-app-token)。 + * `appToken`: 您的 [Adjust 应用识别码](https://help.adjust.com/en/article/app-settings#view-your-app-token)。 * `environment`: 应用运行的环境。要在本地测试应用,请设置为`AdjustConfig.EnvironmentSandbox`。 2. 将您的`AdjustConfig`实例传递至`Adjust.initSdk`方法来初始化 SDK。 @@ -98,13 +103,15 @@ var adjustConfig = new AdjustConfig( Adjust.initSdk(adjustConfig); ``` -## 6\. 构建您的应用{% #build-your-app %} +6\. 构建您的应用\{% \#build\-your\-app %\} +------------------------------------------ 完成了!您现在可以创建并运行 Cordova 应用了。请启用日志,检查可能存在的问题。请查看日志中的 `Install tracked` 信息。 您现在已经准备就绪,可以使用 Adjust SDK 进行用户归因了。 -## 7\. 测试集成{% #test-your-integration %} +7\. 测试集成\{% \#test\-your\-integration %\} +----------------------------------------------- 采用 Adjust SDK 提供的工具,您可以测试并排除集成出现的问题。要测试集成,请按照下列步骤操作: @@ -114,7 +121,7 @@ Adjust.initSdk(adjustConfig); 如果遇到任何问题,请发送邮件至 [support@adjust.com](mailto:support@adjust.com),并在邮件中说明所有详情和日志。 -### 测试 Google Play 服务集成{% #test-google-play-services-integration %} +### 测试 Google Play 服务集成\{% \#test\-google\-play\-services\-integration %\} 要测试 Adjust SDK 能否接收设备的 Google 广告 ID,请将日志级别设为 **verbose** ,环境设为 **Sandbox** 。启动应用,监测一次会话或事件。如果 SDK 记录了 `gps_adid` \(Google Play 服务广告主 ID\) 参数,就说明已经成功读取广告 ID。 diff --git a/src/content/docs/zh/sdk/cordova/v5/plugins/index.mdoc b/src/content/docs/zh/sdk/cordova/v5/plugins/index.mdoc new file mode 100644 index 000000000..bdc77e4b2 --- /dev/null +++ b/src/content/docs/zh/sdk/cordova/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "第三方插件" +description: "使用第三方插件,从第三方 SDK 向 Adjust 传送信息。" +category-title: "插件" +slug: "en/sdk/cordova/plugins" +type: "category" +sidebar-position: 5 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/cordova/v4" +--- +使用插件向第三方插件传送信息。 + diff --git a/src/content/docs/zh/sdk/cordova/v5/plugins/meta-install-referrer.mdoc b/src/content/docs/zh/sdk/cordova/v5/plugins/meta-install-referrer.mdoc new file mode 100644 index 000000000..86b0d36b2 --- /dev/null +++ b/src/content/docs/zh/sdk/cordova/v5/plugins/meta-install-referrer.mdoc @@ -0,0 +1,44 @@ +--- +title: "Meta Install Referrer" +description: "使用 Meta Install Referrer 插件向 Adjust 发送 Meta Install Referrer 信息。" +slug: "en/sdk/cordova/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/cordova/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +Adjust SDK 会打包 [Meta 要求](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)的``元素。您无需将这些元素添加至`AndroidManifest.xml`。 +\{% /callout %\} + +通过 Meta Install Referrer 插件,Adjust SDK 可以读取设备上的Meta Install Referrer 值。SDK 随后会将此信息作为安装 payload 的一部分发送至 Adjust 服务器。 + +要将插件添加至您的应用: + +1. 将以下依赖添加至您的 `build.gradle` 文件: + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. 在[应用控制面板](https://developers.facebook.com/apps)中找到您的 Meta app ID。更多信息,请参考 Meta 的[应用控制面板文档](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)。 + +3. 在`AdjustConfig`实例上将您的 App ID 指定至`fbAppId`属性。 + + ```js + var adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox, + ); + adjustConfig.setFbAppId("FB_APP_ID"); + Adjust.initSdk(adjustConfig); + ``` + diff --git a/src/content/docs/zh/sdk/flutter/v5/index.mdoc b/src/content/docs/zh/sdk/flutter/v5/index.mdoc index b20500f60..550bdbd86 100644 --- a/src/content/docs/zh/sdk/flutter/v5/index.mdoc +++ b/src/content/docs/zh/sdk/flutter/v5/index.mdoc @@ -1,26 +1,28 @@ --- -title: Flutter SDK 集成指南 -description: 使用 Flutter SDK 在您的 Flutter 应用中使用 Adjust 功能 -category-title: Flutter SDK -slug: zh/sdk/flutter +title: "Flutter SDK 集成指南" +description: "使用 Flutter SDK 在您的 Flutter 应用中使用 Adjust 功能" +category-title: "Flutter SDK" +slug: "en/sdk/flutter" sidebar-position: 5 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /zh/sdk/flutter/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/flutter/v4" --- - 通过 Adjust Flutter SDK,您可以在 Flutter 应用中监测归因、事件以及更多信息。请按照本指南中说明的步骤操作,在应用内设置 Adjust SDK。您还可以在 [GitHub](https://github.com/adjust/flutter_sdk/tree/master/example) 上查看示例应用。 -{% callout type="important" %} -Adjust SDK 支持 iOS 12 或更新版本,以及安卓 API 级别 21 (Lollipop) 或更新版本。 -{% /callout %} +\{% callout type="important" %\} +Adjust SDK 支持 iOS 12 或更新版本,以及安卓 API 级别 21 \(Lollipop\) 或更新版本。 +\{% /callout %\} -## 1. 添加 SDK 至您的项目{% #add-the-sdk-to-your-project %} +1\. 添加 SDK 至您的项目\{% \#add\-the\-sdk\-to\-your\-project %\} +------------------------------------------------------------------- 要在您的 Flutter 应用中使用 [Adjust Flutter SDK](https://github.com/adjust/flutter_sdk/releases),请先将 SDK 加入项目。 @@ -33,29 +35,30 @@ Adjust SDK 支持 iOS 12 或更新版本,以及安卓 API 级别 21 (Lollipop) adjust_sdk: ^{% $versions.flutter.v5 %} ``` -1. 找到您的项目并运行以下指令。编辑 `pubspec.yaml` 文件后,Visual Studio 会自动运行该命令。 +2. 找到您的项目并运行以下指令。编辑 `pubspec.yaml` 文件后,Visual Studio 会自动运行该命令。 ```console $ flutter packages get ``` -## 2. 设置安卓设备{% #set-up-android-devices %} +2\. 设置安卓设备\{% \#set\-up\-android\-devices %\} +---------------------------------------------------- -### 添加 Google Play 服务{% #add-google-play-services %} +### 添加 Google Play 服务\{% \#add\-google\-play\-services %\} -定向 Google Play 商店的应用必须使用 [Google 广告 ID](https://support.google.com/googleplay/android-developer/answer/6048248?hl=en) (`gps_adid`) 来识别设备。为此,请将以下 dependency 加入`build.gradle` 文件的 `dependencies` 部分。 +定向 Google Play 商店的应用必须使用 [Google 广告 ID](https://support.google.com/googleplay/android-developer/answer/6048248?hl=en) \(`gps_adid`\) 来识别设备。为此,请将以下 dependency 加入`build.gradle` 文件的 `dependencies` 部分。 ```groovy implementation 'com.google.android.gms:play-services-ads-identifier:18.1.0' ``` -{% callout type="note" %} +\{% callout type="note" %\} Adjust SDK 并不与任何版本的 `play-services-ads-identifier`依赖绑定。您可以使用任意版本的 Google Play 服务库。 -{% /callout %} +\{% /callout %\} -### 添加权限{% #add-permissions %} +### 添加权限\{% \#add\-permissions %\} -Adjust SDK 需要下列权限。(如尚未添加) 请将其添加至您的 `AndroidManifest.xml` 文件中: +Adjust SDK 需要下列权限。\(如尚未添加\) 请将其添加至您的 `AndroidManifest.xml` 文件中: ```xml @@ -67,11 +70,11 @@ Adjust SDK 默认包含 `com.google.android.gms.AD_ID` 权限。如果您的应 ``` -{% callout type="seealso" %} +\{% callout type="seealso" %\} 请查看 Google 的[`AdvertisingIdClient.Info documentation`](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid)文档,了解更多与该许可相关的信息。 -{% /callout %} +\{% /callout %\} -### 设置 Install Referrer{% #set-up-install-referrer %} +### 设置 Install Referrer\{% \#set\-up\-install\-referrer %\} Install Referrer 是一种唯一标识符,可用来将应用安装归因至来源。Adjust SDK 需要该信息进行归因。 @@ -87,43 +90,48 @@ implementation 'com.android.installreferrer:installreferrer:2.2' #### Meta referrer 集成 -通过 Adjust Meta Install Referrer 插件,Adjust SDK 可以支持 [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer)。[要了解集成细节,请参考 Flutter Meta 安装 Referrer 插件。](/zh/sdk/flutter/plugins/meta-referrer-plugin) +通过 Adjust Meta Install Referrer 插件,Adjust SDK 可以支持 [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer)。[要了解集成细节,请参考 Flutter Meta 安装 Referrer 插件。](/en/sdk/flutter/plugins/meta-referrer-plugin) -## 3. 添加 iOS 框架{% #add-ios-frameworks %} +3\. 添加 iOS 框架\{% \#add\-ios\-frameworks %\} +------------------------------------------------- -在应用中添加特定 iOS 框架后,Adjust SDK 就能获取额外信息。这些框架可以支持特定 SDK 功能,但即便没有这些框架,SDK 也能正常工作。您可以添加这些框架,然后在 **Project Settings --> Build Phases --> Link Binary With Libraries** 下将其设置为 **可选** 。 +在应用中添加特定 iOS 框架后,Adjust SDK 就能获取额外信息。这些框架可以支持特定 SDK 功能,但即便没有这些框架,SDK 也能正常工作。您可以添加这些框架,然后在 **Project Settings \-\-> Build Phases \-\-> Link Binary With Libraries** 下将其设置为 **可选** 。 -| 框架 | 描述 | 注意事项 | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `AdSupport.framework` | 允许读取设备 IDFA。对于操作系统为 iOS 14 及更早版本的设备,添加该框架也会允许读取 LAT 信息。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架 | -| `AdServices.framework` | 处理 Apple Search Ads 归因 | | -| `StoreKit.framework` | 允许访问 SKAdNetwork 框架 | 若要允许 Adjust 处理 iOS 14 或更新操作版本设备上与 SKAdNetwork 的通讯,那么必须添加该框架。 | -| `AppTrackingTransparency.framework` | 若要允许 Adjust SDK 包装用户 ATT 许可对话,并读取 iOS 14 或更新操作版本设备的许可响应,那么必须添加该框架。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架 | +| 框架 | 描述 | 注意事项 | +|-------------------------------------|--------------------------------------------------------------------|--------------------------------------------------------------| +| `AdSupport.framework` | 允许读取设备 IDFA。对于操作系统为 iOS 14 及更早版本的设备,添加该框架也会允许读取 LAT 信息。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架 | +| `AdServices.framework` | 处理 Apple Search Ads 归因 | | +| `StoreKit.framework` | 允许访问 SKAdNetwork 框架 | 若要允许 Adjust 处理 iOS 14 或更新操作版本设备上与 SKAdNetwork 的通讯,那么必须添加该框架。 | +| `AppTrackingTransparency.framework` | 若要允许 Adjust SDK 包装用户 ATT 许可对话,并读取 iOS 14 或更新操作版本设备的许可响应,那么必须添加该框架。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架 | -## 4. 设置 SDK 签名{% #set-up-sdk-signature %} +4\. 设置 SDK 签名\{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------- -如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/zh/article/sdk-signature)进行操作。 +如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/en/article/sdk-signature)进行操作。 -## 5. 初始化 Adjust SDK{% #initialize-the-adjust-sdk %} +5\. 初始化 Adjust SDK\{% \#initialize\-the\-adjust\-sdk %\} +--------------------------------------------------------------- 请确保在 Flutter 应用中尽快初始化 Adjust SDK。要进行 SDK 初始化,请使用应用识别码及您希望应用程序运行的环境来初始化 config 对象。 -{% callout type="important" %} +\{% callout type="important" %\} 在进行测试时,应当确保将环境设置为 `AdjustEnvironment.sandbox`。请在向应用商店提交应用前将此设为 `AdjustEnvironment.production`。 -{% /callout %} +\{% /callout %\} ```dart AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); Adjust.initSdk(config); ``` -## 6. 构建您的应用{% #build-your-app %} +6\. 构建您的应用\{% \#build\-your\-app %\} +------------------------------------------ 完成了!您现在可以创建并运行 Flutter 应用了。请启用日志,检查可能存在的问题。请查看日志中的 `Install tracked` 信息。 您现在已经准备就绪,可以使用 Adjust SDK 进行用户归因了。 -## 7. 测试集成{% #test-your-integration %} +7\. 测试集成\{% \#test\-your\-integration %\} +----------------------------------------------- 采用 Adjust SDK 提供的工具,您可以测试并排除集成出现的问题。要测试集成,请按照下列步骤操作: @@ -131,12 +139,13 @@ Adjust.initSdk(config); * 在 Adjust 控制面板结果中添加 sandbox 过滤器。 * 将日志级别设为 `AdjustLogLevel.verbose`。 -{% callout type="tip" %} +\{% callout type="tip" %\} 如果遇到任何问题,请发送邮件至 [support@adjust.com](mailto:support@adjust.com),并在邮件中说明所有详情和日志。 -{% /callout %} +\{% /callout %\} -### 测试 Google Play 服务集成{% #test-google-play-services-integration %} +### 测试 Google Play 服务集成\{% \#test\-google\-play\-services\-integration %\} -要测试 Adjust SDK 能否接收设备的 Google 广告 ID,请将日志级别设为 `AdjustLogLevel.verbose`,环境设为 `AdjustEnvironment.sandbox`。启动应用,监测一次会话或事件。如果 SDK 记录了 `gps_adid` (Google Play 服务广告主 ID) 参数,就说明已经成功读取广告 ID。 +要测试 Adjust SDK 能否接收设备的 Google 广告 ID,请将日志级别设为 `AdjustLogLevel.verbose`,环境设为 `AdjustEnvironment.sandbox`。启动应用,监测一次会话或事件。如果 SDK 记录了 `gps_adid` \(Google Play 服务广告主 ID\) 参数,就说明已经成功读取广告 ID。 如果您在获取 Google 广告 ID 时遇到任何问题,请在我们的 SDK [GitHub 库](https://github.com/adjust/flutter_sdk)中提问,或联系 [support@adjust.com](mailto:support@adjust.com)。 + diff --git a/src/content/docs/zh/sdk/flutter/v5/plugins/index.mdoc b/src/content/docs/zh/sdk/flutter/v5/plugins/index.mdoc new file mode 100644 index 000000000..c482556d2 --- /dev/null +++ b/src/content/docs/zh/sdk/flutter/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "第三方插件" +description: "使用第三方插件,从第三方 SDK 向 Adjust 传送信息。" +category-title: "插件" +slug: "en/sdk/flutter/plugins" +type: "category" +sidebar-position: 5 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/flutter/v4" +--- +使用插件向第三方插件传送信息。 + diff --git a/src/content/docs/zh/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc b/src/content/docs/zh/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc new file mode 100644 index 000000000..f195db2df --- /dev/null +++ b/src/content/docs/zh/sdk/flutter/v5/plugins/meta-referrer-plugin.mdoc @@ -0,0 +1,41 @@ +--- +title: "Meta Install Referrer" +description: "使用 Meta Install Referrer 插件向 Adjust 发送 Meta Install Referrer 信息。" +slug: "en/sdk/flutter/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/flutter/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +Adjust SDK 会打包 [Meta 要求](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)的``元素。您无需将这些元素添加至`AndroidManifest.xml`。 +\{% /callout %\} + +通过 Meta Install Referrer 插件,Adjust SDK 可以读取设备上的Meta Install Referrer 值。SDK 随后会将此信息作为安装 payload 的一部分发送至 Adjust 服务器。 + +要将插件添加至您的应用: + +1. 将以下依赖添加至您的 `build.gradle` 文件: + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. 在[应用控制面板](https://developers.facebook.com/apps)中找到您的 Meta app ID。更多信息,请参考 Meta 的[应用控制面板文档](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)。 + +3. 在`AdjustConfig`实例上将您的 App ID 指定至`fbAppId`属性。 + + ```dart + AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); + config.fbAppId = ""; + Adjust.initSdk(AdjustConfig); + ``` + diff --git a/src/content/docs/zh/sdk/ios/v5/index.mdoc b/src/content/docs/zh/sdk/ios/v5/index.mdoc index febc41d88..2ca4460e5 100644 --- a/src/content/docs/zh/sdk/ios/v5/index.mdoc +++ b/src/content/docs/zh/sdk/ios/v5/index.mdoc @@ -1,39 +1,40 @@ --- -title: iOS SDK 集成指南 -description: 使用 iOS SDK 在您的 iOS 应用中使用 Adjust 功能 -category-title: iOS SDK -slug: zh/sdk/ios +title: "iOS SDK 集成指南" +description: "使用 iOS SDK 在您的 iOS 应用中使用 Adjust 功能" +category-title: "iOS SDK" +slug: "en/sdk/ios" sidebar-position: 2 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /zh/sdk/ios/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/ios/v4" --- - 通过 Adjust iOS SDK,您可以在 iOS 应用中记录归因、事件以及更多信息。该指南展示了如何将 Adjust SDK 集成至应用。 -{% callout type="important" %} -Adjust SDK 支持 iOS 12 或更新版本。 -{% /callout %} +\{% callout type="important" %\} +Adjust SDK 支持 iOS 12 或更新版本。\{% /callout %\} -## 1. 添加 SDK 至您的项目{% #add-the-sdk-to-your-project %} +1\. 添加 SDK 至您的项目\{% \#add\-the\-sdk\-to\-your\-project %\} +------------------------------------------------------------------- 要在您的 iOS 应用中使用 Adjust SDK,请先将 SDK 加入 Xcode 项目。 要使用 Swift package manager 添加 SDK: -1. 选择 **File --> Swift Packages --> Add Package Dependency** -1. 在出现的文本框中输入 SDK 的 GitHub 地址: `https://github.com/adjust/ios_sdk` -1. 在 **Version** 下拉菜单中选择要使用的 Adjust SDK 版本。请查看[发布页面](https://github.com/adjust/ios_sdk/releases),找到最新版本。 +1. 选择 **File \-\-> Swift Packages \-\-> Add Package Dependency** +2. 在出现的文本框中输入 SDK 的 GitHub 地址: `https://github.com/adjust/ios_sdk` +3. 在 **Version** 下拉菜单中选择要使用的 Adjust SDK 版本。请查看[发布页面](https://github.com/adjust/ios_sdk/releases),找到最新版本。 -### 其他安装方法{% #alternative-installation-methods %} +### 其他安装方法\{% \#alternative\-installation\-methods %\} -{% tabs %} -{% tab title="Cocoapods" sync="cocoapods" %} +\{% tabs %\} +\{% tab title="Cocoapods" sync="cocoapods" %\} 要使用 Cocoapods 添加 SDK,请在 `Podfile` 中指定要使用的版本: ```rb @@ -46,117 +47,124 @@ pod 'Adjust', '~> {% $versions.ios.v5 %}' ```rb pod 'Adjust/AdjustWebBridge', '~> {% $versions.ios.v5 %}' ``` -{% /tab %} -{% tab title="Carthage" sync="carthage" %} +\{% /tab %\} + +\{% tab title="Carthage" sync="carthage" %\} 要使用 Carthage 添加 SDK,请将下列内容添加至您的 `Cartfile`: ```text github "adjust/ios_sdk" ``` -{% /tab %} -{% /tabs %} -## 2. 集成 Adjust SDK{% #integrate-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} + +2\. 集成 Adjust SDK\{% \#integrate\-the\-adjust\-sdk %\} +------------------------------------------------------------- 将 Adjust SDK 添加到 `Xcode` 项目后,您需要将其集成至应用。 在您的项目文件中添加相关导入语句: -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\} +\{% tab title="Swift" sync="swift" %\} 要导入 Adjust SDK,请将下列行添加至您的桥接标头文件: ```swift import AdjustSdk ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} 要导入 Adjust SDK,请将下列行添加至您的`AppDelegate.h`文件: ```objc #import ``` -{% /tab %} -{% /tabs %} -## 3. 添加 iOS 框架{% #add-ios-frameworks %} +\{% /tab %\}\{% /tabs %\} + +3\. 添加 iOS 框架\{% \#add\-ios\-frameworks %\} +------------------------------------------------- Adjust SDK 依赖各种框架读取具体设备信息。要启用设备信息读取,请添加对应框架,并将其标记为 **可选** 。 -| 框架 | 描述 | 注意事项 | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `AdSupport.framework` | 允许读取设备 IDFA。对于操作系统为 iOS 14 及更早版本的设备,添加该框架也会允许读取 LAT 信息。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架。 | -| `AdServices.framework` | 处理 ASA 归因。 | | -| `StoreKit.framework` | 允许访问 SKAdNetwork 框架。 | 若要允许 Adjust 处理 iOS 14 或更新操作版本设备上与 SKAdNetwork 的通讯,那么必须添加该框架。 | -| `AppTrackingTransparency.framework` | 若要允许 Adjust SDK 包装用户 ATT 许可对话,并读取 iOS 14 或更新操作版本设备的许可响应,那么必须添加该框架。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架 | -| `WebKit.framework` | 允许在您的应用中使用 web 视图。 | 只有在应用使用 web 视图时才有必要 | +| 框架 | 描述 | 注意事项 | +|-------------------------------------|--------------------------------------------------------------------|--------------------------------------------------------------| +| `AdSupport.framework` | 允许读取设备 IDFA。对于操作系统为 iOS 14 及更早版本的设备,添加该框架也会允许读取 LAT 信息。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架。 | +| `AdServices.framework` | 处理 ASA 归因。 | | +| `StoreKit.framework` | 允许访问 SKAdNetwork 框架。 | 若要允许 Adjust 处理 iOS 14 或更新操作版本设备上与 SKAdNetwork 的通讯,那么必须添加该框架。 | +| `AppTrackingTransparency.framework` | 若要允许 Adjust SDK 包装用户 ATT 许可对话,并读取 iOS 14 或更新操作版本设备的许可响应,那么必须添加该框架。 | 如果您的应用属于 "儿童" 类别,那么请勿添加该框架 | +| `WebKit.framework` | 允许在您的应用中使用 web 视图。 | 只有在应用使用 web 视图时才有必要 | -## 4. 设置 SDK 签名{% #set-up-sdk-signature %} +4\. 设置 SDK 签名\{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------- -如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/zh/article/sdk-signature)进行操作。 +如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/en/article/sdk-signature)进行操作。 -## 5. (可选) 设置 Adjust Web Bridge{% #set-up-web-bridge %} +5\. \(可选\) 设置 Adjust Web Bridge\{% \#set\-up\-web\-bridge %\} +---------------------------------------------------------------------- 如果您的应用使用的是 web 视图,请务必设置 Adjust Web Bridge,以记录 web 视图中的信息。 -### 将 `AdjustBridge` 集成到您的应用中{% #integrate-adjustbridge-into-your-app %} +### 将 `AdjustBridge` 集成到您的应用中\{% \#integrate\-adjustbridge\-into\-your\-app %\} 在项目导航中: -1. 打开您的视图控制器 (View Controller) 源文件。 - -1. 在文件顶端添加 `import` 导入语句。 - -1. 在 Web View Delegate 的 `viewDidLoad` 或 `viewWillAppear` 方法中,添加下列 `AdjustBridge` 调用: - - {% tabs %} - {% tab title="Swift" sync="swift" %} - ```swift - import AdjustSdk - - func viewWillAppear(_ animated: Bool) { - let webView = WKWebView(frame: view.bounds) - - // add var adjustBridge: AdjustBridge? on your interface - adjustBridge.loadWKWebViewBridge(webView) - } - ``` - {% /tab %} - - {% tab title="Objective-C" sync="objc" %} - ```objc - #import "" - - - (void)viewWillAppear:(BOOL)animated { - WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds]; - - // add @property (nonatomic, strong) AdjustBridge *adjustBridge; on your interface - [self.adjustBridge loadWKWebViewBridge:webView]; - } - - // Your code here - ``` - {% /tab %} - {% /tabs %} +1. 打开您的视图控制器 \(View Controller\) 源文件。 +2. 在文件顶端添加 `import` 导入语句。 +3. 在 Web View Delegate 的 `viewDidLoad` 或 `viewWillAppear` 方法中,添加下列 `AdjustBridge` 调用: + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + +```swift +import AdjustSdk + +func viewWillAppear(_ animated: Bool) { + let webView = WKWebView(frame: view.bounds) + + // add var adjustBridge: AdjustBridge? on your interface + adjustBridge.loadWKWebViewBridge(webView) +} +``` -#### 将 `AdjustBridge` 集成进您的 web 视图{% #integrate-adjustbridge-into-your-web-view %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + +```objc +#import "" + +- (void)viewWillAppear:(BOOL)animated { + WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds]; + + // add @property (nonatomic, strong) AdjustBridge *adjustBridge; on your interface + [self.adjustBridge loadWKWebViewBridge:webView]; +} + +// Your code here +``` + +\{% /tab %\}\{% /tabs %\} + +#### 将 `AdjustBridge` 集成进您的 web 视图\{% \#integrate\-adjustbridge\-into\-your\-web\-view %\} 要在 web 视图上使用 Javascript bridge,您就需要配置 bridge。请添加下列 Javascript 代码,初始化 Adjust iOS web bridge: -{% tabs %} -{% tab title="Javascript" sync="js" %} +\{% tabs %\}\{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -## 6. 初始化 Adjust SDK{% #initialize-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} + +6\. 初始化 Adjust SDK\{% \#initialize\-the\-adjust\-sdk %\} +--------------------------------------------------------------- 要初始化 Adjust SDK,您需要创建一个 config 对象。该对象包含控制 Adjust SDK 行为的配置选项。发送以下参数能够保证最少的设置: @@ -166,11 +174,11 @@ Adjust.initSdk(adjustConfig); 要使用此 config 对象初始化 Adjust SDK: 1. 在您应用委托的 `didFinishLaunching` 或 `didFinishLaunchingWithOptions` 方法中声明 config 对象。 -1. 将 config 对象的 `logLevel` 属性设置为 `ADJLogLevelVerbose` (详细)。您必须启用 verbose 日志记录,才能调取设备信息。 -1. 将 config 对象作为参数发送至`initSdk`方法。 +2. 将 config 对象的 `logLevel` 属性设置为 `ADJLogLevelVerbose` \(详细\)。您必须启用 verbose 日志记录,才能调取设备信息。 +3. 将 config 对象作为参数发送至`initSdk`方法。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -179,61 +187,64 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau let yourAppToken = "{YourAppToken}" let environment = ADJEnvironmentSandbox let adjustConfig = ADJConfig(appToken: yourAppToken, - environment: environment) + environment: environment) Adjust.initSdk(adjustConfig) - //... + //... return true -} + } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - NSString *yourAppToken = @"{YourAppToken}"; - NSString *environment = ADJEnvironmentSandbox; - ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken + NSString *yourAppToken = @"{YourAppToken}"; + NSString *environment = ADJEnvironmentSandbox; + ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken environment:environment]; - // Your code here - [Adjust initSdk:myAdjustConfig]; - // Your code here - return YES; + // Your code here + [Adjust initSdk:myAdjustConfig]; + // Your code here + return YES; } ``` -{% /tab %} -{% tab title="Javascript" sync="js" %} +\{% /tab %\} + +\{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -### 设置您的 iMessage 应用{% #set-up-your-imessage-app %} +\{% /tab %\}\{% /tabs %\} + +### 设置您的 iMessage 应用\{% \#set\-up\-your\-imessage\-app %\} -{% callout type="important" %} -iMessage 拓展拥有不同的 Bundle ID,并在不同的内容空间中运行。如果您在两者的配置中使用了同样的识别码,那么 SDK 就会返回混合数据。请务必在 Adjust 控制面板中为 iMessage 应用创建单独的应用,然后使用单独的识别码初始化 Adjust SDK。 -{% /callout %} +\{% callout type="important" %\} +iMessage 拓展拥有不同的 Bundle ID,并在不同的内容空间中运行。如果您在两者的配置中使用了同样的识别码,那么 SDK 就会返回混合数据。请务必在 Adjust 控制面板中为 iMessage 应用创建单独的应用,然后使用单独的识别码初始化 Adjust SDK。\{% /callout %\} 如果您的应用面向 iMessage,那么您还需要进行下列额外的配置: * 如果您是从源代码添加 Adjust SDK,请确保您已在 iMessage 项目中添加了预处理宏 `ADJUST_IM=1`。 * 如果您将 SDK 作为框架添加,请务必在 **Build Phases** 项目设置中添加 **New Copy Files Phase** 。将 `AdjustSdkIm.framework` 复制到 Frameworks 文件夹。 -#### 记录会话{% #record-sessions %} +#### 记录会话\{% \#record\-sessions %\} Adjust SDK 并未订阅 iMessage 应用中的 iOS 系统通知。要在应用进入或离开前台时通知 Adjust SDK,请调用 `trackSubsessionStart` 和 `trackSubsessionEnd` 方法。 在 `didBecomeActiveWithConversation:` 方法中添加对 `trackSubsessionStart` 的调用: -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func didBecomeActive(with conversation: MSConversation) { // Called when the extension is about to move from the inactive to active state. @@ -243,9 +254,11 @@ func didBecomeActive(with conversation: MSConversation) { Adjust.trackSubsessionStart() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)didBecomeActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the inactive to active state. @@ -255,13 +268,13 @@ func didBecomeActive(with conversation: MSConversation) { [Adjust trackSubsessionStart]; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} 在 `willResignActiveWithConversation:` 方法中添加对 `trackSubsessionEnd` 的调用: -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func willResignActive(with conversation: MSConversation) { // Called when the extension is about to move from the active to inactive state. @@ -275,9 +288,11 @@ func willResignActive(with conversation: MSConversation) { Adjust.trackSubsessionEnd() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)willResignActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the active to inactive state. @@ -291,30 +306,33 @@ func willResignActive(with conversation: MSConversation) { [Adjust trackSubsessionEnd]; } ``` -{% /tab %} -{% /tabs %} -## 7. 配置 Adjust SDK{% #configure-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} -添加 config 对象和初始化逻辑后,您可以配置 Adjust SDK 来记录应用不同部分的信息。请查看[配置参考](/zh/sdk/ios/configuration)和[功能指南](/zh/sdk/ios/features)准确设置您想记录的内容。 +7\. 配置 Adjust SDK\{% \#configure\-the\-adjust\-sdk %\} +------------------------------------------------------------- -## 8. 测试 Adjust SDK{% #test-the-adjust-sdk %} +添加 config 对象和初始化逻辑后,您可以配置 Adjust SDK 来记录应用不同部分的信息。请查看[配置参考](/en/sdk/ios/configuration)和[功能指南](/en/sdk/ios/features)准确设置您想记录的内容。 -完成配置,能通过 Adjust SDK 记录应用相关信息后,您就可以进行测试了。Adjust 为您提供[测试控制台](https://help.adjust.com/zh/article/testing-console)和[设备 ID](https://help.adjust.com/zh/article/device-api),方便您测试应用。 +8\. 测试 Adjust SDK\{% \#test\-the\-adjust\-sdk %\} +-------------------------------------------------------- -请按照[测试指南](https://help.adjust.com/zh/article/test-the-adjust-sdk)中的说明操作,确保您的应用能将预期值发送给 Adjust。 +完成配置,能通过 Adjust SDK 记录应用相关信息后,您就可以进行测试了。Adjust 为您提供[测试控制台](https://help.adjust.com/en/article/testing-console)和[设备 ID](https://help.adjust.com/en/article/device-api),方便您测试应用。 -## 9. 针对生产环境构建应用{% #build-your-app-for-production %} +请按照[测试指南](https://help.adjust.com/en/article/test-the-adjust-sdk)中的说明操作,确保您的应用能将预期值发送给 Adjust。 + +9\. 针对生产环境构建应用\{% \#build\-your\-app\-for\-production %\} +----------------------------------------------------------------- 完成测试后,您就可以针对生产环境构建应用了。为此,请更新您的 config 对象。 更新以下值: * `environment`: 将其设为`ADJEnvironmentProduction` 。 -* `logLevel`: 选择[日志级别](/zh/sdk/ios/configuration#set-your-logging-level),或在 config 对象中传送 `allowSuppressLogLevel` 参数,以完全禁用日志记录。 +* `logLevel`: 选择[日志级别](/en/sdk/ios/configuration#set-your-logging-level),或在 config 对象中传送 `allowSuppressLogLevel` 参数,以完全禁用日志记录。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -329,36 +347,38 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau adjustConfig?.logLevel = ADJLogLevel.verbose //... Adjust.initSdk(adjustConfig) - //... + //... return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - NSString *yourAppToken = @"{YourAppToken}"; - NSString *environment = ADJEnvironmentSandbox; - ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken + NSString *yourAppToken = @"{YourAppToken}"; + NSString *environment = ADJEnvironmentSandbox; + ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken environment:environment suppressLogLevel:YES]; - [adjustConfig setLogLevel:ADJLogLevelVerbose]; - //... - [Adjust initSdk:adjustConfig]; - //... - return YES; + [adjustConfig setLogLevel:ADJLogLevelVerbose]; + //... + [Adjust initSdk:adjustConfig]; + //... + return YES; } ``` -{% /tab %} -{% /tabs %} -您可以使用 `Xcode` 版本标记 (flag),根据您创建的版本 (调试或生产版本) 情况动态更新 config。 +\{% /tab %\}\{% /tabs %\} + +您可以使用 `Xcode` 版本标记 \(flag\),根据您创建的版本 \(调试或生产版本\) 情况动态更新 config。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { // Override point for customization after application launch. @@ -384,32 +404,35 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - NSString *yourAppToken = @"{YourAppToken}"; + NSString *yourAppToken = @"{YourAppToken}"; - #if DEBUG - NSString *environment = ADJEnvironmentSandbox; - ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken + #if DEBUG + NSString *environment = ADJEnvironmentSandbox; + ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken environment:environment]; - [adjustConfig setLogLevel:ADJLogLevelVerbose]; + [adjustConfig setLogLevel:ADJLogLevelVerbose]; - #else - NSString *environment = ADJEnvironmentProduction; - ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken + #else + NSString *environment = ADJEnvironmentProduction; + ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken environment:environment]; - [adjustConfig setLogLevel:ADJLogLevelSuppress]; - #endif - //... - [Adjust initSdk:adjustConfig]; - //... - return YES; + [adjustConfig setLogLevel:ADJLogLevelSuppress]; + #endif + //... + [Adjust initSdk:adjustConfig]; + //... + return YES; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} + diff --git a/src/content/docs/zh/sdk/unity/v4/plugins/index.mdoc b/src/content/docs/zh/sdk/unity/v4/plugins/index.mdoc new file mode 100644 index 000000000..9c425de99 --- /dev/null +++ b/src/content/docs/zh/sdk/unity/v4/plugins/index.mdoc @@ -0,0 +1,19 @@ +--- +title: "第三方插件" +description: "使用第三方插件,从第三方 SDK 向 Adjust 传送信息。" +category-title: "插件" +type: "category" +sidebar-position: 4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v5: "/en/sdk/unity/plugins" +--- +使用插件向第三方插件传送信息。 + diff --git a/src/content/docs/zh/sdk/unity/v5/index.mdoc b/src/content/docs/zh/sdk/unity/v5/index.mdoc index 18993664b..e52966c0e 100644 --- a/src/content/docs/zh/sdk/unity/v5/index.mdoc +++ b/src/content/docs/zh/sdk/unity/v5/index.mdoc @@ -1,78 +1,81 @@ --- -title: Unity SDK 集成 -description: 使用 Unity SDK,在 Unity 应用中使用 Adjust 功能。 -category-title: Unity SDK -slug: zh/sdk/unity +title: "Unity SDK 集成" +description: "使用 Unity SDK,在 Unity 应用中使用 Adjust 功能。" +category-title: "Unity SDK" +slug: "en/sdk/unity" sidebar-position: 3 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /zh/sdk/unity/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/unity/v4" --- - 通过 Adjust Unity SDK,您可以在 Unity 应用中记录归因、事件以及更多信息。请按照本指南中说明的步骤操作,在应用内设置 Adjust SDK。 -{% callout type="note" %} -Adjust SDK 支持 iOS 12 或更新版本,以及安卓 API 级别 21 (Lollipop) 或更新版本。 -{% /callout %} +操作前须知 \{% \#before\-you\-begin %\} +--------------------------------------- + +Here's what you need to know before you get started: + +* Adjust SDK 支持 iOS 12 或更新版本,以及安卓 API 级别 21 \(Lollipop\) 或更新版本。 +* The Adjust SDK is compatible with Unity Editor 2018\.2 or later. -## 1. 获取 Adjust SDK{% #get-the-adjust-sdk %} +1\. 获取 Adjust SDK\{% \#get\-the\-adjust\-sdk %\} +------------------------------------------------------- 要安装 Adjust SDK,请选择下列方法之一。 -### 安装 Unity 包{% #install-unity-package %} +### 安装 Unity 包\{% \#install\-unity\-package %\} 要在您的 Unity 应用中使用 Adjust SDK,请先将 SDK 加入项目。您可以从[GitHub 发布页面](https://github.com/adjust/adjust_unity_sdk/releases/latest)下载最新版本的 SDK。 要向 Unity 项目中导入 Adjust SDK,请按照下列步骤操作: 1. 打开 Unity Editor。 -1. 选择 **Assets --> Import Package --> Custom Package** 。 -1. 选择已下载的 SDK 包。 +2. 选择 **Assets \-\-> Import Package \-\-> Custom Package** 。 +3. 选择已下载的 SDK 包。 -### 使用 Unity Package Manager{% #use-the-unity-package-manager %} +### 使用 Unity Package Manager\{% \#use\-the\-unity\-package\-manager %\} 要使用 Unity Package Manager 安装 Adjust SDK,请按照下列步骤操作: 1. 在 Unity 编辑器中选择 **Package Manager** 窗口。 -1. 选择 **Add package from git URL** 。 -1. 输入以下 URL:`https://github.com/adjust/unity_sdk.git?path=Assets/Adjust` . - -## 2. 安装 iOS 和安卓 SDK {% #install-ios-and-android-sdks %} - -SDK v5 不再使用 iOS 和安卓 SDK 作为二进制依赖。要安装底层 iOS 和安卓 SDK,您需要使用[External Dependency Manager for Unity (EDM4U)](https://github.com/googlesamples/unity-jar-resolver)从 CocoaPods 和 Maven 安装包。 - -要确保为 iOS 正确加载隐私清单和框架,您需要禁用静态链接。为此请进行下列操作: +2. 选择 **Add package from git URL** 。 +3. 输入以下 URL:`https://github.com/adjust/unity_sdk.git?path=Assets/Adjust` . -1. 选择 **Assets -> External Dependency Manager -> iOS Resolver -> Settings** 。 -1. 找到 **Link frameworks statically** 选项并取消选中。 +2\. 安装 iOS 和安卓 SDK \{% \#install\-ios\-and\-android\-sdks %\} +--------------------------------------------------------------------- -![A screenshot of the resolver settings menu](@images/unity/link-frameworks-statically.png) +\{% minorversion +changed="v5\.0\.4" +link="[https://github.com/adjust/unity\_sdk/releases/tag/v5\.0\.4](https://github.com/adjust/unity_sdk/releases/tag/v5.0.4)" %\} +SDK v5 no longer uses the iOS and Android SDKs as binary dependencies. To install the underlying iOS and Android SDKs, you need to use the [External Dependency Manager for Unity \(EDM4U\)](https://github.com/googlesamples/unity-jar-resolver) to install the packages from CocoaPods and Maven. +\{% /minorversion %\} -## 3. 集成 SDK{% #integrate-the-sdk %} +3\. 集成 SDK\{% \#integrate\-the\-sdk %\} +--------------------------------------------- Adjust SDK 包含一个 Unity [prefab](https://docs.unity3d.com/Manual/Prefabs.html),其中含有模板游戏对象和一个 Adjust 脚本。您可以使用该脚本配置 SDK。要在 Unity editor 中打开 prefab,请按照下列步骤操作: 1. 将 `Assets/Adjust/Adjust.prefab` 的 prefab 添加到您的第一个场景。 -1. 打开 prefab 的 Inspector Menu。 -1. prefab 菜单包含可编辑的字段,通过这些字段,您可以控制 Adjust SDK 的行为。 +2. 打开 prefab 的 Inspector Menu。 +3. prefab 菜单包含可编辑的字段,通过这些字段,您可以控制 Adjust SDK 的行为。 ![Adjust SDK 在 Unity editor 中的 prefab 配置脚本截图。](@images/unity/1-prefab.png) 要设置 Adjust SDK,请输入下列信息: 1. 您的 **应用识别码** 。请查看应用设置,了解查找识别码的办法。 - -1. 您的 **环境** : - +2. 您的 **环境** : * 如要测试应用并发送测试数据,请选择 **Sandbox** 。请在控制面板中启用 sandbox 模式,查看测试数据。 * 如果您已经完成测试,准备发布应用,请选择 **Production** 。 -1. 您的 **日志等级。** 这将控制您收到哪些日志。请查看[这篇文章](/zh/sdk/unity/configuration#set-your-logging-level),进一步了解日志等级设置。 +3. 您的 **日志等级。** 这将控制您收到哪些日志。请查看[这篇文章](/en/sdk/unity/configuration#set-your-logging-level),进一步了解日志等级设置。 当应用的 Awake 事件默认触发时,Adjust 就会初始化。要改变该行为,请勾选 **手动启动 SDK** 。这样您就能使用 config 实例作为参数,调用 `Adjust.InitSdk` 以初始化 Adjust SDK。 @@ -81,14 +84,15 @@ AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment Adjust.InitSdk(adjustConfig); ``` -## 4. 设置安卓设备{% #set-up-android-devices %} +4\. 设置安卓设备\{% \#set\-up\-android\-devices %\} +---------------------------------------------------- -### 添加 Google Play 服务{% #add-google-play-services %} +### 添加 Google Play 服务\{% \#add\-google\-play\-services %\} -定向到 Google Play 商店的应用必须使用 gps_adid (Google 广告 ID) 来识别设备。要访问 `play-services-ads-identifier`,请向项目中添加 `gps_adid` AAR。 +定向到 Google Play 商店的应用必须使用 gps\_adid \(Google 广告 ID\) 来识别设备。要访问 `play-services-ads-identifier`,请向项目中添加 `gps_adid` AAR。 -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} 如果您使用的是[外部依赖管理器插件](https://developers.google.com/unity/archive#external_dependency_manager_for_unity),请将下列行添加至您的`Dependencies.xml`文件: ```xml @@ -96,19 +100,20 @@ Adjust.InitSdk(adjustConfig); ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} -要手动安装 ARR (Android Archive),[请从 Maven 下载](https://maven.google.com/web/index.html#com.google.android.gms:play-services-ads-identifier:18.0.1 "Maven 上 AAR 程序包链接")并添加至`Assets/Plugins/Android`目录。 -{% /tab %} -{% /tabs %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} +要手动安装 ARR \(Android Archive\),[请从 Maven 下载](https://maven.google.com/web/index.html#com.google.android.gms:play-services-ads-identifier:18.0.1 "Maven 上 AAR 程序包链接")并添加至`Assets/Plugins/Android`目录。 +\{% /tab %\} +\{% /tabs %\} -### 收集 App Set Identifier{% #collect-app-set-identifier %} +### 收集 App Set Identifier\{% \#collect\-app\-set\-identifier %\} [App Set Identifier](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId) 是一个唯一标识符,用户在设备上安装您的应用后,您可以通过此标识符监测这些应用的信息。同一位开发者开发的所有应用共享同一个 App Set ID,也就是说您可以从所有应用中收集有用的洞见。 -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} 要记录设备的 App Set ID,您需要将以下依赖添加至您的 `Dependencies.xml`文件: ```xml @@ -116,12 +121,13 @@ Adjust.InitSdk(adjustConfig); ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} -要手动安装 ARR (Android Archive),[请从 Maven 下载](https://maven.google.com/web/index.html#com.google.android.gms:play-services-appset:16.0.2 "Maven 上 AAR 程序包链接")并添加至`Assets/Plugins/Android`目录。 -{% /tab %} -{% /tabs %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} +要手动安装 ARR \(Android Archive\),[请从 Maven 下载](https://maven.google.com/web/index.html#com.google.android.gms:play-services-appset:16.0.2 "Maven 上 AAR 程序包链接")并添加至`Assets/Plugins/Android`目录。 +\{% /tab %\} +\{% /tabs %\} ### 设置 Install Referrer @@ -129,8 +135,8 @@ Install Referrer 是一种唯一标识符,可用来将应用安装归因至来 您可以使用两种方式为 Google Play Referrer API 添加支持: -{% tabs %} -{% tab title="EDM4U" sync="edm4u" %} +\{% tabs %\} +\{% tab title="EDM4U" sync="edm4u" %\} 在[自定义`build.gradle`文件](https://docs.unity3d.com/2023.1/Documentation/Manual/android-gradle-overview.html)中将 Install Referrer 库添加为依赖 ```groovy @@ -138,22 +144,25 @@ dependencies { implementation 'com.android.installreferrer:installreferrer:2.2' } ``` -{% /tab %} -{% tab title="Manual installation" sync="manual" %} -从 [Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer)下载 Install Referrer 库,并将 ARR (Android Archive) 文件放入您的`Plugins/Android`文件夹中。 -{% /tab %} -{% /tabs %} +\{% /tab %\} + +\{% tab title="Manual installation" sync="manual" %\} +从 [Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer)下载 Install Referrer 库,并将 ARR \(Android Archive\) 文件放入您的`Plugins/Android`文件夹中。 +\{% /tab %\} +\{% /tabs %\} #### Meta referrer 集成 -通过 Adjust Meta Install Referrer 插件,Adjust SDK 可以支持 [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer)。[要了解集成细节,请参考 Unity Meta Install Referrer 插件。](/zh/sdk/unity/plugins/meta-referrer-plugin) +通过 Adjust Meta Install Referrer 插件,Adjust SDK 可以支持 [Meta Install Referrer](https://developers.facebook.com/docs/app-ads/meta-install-referrer)。[要了解集成细节,请参考 Unity Meta Install Referrer 插件。](/en/sdk/unity/plugins/meta-referrer-plugin) -## 5. 设置 SDK 签名{% #set-up-sdk-signature %} +5\. 设置 SDK 签名\{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------- -如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/zh/article/sdk-signature)进行操作。 +如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信,请按照[Adjust 帮助中心 SDK 签名指南中的说明](https://help.adjust.com/en/article/sdk-signature)进行操作。 -## 6. 构建您的应用{% #build-your-app %} +6\. 构建您的应用\{% \#build\-your\-app %\} +------------------------------------------ 如需完成应用创建流程,Adjust Unity 包需执行自定义创建后操作,以确保 Adjust SDK 可以在应用内如常运行。 此过程由 `AdjustEditor.cs` 中的 `OnPostprocessBuild` 方法执行。 @@ -161,17 +170,16 @@ dependencies { ![Adjust SDK 在 Unity editor 中的创建后配置脚本截图。](@images/unity/2-postbuild.png) -{% tabs %} -{% tab title="iOS" icon="PlatformIos" %} -{% callout type="important" %} -要执行 iOS 创建后流程,请确保已在 Unity Editor 中安装 **iOS build support** 。 -{% /callout %} +\{% tabs %\} +\{% tab title="iOS" icon="PlatformIos" %\} +\{% callout type="important" %\} +要执行 iOS 创建后流程,请确保已在 Unity Editor 中安装 **iOS build support** 。\{% /callout %\} iOS 创建后流程会对生成的 Xcode 项目作出以下更改: -* 启用 Objective-C 例外情况 +* 启用 Objective\-C 例外情况 -#### 框架{% #frameworks %} +#### 框架\{% \#frameworks %\} 您可以启用下列框架,访问 iOS 功能: @@ -180,55 +188,55 @@ iOS 创建后流程会对生成的 Xcode 项目作出以下更改: * `AppTrackingTransparency.framework`: 用于向用户征求监测许可及获取许可状态 * `StoreKit.framework`: 用来与 SKAdNetwork 框架通讯。 -#### App Tracking Transparency 许可对话框{% #app-tracking-transparency-consent-dialog %} +#### App Tracking Transparency 许可对话框\{% \#app\-tracking\-transparency\-consent\-dialog %\} -如果您使用了 ATT (App Tracking Transparency) 包装器,请输入一条 **用户跟踪描述** 消息。该消息会在用户收到请求许可对话弹窗时展示。 +如果您使用了 ATT \(App Tracking Transparency\) 包装器,请输入一条 **用户跟踪描述** 消息。该消息会在用户收到请求许可对话弹窗时展示。 -#### 深度链接{% #deep-linking %} +#### 深度链接\{% \#deep\-linking %\} 要启用深度链接,请添加下列信息: * **iOS 通用链接域** :用于通用链接的关联域。 * **iOS URL 标识符** :应用的 bundle ID. -* \**iOS URL scheme*\* :与应用关联的 URL scheme。 -{% /tab %} +* **iOS URL scheme** :与应用关联的 URL scheme。 \{% /tab %\} -{% tab title="Android" icon="PlatformAndroid" %} +\{% tab title="Android" icon="PlatformAndroid" %\} 安卓创建后流程会在`Assets/Plugins/Android/`中查找`AndroidManifest.xml`文件。如果不存在该文件,则从[`AdjustAndroidManifest.xml`](https://github.com/adjust/unity_sdk/blob/master/Assets/Adjust/Native/Android/AdjustAndroidManifest.xml "GitHub 上 AdjustAndroidManifest 文件链接")中创建副本。 -#### 权限{% #permissions %} +#### 权限\{% \#permissions %\} 您可以启用下列许可,访问安卓功能: * `android.permission.INTERNET`: 用于连接至互联网。 * `android.permission.ACCESS_NETWORK_STATE`: 用于读取设备所连接到的网络类型。 * `com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE` **已弃用** : 用于通过 Google Play Store intent 调取 install referrer 信息。 -* `com.google.android.gms.permission.AD_ID`: 用于在安卓12 (API level 31) 及更高版本中读取设备广告 ID。请查看 [Google 的`AdvertisingIdClient.info`文档](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid) ,了解更多信息。 +* `com.google.android.gms.permission.AD_ID`: 用于在安卓12 \(API level 31\) 及更高版本中读取设备广告 ID。请查看 [Google 的`AdvertisingIdClient.info`文档](https://developers.google.com/android/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info#public-string-getid) ,了解更多信息。 -#### 深度链接{% #deep-linking-1 %} +#### 深度链接\{% \#deep\-linking\-1 %\} 要启用深度链接,请添加下列信息: **Android URI Schemes** :深度链接的目的地。 -{% /tab %} -{% /tabs %} +\{% /tab %\}\{% /tabs %\} 该过程的输出显示在 Unity IDE 控制台窗口中。 -## 7. 测试集成{% #test-your-integration %} +7\. 测试集成\{% \#test\-your\-integration %\} +----------------------------------------------- -{% callout type="tip" %} +\{% callout type="tip" %\} 如果遇到任何问题,请发送邮件至 [support@adjust.com](mailto:support@adjust.com),并在邮件中说明所有详情和日志。 -{% /callout %} +\{% /callout %\} 采用 Adjust SDK 提供的工具,您可以测试并排除集成出现的问题。要测试集成,请按照下列步骤操作: * 将您的环境设为 `AdjustEnvironment.Sandbox` * 在 Adjust 控制面板结果中添加 sandbox 过滤器。 -* 将[日志级别](/zh/sdk/unity/configuration#set-your-logging-level)设为 `AdjustLogLevel.Verbose`。 +* 将[日志级别](/en/sdk/unity/configuration#set-your-logging-level)设为 `AdjustLogLevel.Verbose`。 -### 测试 Google Play 服务集成{% #test-google-play-services-integration %} +### 测试 Google Play 服务集成\{% \#test\-google\-play\-services\-integration %\} -要测试 Adjust SDK 能否接收设备的 Google 广告 ID,请将[日志级别](/zh/sdk/unity/configuration#set-your-logging-level)设为 `AdjustLogLevel.Verbose`,环境设为 `AdjustEnvironment.Sandbox`。启动应用,监测一次 `session` 或事件。如果 SDK 记录了 gps_adid (Google Play 服务广告主 ID) 参数,就说明已经成功读取广告 ID。 +要测试 Adjust SDK 能否接收设备的 Google 广告 ID,请将[日志级别](/en/sdk/unity/configuration#set-your-logging-level)设为 `AdjustLogLevel.Verbose`,环境设为 `AdjustEnvironment.Sandbox`。启动应用,监测一次 `session` 或事件。如果 SDK 记录了 gps\_adid \(Google Play 服务广告主 ID\) 参数,就说明已经成功读取广告 ID。 如果您在获取 Google 广告 ID 时遇到任何问题,请在 [GitHub 库](https://github.com/adjust/unity_sdk)中提问,或联系 [support@adjust.com](mailto:support@adjust.com)。 + diff --git a/src/content/docs/zh/sdk/unity/v5/plugins/index.mdoc b/src/content/docs/zh/sdk/unity/v5/plugins/index.mdoc new file mode 100644 index 000000000..542465adb --- /dev/null +++ b/src/content/docs/zh/sdk/unity/v5/plugins/index.mdoc @@ -0,0 +1,20 @@ +--- +title: "第三方插件" +description: "使用第三方插件,从第三方 SDK 向 Adjust 传送信息。" +category-title: "插件" +slug: "en/sdk/unity/plugins" +type: "category" +sidebar-position: 4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/unity/v4/plugins" +--- +使用插件向第三方插件传送信息。 + diff --git a/src/content/docs/zh/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc b/src/content/docs/zh/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc new file mode 100644 index 000000000..363b64bb5 --- /dev/null +++ b/src/content/docs/zh/sdk/unity/v5/plugins/meta-referrer-plugin.mdoc @@ -0,0 +1,49 @@ +--- +title: "Meta Install Referrer" +description: "使用 Meta Install Referrer 插件向 Adjust 发送 Meta Install Referrer 信息。" +slug: "en/sdk/unity/plugins/meta-referrer-plugin" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/unity/v4#meta-referrer-integration" +--- +\{% callout type="note" %\} +Adjust SDK 会打包 [Meta 要求](https://developers.facebook.com/docs/app-ads/meta-install-referrer#step-1--add-the-meta-apps)的``元素。您无需将这些元素添加至`AndroidManifest.xml`。 +\{% /callout %\} + +通过 Meta Install Referrer 插件,Adjust SDK 可以读取设备上的Meta Install Referrer 值。SDK 随后会将此信息作为安装 payload 的一部分发送至 Adjust 服务器。 + +要将插件添加至您的应用: + +1. 将以下依赖添加至您的 `Dependencies.xml` 文件: + + ```xml + + ``` + + 或者,在 Android Studio 中将以下依赖添加至`build.gradle`文件: + + ```groovy + dependencies { + implementation 'com.adjust.sdk:adjust-android-meta-referrer:{% $versions.android.v5 %}' + } + ``` + +2. 在[应用控制面板](https://developers.facebook.com/apps)中找到您的 Meta app ID。更多信息,请参考 Meta 的[应用控制面板文档](https://developers.facebook.com/docs/development/create-an-app/app-dashboard)。 + +3. 在`AdjustConfig`实例上将您的 App ID 指定至`FbAppId`属性。 + + ```cs + AdjustConfig config = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); + //... + config.FbAppId = "{FB_APP_ID_STRING}"; + //... + Adjust.InitSdk(config); + ``` +