設定 | Adjust Developer Hub

設定

Adjust SDKの動作を設定するには、このドキュメントに記載されたメソッドを使用してください。

Configオブジェクトをインスタンス化する

- (nullable ADJConfig *)initWithAppToken:(nonnull NSString *)appToken
                             environment:(nonnull NSString *)environment
                             suppressLogLevel:(BOOL)allowSuppressLogLevel;

Adjust SDKを設定するには、ADJConfigオブジェクトをインスタンス化する必要があります。このオブジェクトには、Adjust SDKにパスする必要のある 読み取り専用 の設定オプションが含まれています。

Configオブジェクトをインスタンス化するには、新しいADJConfigインスタンスを作成して以下のパラメーターをパスしてください：

appToken （NSString）：お客様のAdjustアプリトークン。
environment （NSString）：SDKを実行したい環境。テスト用のサンドボックスモードでSDKを実行するにはADJEnvironmentSandboxをパスします。リリース用の本番モードでSDKを実行するにはADJEnvironmentProductionをパスします。
allowSuppressLogLevel （BOOL）：全てのログを無効化するかどうか。ログを無効化するにはtrueに、ログを有効化するにはfalseに設定します。

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
    appToken: yourAppToken,
    environment: environment)

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken
                                                    environment:environment];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
});

読み取り専用の設定

読み取り専用 の設定オプションは、SDKを初期化する前に ADJConfigインスタンスで設定されます。これらのオプションは、SDKの実行中は変更できません。Adjust.initSdk()を実行する前に、使用したいオプションを設定する必要があります。

ログレベルを設定する

@property (nonatomic, assign) ADJLogLevel logLevel;

Adjust SDKは、さまざまな量の情報を返すために、設定可能なログレベルを提供しています。以下のログレベルが利用可能です。

ADJLogLevel	説明
`ADJLogLevelVerbose`	ログを全て有効化する
`ADJLogLevelDebug`	デバッグのログを有効化する
`ADJLogLevelInfo`	情報レベルのログのみを表示する（デフォルトオプション）
`ADJLogLevelWarn`	情報ログを無効化する
`ADJLogLevelError`	警告レベル以下のログを無効化する
`ADJLogLevelAssert`	エラーレベル以下のログを無効化する
`ADJLogLevelSuppress`	ログを全て無効化する

ConfigインスタンスのlogLevelプロパティにADJLogLevel値を割り当てることで、ログレベルを設定できます。

logLevel （ADJLogLevel）：使用したいログレベル

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
    appToken: yourAppToken,
    environment: environment)
// ...
adjustConfig?.logLevel = ADJLogLevel.verbose

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
 ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken
                                                    environment:environment];
// ...
[adjustConfig setLogLevel:ADJLogLevelVerbose];

setupWebViewJavascriptBridge(function (bridge) {
   // ...
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
});

外部デバイスIDを設定する

@property (nonatomic, copy, nullable) NSString *externalDeviceId;

外部デバイスIDは、デバイスまたはユーザーに割り当てることができるカスタム値です。セッションやプラットフォームを横断してユーザーを認識することができます。また、ユーザーが新規インストールとして2度カウントされないように、ユーザーごとにインストールの重複を排除することも可能です。外部デバイスIDの使用を開始する際は、Adjustの担当者にお問い合わせください。

外部デバイスIDをデバイスのカスタム識別子として使用できます。これは、他のシステム上で継続性を保ちたい場合に役立ちます。ConfigインスタンスのexternalDeviceIdプロパティに外部デバイスIDを割り当てます。

externalDeviceId （NSString）：外部デバイスID。この値は 大文字と小文字を区別します 。外部デバイスIDをインポートしている場合は、パス値がインポートした値と一致することを確認してください。

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
   appToken: yourAppToken,
   environment: environment)
// ...
adjustConfig?.externalDeviceId = "yourExternalDeviceId"

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
 ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken
                                                    environment:environment];
// ...
[adjustConfig setExternalDeviceId:@"yourExternalDeviceId"];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.setExternalDeviceId("yourExternalDeviceId");
});

外部デバイスIDをビジネスアナリティクスに使用する場合は、IDをセッションコールバックパラメーターとしてパスすることができます。

既存の外部デバイスIDをAdjustにインポートすることが可能です。これにより、Adjustサーバーが今後のデータを既存のデバイス記録と一致させることができます。この設定をご希望の場合は、Adjustの担当者にお問い合わせください。

デフォルトのリンクトークンを設定する

@property (nonatomic, copy, nullable) NSString *defaultTracker;

アプリがデバイスにプリインストールされている場合、デフォルトのリンクトークンを設定できます。ユーザーがプリインストールされたアプリを初めて起動すると、インストールはデフォルトのリンクトークンにアトリビュートされます。デフォルトのリンクトークンを、configインスタンスのdefaultTrackerプロパティに割り当てます。

