Adobe Experience Platform ID サービスのメソッド

iOS ライブラリが提供する Adobe Experience Platform サービスメソッドを以下に示します。

SDK は現在、Analytics、Target、Audience Manager、Experience Cloud ID サービスなど、複数の Adobe Experience Cloud ソリューションをサポートしています。

メソッドには、ソリューションに応じたプレフィックスが付きます。Experience Cloud ID メソッドの場合、プレフィックスは「visitor」です。詳しくは、Experience Cloud ID の有効化を参照してください。

• +(nullable NSURL *)visitorAppendToURL:(nullable NSURL *)url;

  アドビ JavaScript ライブラリで使用するために、アドビ訪問者データを URL 文字列に追加します。このメソッドを使用するには、Mobile SDK 4.12 以降が必要です。詳しくは、 appendVisitorIDsTo ( Adobe Experience Cloud ID サービスドキュメント ) を参照してください。

  重要

  このメソッドにより、ネットワークブロック呼び出しがおこなわれる可能性があります。時間的制約があるスレッドでこのメソッドを呼び出さないでください。

  • 訪問者情報を追加する必須の URL<NSURL> 文字列。

  • URL<NSURL>訪問者情報が追加された文字列。

  • このメソッドのコードサンプルを次に示します。

     NSURL *url = [NSURL URLWithString:@"https://www.example.com"];
     NSURL *decoratedURL = [ADBMobile visitorAppendToURL: url];
     [[UIApplication sharedApplication] openURL: decoratedURL];
    

• visitorMarketingCloudID

  Experience Cloud ID を ID サービスから取得します。

  • このメソッドの構文を次に示します。

    + (NSString  *)  visitorMarketingCloudID;
    

  • このメソッドのコードサンプルを次に示します。

    NSString *mcid = [ADBMobile visitorMarketingCloudID];
    

    重要

    このメソッドは、ネットワークブロック呼び出しがおこなわれる可能性があるので、UI スレッドから呼び出さ​ない​でください。

• visitorSyncIdentifiers:

  Experience Cloud ID を使用すると、各訪問者に関連付けることができる追加の顧客 ID を設定できます。訪問者 API は、同じ訪問者に対して複数の顧客 ID と、異なる顧客 ID の範囲を区別するための顧客タイプ識別子を受け取ります。このメソッドは、JavaScript ライブラリの setCustomerIDs に相当します。

  • このメソッドの構文を次に示します。

    +  (void)  visitorSyncIdentifiers:(NSDictionary  *)identifiers;
    

  • このメソッドのコードサンプルを次に示します。

    [ADBMobile visitorSyncIdentifiers:@{@"idType":@"idValue"}];
    

• visitorSyncIdentifiers:authenticationState:

  指定された識別子を ID サービスに同期します。authState を次のいずれかの値として渡します。

  • ADBMobileVisitorAuthenticationStateUnknown

  • ADBMobileVisitorAuthenticationStateAuthenticated

  • ADBMobileVisitorAuthenticationStateLoggedOut

  • このメソッドの構文を次に示します。

    +  (void) visitorSyncIdentifiers:(nullable NSDictionary  *)identifiers  authenticationState:(ADBMobileVisitorAuthenticationState)authState;
    

  • このメソッドのコードサンプルを次に示します。

    [ADBMobile visitorSyncIdentifiers:@{@"myIdType":@"valueForUser"}  authenticationState:ADBMobileVisitorAuthenticationStateAuthenticated];
    

• visitorSyncIdentifierWithType:identifier:authenticationState:

  指定された識別子の型と値を ID サービスに同期します。authState を次のいずれかの値として渡します。

  • ADBMobileVisitorAuthenticationStateUnknown

  • ADBMobileVisitorAuthenticationStateAuthenticated

  • ADBMobileVisitorAuthenticationStateLoggedOut

  • このメソッドの構文を次に示します。

    + (void) visitorSyncIdentifierWithType:(nullable NSString *)identifierType
    identifier:(nullable NSString *)identifier authenticationState:
    (ADBMobileVisitorAuthenticationState)authState;
    

  • このメソッドの構文を次に示します。

    [ADBMobile visitorSyncIdentifierWithType:@"myIdType" identifier:@"valueForUser"
    authenticationState:ADBMobileVisitorAuthenticationStateLoggedOut];
    

• visitorGetIDs

  読み取り専用の ADBVisitorID オブジェクトの配列を取得します。

  • このメソッドの構文を次に示します。

    +  (nullable NSArray *) visitorGetIDs;
    

  • このメソッドのコードサンプルを次に示します。

    NSArray *myVisitorIDs = [ADBMobile visitorGetIDs];
    

• visitorgetUrlVariablesAsync

  バージョン 4.16.0 で導入されたこのメソッドは、訪問者 ID サービスの URL 変数を含む適切な形式の文字列を返します。このメソッドの使用方法について詳しくは、「Adobe Experience Platform ID サービスメソッド」を参照してください。

  • このメソッドの構文を次に示します。

    + (void) visitorGetUrlVariablesAsync:(nullable void (^)(NSString* __nullable urlVariables))callback;
    

  • このメソッドのコードサンプルを次に示します。

    NSString *urlString = @"https://www.mydomain.com/index.php";
    [ADBMobile visitorGetUrlVariablesAsync:^(NSString * _Nullable urlVariables) {
      NSString *urlStringWithVisitorData = [NSString stringWithFormat:@"%@?%@", urlString, urlVariables];
      // use urlStringWithVisitorData
    }];
    

ADBVisitorID インターフェイス

パブリックメソッド：

- (nullable NSString *) idType;
- (nullable NSString *) identifier;
- (ADBMobileVisitorAuthenticationState) authenticationState;

ADBMobileVisitorAuthenticationState enum

ADBMobileVisitorAuthenticationStateUnknown,
ADBMobileVisitorAuthenticationStateAuthenticated,
ADBMobileVisitorAuthenticationStateLoggedOut