We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.

開発者向け

Adjustクラス

Adjustクラスは、アプリとユーザーに関する情報をAdjustに送信するために使用できます。これは、アトリビューションやアナリティクスのためのイベント計測にも使用可能です。

メソッド

セッションごとにコールバックパラメーターを送信する

Adjust SDKで記録されるセッションごとにコールバックパラメーターを送信できます。このメソッドを複数回呼び出すと、さらにパラメーターを追加できます。

+ (void) addSessionCallbackParameter: (nonnull NSString *) key
                               value: (nonnull NSString *) value

Objective-C

Swift

Javascript

[Adjust addSessionCallbackParameter:@"foo" value:@"bar"];

セッションコールバックパラメーターを削除する

セッションパラメーターを追加している場合は、後で削除できます。これを行うには、パラメーターキーをremoveSessionCallbackParameterメソッドに渡します。

+ (void) removeSessionCallbackParameter: (nonnull NSString *) key

Objective-C

Swift

Javascript

[Adjust removeSessionCallbackParameter:@"foo"];

全てのセッションコールバックパラメーターをリセットする

セッションコールバックパラメーターを追加している場合は、後で全て削除できます。これを行うには、resetSessionCallbackParametersメソッドを呼び出します。

+ (void) resetSessionCallbackParameters

Objective-C

Swift

Javascript

[Adjust resetSessionCallbackParameters];

セッションごとのコールバックパラメーターをネットワークパートナーに送信する

Adjust SDKで記録されるセッションごとにコールバックパラメーターをパートナーに送信できます。このメソッドを複数回呼び出すと、さらにパラメーターを追加できます。

+ (void) addSessionPartnerParameter: (nonnull NSString *) key
                              value: (nonnull NSString *) value

Objective-C

Swift

Javascript

[Adjust addSessionPartnerParameter:@"foo" value:@"bar"];

パートナーのコールバックパラメーターを削除する

パートナーパラメーターを追加している場合は、後で削除できます。これを行うには、パラメーターキーをremoveSessionPartnerParameterメソッドに渡します。

+ (void) removeSessionPartnerParameter: (nonnull NSString *) key

Objective-C

Swift

Javascript

[Adjust removeSessionPartnerParameter:@"foo"];

パートナーの全てのコールバックパラメーターをリセットする

パートナーパラメーターを追加している場合は、後で全て削除できます。これを行うには、resetSessionPartnerParametersメソッドを呼び出します。

+ (void) resetSessionPartnerParameters

Objective-C

Swift

Javascript

[Adjust resetSessionPartnerParameters];

デバイスのためのAdjust IDを取得する

adidメソッドを呼び出すと、ユーザーのデバイスのAdjust ID（adid）を返すことができます。

注意:

adidは、インストールが正常に計測された後でのみ利用できます。

+ (NSString *) adid

Objective-C

Swift

Javascript

NSString *adid = [Adjust adid];

戻り値

値	データタイプ	説明
`adid`	文字列	デバイスの一意Adjust ID。

アプリが正常に起動したことを確認する

SDKを初期化するためには、アプリケーションが正しく起動したかどうかを確認する必要があります。これを行うには、ADJConfig オブジェクトをappDidLaunchメソッドに渡します。

注意:

`didFinishLaunching`または`didFinishLaunchingWithOptions`メソッドの最後に、次を呼び出します。

+ (void) appDidLaunch: (nullable ADJConfig *) adjustConfig

Objective-C

Swift

Javascript

[Adjust appDidLaunch:adjustConfig];

パラメーター

値	データタイプ	説明
`adjustConfig`	ADJConfig オブジェクト	全てのオプション機能が設定された、完了したADJConfigオブジェクト。

App Tracking Transparencyの選択を処理する

Adjust SDKには、requestTrackingAuthorizationWithCompletionHandlerメソッドの上に構築されたラッパーが含まれています。このラッパーを使用して、ユーザーの承認ステータスに関する情報を収集できます。

Objective-C