defaultTracker （NSString）：プリインストールを記録したいAdjustリンクトークン。

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
   appToken: yourAppToken,
   environment: environment)
adjustConfig?.defaultTracker = "{Token}"
Adjust.initSdk(adjustConfig)

ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
                                              environment:environment];
[adjustConfig setDefaultTracker:@"{Token}"];
[Adjust initSdk:adjustConfig];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.setDefaultTracker("{Token}");
});

コストデータの送信を有効化する

- (void)enableCostDataInAttribution;

デフォルトでは、Adjust SDKはユーザーのアトリビューションの一環としてコストデータを送信しません。コストデータの送信を有効化することで、このデータを送信するようにSDKを設定できます。コストデータ送信を有効化するには、[ADJConfig enableCostDataInAttribution]メソッドを呼び出します。

コストデータには、ユーザーのアトリビューション情報でアクセスできます。

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
   appToken: yourAppToken,
   environment: environment)
// ...
adjustConfig?.enableCostDataInAttribution()

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
 ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
                                                environment:environment];
// ...
[adjustConfig enableCostDataInAttribution];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.enableCostDataInAttribution();
});

バックグランドでの送信機能を有効化する

- (void)enableSendingInBackground;

デフォルトでは、アプリがバックグラウンドで動作している間、Adjust SDKはリクエストの送信を一時停止します。バックグランドでの計測機能を有効化することで、SDKがバックグランドでリクエストを送信するよう設定することが可能です。バックグラウンドでの計測機能を有効化するには、[Adjust enableSendingInBackground]メソッドを呼び出します。

1
adjustConfig?.enableSendingInBackground()

1
[adjustConfig enableSendingInBackground];

1
adjustConfig.setSendInBackground(true);

動的設定

動的設定オプションは、SDKのライフサイクル中に、ユーザーによるイベントやアクションに応じて変更されることがあります。

オフラインモードを有効化する

Adjust SDKは、イベントとセッションのデータをAdjustのサーバーにリアルタイムで送信します。SDKをオフラインモードにすると、情報の送信を一時停止することができます。オフラインモードでは、SDKは全てのデータをデバイスのローカルファイルに保存します。オフラインモードを無効にすると、SDKはこの情報をAdjustのサーバーに送信します。

[Adjust switchToOfflineMode]メソッドを呼び出すことで、いつでもオフランモードに切り替えられます：

Swift
Objective-C

1
Adjust.switchToOfflineMode()

1
[Adjust switchToOfflineMode]

オフラインモードを無効化する

[Adjust switchBackToOnlineMode]メソッドを呼び出して、SDKを再度有効化することができます。これにより、SDKは情報の送信を再開します。

Swift
Objective-C

1
Adjust.switchBackToOnlineMode()

1
[Adjust switchBackToOnlineMode]

Pushトークンを設定する

+ (void)setPushToken:(nonnull NSData *)pushToken;

Pushトークンは、Audiences機能やクライアントコールバックに使用されます。また、アンインストール・再インストール計測にも必要です。

このPushトークンは、[Adjust setPushToken]メソッドと以下の引数を呼び出すことで、いつでも更新することが可能です：

pushToken （NSData）：Push トークン

Swift
Objective-C

1
func application(_ app: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken pushToken: Data) {
2
    Adjust.setPushToken(pushToken)
3
}

1
- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)pushToken {
2
    [Adjust setPushToken:pushToken];
3
}

SDKを無効化する

+ (void)disable;

Adjust SDKは、デフォルトでアプリが開いている時に実行されます。[Adjust disable]メソッドを呼び出すことで、Adjust SDKを無効にしてAdjustへの情報の送信を一時停止することができます。Adjust SDKを無効にすると、Adjustサーバーにデータが送信されなくなります。

Swift
Objective-C

1
Adjust.disable()

1
[Adjust disable];

SDKを有効化する

+ (void)enable;

SDKを無効化した後、再度有効化したい場合は、 [Adjust enable]メソッドを呼び出します。SDKが有効化されると、Adjustのサーバーに情報を送信します。

Swift
Objective-C

1
Adjust.enable()

1
[Adjust enable];

有効化ステータスを確認する

+ (void)isEnabledWithCompletionHandler:(nonnull ADJIsEnabledGetterBlock)completion;

Adjust SDKが有効であるかどうかを確認するには、[Adjust isEnabledWithCompletionHandler]メソッドを呼び出します。ステータスは非同期で返され、完了ハンドラーにBOOL値がパスされます。

Swift
Objective-C

1
Adjust.isEnabled { isEnabled in
2
   // Your completion handler
3
};

1
[Adjust isEnabledWithCompletionHandler:^(BOOL isEnabled) {
2
   // Your completion handler
3
}]