[Adjust requestTrackingAuthorizationWithCompletionHandler:^(NSUInteger status) {
    switch (status) {
        case 0:
            // ATTrackingManagerAuthorizationStatusNotDetermined case
            break;
        case 1:
            // ATTrackingManagerAuthorizationStatusRestricted case
            break;
        case 2:
            // ATTrackingManagerAuthorizationStatusDenied case
            break;
        case 3:
            // ATTrackingManagerAuthorizationStatusAuthorized case
            break;
    }
}];

戻り値

値	データタイプ	説明
`0`	整数	`ATTrackingManagerAuthorizationStatusNotDetermined`：ユーザーが承認プロンプトにアクセスしていない
`1`	整数	`ATTrackingManagerAuthorizationStatusRestricted`：承認プロンプトがデバイスレベルで制限されている
`2`	整数	`ATTrackingManagerAuthorizationStatusDenied`：ユーザーがアクセスを拒否
`3`	整数	`ATTrackingManagerAuthorizationStatusAuthorized`：ユーザーがアクセスを許可

現在のトラッキングの承認ステータスを取得する

iOS 14.5では、デバイスの広告主ID（IDFA）を取得することにユーザーは明示的に同意する必要があります。appTrackingAuthorizationStatusメソッドを使用して、Adjust SDKに同意ステータスをクエリできます。

- (int) appTrackingAuthorizationStatus

Objective-C

Swift

Javascript

int authorizationStatus = [Adjust appTrackingAuthorizationStatus];

戻り値

値	データタイプ	説明
`ステータス`	整数	ユーザーがデバイスのトラッキングを承認したかどうかに関するステータスコード

値

値	説明
`0`	ユーザーはまだトラッキングの承認を求められていない。
`1`	ユーザーのデバイスが制限されている。
`2`	ユーザーがIDFAへのアクセスを拒否している。
`3`	ユーザーがIDFAへのアクセスを承認している。
`-1`	ステータスが不明。

URLからディープリンクのアトリビューション情報を取得する

ディープリンクを使用する場合は、そのURLでアトリビューション情報を検索するようAdjust SDKに指示できます。SDKは、有効な情報を見つけるとその情報をAdjustバックエンドに送信します。

+ (void) appWillOpenUrl: (nonnull NSURL *) url

Objective-C

Swift

[Adjust appWillOpenUrl:url];

パラメーター

値	データタイプ	説明
`url`	URL	ディープリンク情報が含まれるURLオブジェクト。

現在のアトリビューションデータを取得する

ユーザーがアプリをインストールした後、Adjust SDKにデバイスアトリビューション情報をクエリすることができます。

注意:

アトリビューション情報は、Adjustバックエンドがインストールを計測した後でのみ利用できます。バックエンドは、インストールイベントを受信すると、情報を返します。

+ (ADJAttribution *) attribution

Objective-C

Swift

Javascript

ADJAttribution *attribution = [Adjust attribution];

戻り値

値	データタイプ	説明
`アトリビューション`	ADJAttribution オブジェクト	デバイスに現在関連付けられている全てのアトリビューションデータを返します。

ユニバーサルURLをスキームURLに変換する

Adjust SDKには、ユニバーサルリンクをディープリンクに変換するヘルパーメソッドが用意されています。これを使用するには、カスタムのディープリンクスキームをconvertUniversalLinkメソッドに渡します。

+ (nullable NSURL *) convertUniversalLink: (nonnull NSURL *) url
                                   scheme: (nonnull NSString *) scheme

Objective-C

Swift

[Adjust convertUniversalLink:url scheme:@"adjustExample"];

パラメーター

値	データタイプ	説明
`url`	URLオブジェクト	ディープリンク情報が含まれるユニバーサルURL。
`scheme`	文字列	得られるリンクにプレフィックスとして指定するスキーム。

戻り値

値	データタイプ	説明
`url`	URLオブジェクト	指定されたプレフィックスを持つ、定義されたスキームスタイルのURLオブジェクト。

サードパーティーとの共有オプションを変更する

サードパーティーとの共有に関するユーザーの設定を伝達できます。サードパーティーと共有するオブジェクトで、次のメソッドを呼び出します。その後、ユーザーの希望設定を持つオブジェクトを初期化してください。

また、ユーザーの希望する設定に関する詳細なオプションを渡すことで、アナリティクスのためのよりきめ細かい情報を収集することもできます。

(void) + trackThirdPartySharing

Objective-C

Swift

Javascript

// Disable third-party sharing for the user

ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:@NO];
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

// Enable third-party sharing for the user

ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:@YES];
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

// Gather granular details

ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil];
[adjustThirdPartySharing addGranularOption:@"PartnerA" key:@"foo" value:@"bar"];
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

サードパーティーとの共有を無効化する

disableThirdPartySharingメソッドを呼び出すと、サードパーティーとの情報共有を防止できます。デフォルトでfalseに設定されています。

+ (void) disableThirdPartySharing

Objective-C

Swift

Javascript

[Adjust disableThirdPartySharing];

SDKでデータプライバシー設定を有効化する

Adjustのデータプライバシー設定を使用している場合は、Adjust SDKでこの設定を切り替える必要があります。設定するには、trackMeasurementConsentメソッドを呼び出します。

+ (void) trackMeasurementConsent: (BOOL) enabled

Objective-C

Swift

Javascript

[Adjust trackMeasurementConsent:YES];

ユーザーによるGDPRの忘れられる権利に関するリクエストを有効化する

ユーザーが忘れられる権利をリクエストできるようにすることができます。このメソッドを呼び出すと、Adjust SDKからAdjustバックエンドにリクエストが伝えられます。Adjustバックエンドによってユーザーの情報が消去されます。

- (void) gdprForgetMe

Objective-C

Swift

Javascript

[Adjust gdprForgetMe];

デバイスのIDFAを収集する

idfaメソッドを呼び出すと、デバイスの広告主ID（IDFA）を取得できます。

+ (nullable NSString *) idfa

Objective-C

Swift

Javascript

NSString *idfa = [Adjust idfa];

戻り値

値	データタイプ	説明
`IDFA`	文字列	デバイスのIDFA

Adjust SDKの有効化と無効化

setEnabledメソッドを使用すると、Adjust SDKによる計測を有効化/無効化することができます。

注意:

Adjust SDKは、デフォルトで常に有効化されています。 checkEnabled メソッドを使用して、ステータスを確認できます。

+ (void) setEnabled: (BOOL) enabled

Objective-C

Swift

Javascript

[Adjust setEnabled:NO];

Adjust SDKが有効化されていることを確認する

isEnabledメソッドを呼び出すと、Adjust SDKが有効であるかどうかを確認できます。

+ (BOOL) isEnabled

Objective-C

Swift

Javascript

[Adjust isEnabled];

Adjust SDKのバージョンを確認する

デバイスで実行しているAdjust SDKのバージョンを確認する場合は、sdkVersionメソッドを呼び出すことができます。

+ (NSString *) sdkVersion

Objective-C

Swift

[Adjust sdkVersion];

戻り値

値	データタイプ	説明
`SDKバージョン`	文字列	SDKのバージョン（ `iosX.Y.Z`形式）。

Pushトークンを設定する

リアトリビューションにPush通知を利用する場合は、トークンをAdjust SDKに追加する必要があります。

+ (void) setDeviceToken: (nonnull NSData *) deviceToken

Objective-C

Swift

Javascript

[Adjust setDeviceToken:deviceToken];

パラメーター

値	データタイプ	説明
`deviceToken`	データ	Apple Pushトークン

オフラインモードの有効化と無効化

ユーザーのデバイスがオフラインのときに、SDKをオフラインモードにすることでイベントをキューに追加できます。このモードでは、オンラインに戻るまで全てのイベントが保管されます。Adjust SDKがオンラインに戻ると、イベントの送信を試みます。

重要:

このオフラインモード設定はアプリの起動時に記憶されません。アプリを最後に開いたときにオフラインモードが有効であっても、Adjust SDKは常にオンラインモードで起動します。

+ (void) setOfflineMode: (BOOL) enabled

Objective-C

Swift

Javascript

[Adjust setOfflineMode:YES]; // Enables offline mode
[Adjust setOfflineMode:NO]; // Disables offline mode

特定のソースの広告収益を計測する

Adjust SDKにより、特定のネットワークパートナーからの収益情報を受信することができます。JSONオブジェクトとしてAdjust SDKにパスすることで、広告収益に関する情報のトラッキングを可能にします。

注意:

この機能は特定の広告収益ソースにのみ利用可能です。サポートされているソースの一覧については、値テーブルを確認してください。

+ (void) trackAdRevenue: (nonnull NSString *) source
                payload: (nonnull NSData *)   payload

Objective-C

Swift

// initilise ADJAdRevenue instance with appropriate ad revenue source
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
// pass revenue and currency values
[adRevenue setRevenue:1.6currency:@"USD"];
// pass optional parameters
[adRevenue setAdImpressionsCount:adImpressionsCount];
[adRevenue setAdRevenueUnit:adRevenueUnit];
[adRevenue setAdRevenuePlacement:adRevenuePlacement];
[adRevenue setAdRevenueNetwork:adRevenueNetwork];
// attach callback and/or partner parameter if needed
[adRevenue addCallbackParameter:key value:value];
[adRevenue addPartnerParameter:key value:value];

// track ad revenue
[Adjust trackAdRevenue:source payload:payload];

パラメーター

値	データタイプ	説明
`ソース`	文字列	広告収益情報のソース。
`ペイロード`	データオブジェクト	広告収益情報のJSONペイロード。

値

値	説明
`ADJAdRevenueSourceAppLovinMAX`	Applovin MAXで広告収益のトラッキングを有効化します。
`ADJAdRevenueSourceAdmob`	AdMobで広告収益のトラッキングを有効化します。
`ADJAdRevenueSourceIronsource`	ironSourceで広告収益のトラッキングを有効化します。
`ADJAdRevenueSourceAdMost`	Admostで広告収益のトラッキングを有効化します。
`ADJAdRevenueSourceUnity`	Unityで広告収益のトラッキングを有効化します。
`ADJAdRevenueSourceHeliumChartboost`	Helium Chartboostで広告収益のトラッキングを有効化します。
`ADJAdRevenueSourcePublisher`	汎用ソースとの広告収益のトラッキングを有効化します。

イベントを計測する

Adjust SDKを使用して、イベント情報をAdjustバックエンドに返すことができます。これは、ローデータのエクスポートを調べてみるとわかります。

+ (void) trackEvent: (nullable ADJEvent *) event

Objective-C

Swift

ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"];
[Adjust trackEvent:event];

パラメーター

値	データタイプ	説明
`event`	ADJEvent オブジェクト	計測するイベントのADJEventオブジェクト。Adjust管理画面で取得できるイベントトークンを使用して設定する必要があります。

サブスクリプションを計測する

Adjust SDKでは、アプリ内サブスクリプションイベントに関する情報を計測できます。これを行うには、サブスクリプションオブジェクトを形成して SDK に渡します。

+ (void) trackSubscription: (nonnull ADJSubscription *) subscription

Objective-C

Swift

ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price
                                                              currency:currency
                                                         transactionId:transactionId
                                                            andReceipt:receipt];

[Adjust trackSubscription:subscription];

パラメーター

値	データタイプ	説明
`subscription`	ADJSubscription オブジェクト	計測するイベントのADJSubscriptionオブジェクト。

アプリケーションが一時停止していることをSDKに通知する

trackSubsessionEndメソッドを呼び出すと、アプリケーションが一時停止していることをAdjust SDKに通知できます。

注意:

このメソッドは、システムレベルの通知を使用できない場合にのみ呼び出す必要があります。

+ (void) trackSubsessionEnd

Objective-C

Swift

[Adjust trackSubsessionEnd];

アプリケーションが再開していることをSDKに通知する

trackSubsessionStartメソッドを呼び出すと、アプリケーションが再開していることをAdjust SDKに通知できます。

注意:

このメソッドは、システムレベルの通知を使用できない場合にのみ呼び出す必要があります。

Objective-C

Swift

[Adjust trackSubsessionStart];

SDKで初回のペイロードを送信する

Adjust SDKの起動を遅らせる場合、遅延タイマーが切れた後に情報をバックエンドに送信します。このメソッドを使用すると、遅延時間が経過する前にSDKにパッケージの送信を促すことができます。

+ (void) sendFirstPackages

Objective-C

Swift

[Adjust sendFirstPackages];