appendToURL

This API appends Adobe visitor information to the query component of the specified URL.

If the provided URL is nil or empty, it is returned as is. Otherwise, the following information is added to the query component of the specified URL string and is returned via the callback:

• The adobe_mc attribute is a URL encoded list that contains:

  • MCMID - Experience Cloud ID (ECID)

  • MCORGID - Experience Cloud Org ID

  • MCAID - Analytics Tracking ID (AID), if available from the Analytics extension​

  • TS - A timestamp taken when this request was made

• The optional adobe_aa_vid attribute is the URL-encoded Analytics Custom Visitor ID (VID), if previously set in the Analytics extension.

iOS

Syntax

+ (void) appendToUrl: (nullable NSURL*) baseUrl withCallback: (nullable void (^) (NSURL* __nullable urlWithVisitorData)) callback;
+ (void) appendToUrl: (nullable NSURL*) baseUrl withCompletionHandler: (nullable void (^) (NSURL* __nullable urlWithVersionData, NSError* __nullable error)) completionHandler;

• baseUrl is the URL to which the visitor information needs to be appended. If the visitor information is nil or empty, the URL is returned as is.

• callback is invoked after the updated URL is available.

• completionHandler is invoked with urlWithVersionData after the updated URL is available or error if an unexpected exception occurs or the request times out. The returned NSError contains the ACPError code of the specific error. The default timeout is 500ms.

Examples

Objective-C

NSURL* url = [[NSURL alloc] initWithString:@"https://example.com"];
[ACPIdentity appendToUrl:url withCallback:^(NSURL * _Nullable urlWithVisitorData) {    
  // handle the appended url here
  if (urlWithVisitorData) {
    // APIs which update the UI must be called from main thread
    dispatch_async(dispatch_get_main_queue(), ^{
      [[self webView] loadRequest:[NSURLRequest requestWithURL:urlWithVisitorData]];
    }
  } else {
    // handle error, nil urlWithVisitorData
  }
}];
​
[ACPIdentity appendToUrl:url withCompletionHandler:^(NSURL * _Nullable urlWithVersionData, NSError * _Nullable error) {
  if (error) {
    // handle error here
  } else {
    // handle the appended url here
    if (urlWithVisitorData) {
      // APIs which update the UI must be called from main thread
      dispatch_async(dispatch_get_main_queue(), ^{
        [[self webView] loadRequest:[NSURLRequest requestWithURL:urlWithVisitorData]];
      }
    } else {
      // handle error, nil urlWithVisitorData
    }
  }
}];

Swift

ACPIdentity.append(to:URL(string: "https://example.com"), withCallback: {(appendedURL) in    
  // handle the appended url here
  if let appendedURL = appendedURL {
    // APIs which update the UI must be called from main thread
    DispatchQueue.main.async {
      self.webView.load(URLRequest(url: appendedURL!))
    }
  } else {
    // handle error, nil appendedURL
  }
});
​
ACPIdentity.append(to: URL(string: "https://example.com"), withCompletionHandler: { (appendedURL, error) in
  if let error = error {
    // handle error
  } else {
    // handle the appended url here
    if let appendedURL = appendedURL {
      // APIs which update the UI must be called from main thread
      DispatchQueue.main.async {
        self.webView.load(URLRequest(url: appendedURL!))
      }
    } else {
      // handle error, nil appendedURL
    }
  }
})

scheme://authority/path?query=param#fragment

scheme://authority/path?query=param&TS=timestamp&MCMID=ecid&[email protected]#fragment

scheme://authority/path#fragment

scheme://authority/path?TS=timestamp&MCMID=ecid&[email protected]#fragment

appendVisitorInfoForURL

This API appends Adobe visitor information to the query component of the specified URL.

If the specified URL is nil or empty, it is returned as is. Otherwise, the following information is added to the query component of the specified URL.

• The adobe_mc attribute is a URL encoded list that contains:

  • MCMID - Experience Cloud ID (ECID)

  • MCORGID - Experience Cloud Org ID

  • MCAID - Analytics Tracking ID (AID), if available from the Analytics extension​

  • TS - A timestamp taken when this request was made

• The optional adobe_aa_vid attribute is the URL-encoded Analytics Custom Visitor ID (VID), if previously set in the Analytics extension.

JavaScript

Syntax

appendVisitorInfoForURL(baseURL?: String): Promise<?string>;

• baseUrl is the URL to which the visitor information needs to be appended. If the visitor information is nil or empty, the URL is returned as is.

Example

ACPIdentity.appendVisitorInfoForURL("https://example.com").then(urlWithVistorData => console.log("AdobeExperenceSDK: Url with Visitor Data = " + urlWithVisitorData));

scheme://authority/path?query=param#fragment

scheme://authority/path?query=param&TS=timestamp&MCMID=ecid&[email protected]#fragment

scheme://authority/path#fragment

scheme://authority/path?TS=timestamp&MCMID=ecid&[email protected]#fragment

appendVisitorInfoForURL

This API appends Adobe visitor information to the query component of the specified URL.

If the specified URL is nil or empty, it is returned as is. Otherwise, the following information is added to the query component of the specified URL.

• The adobe_mc attribute is a URL encoded list that contains:

  • MCMID - Experience Cloud ID (ECID)

  • MCORGID - Experience Cloud Org ID

  • MCAID - Analytics Tracking ID (AID), if available from the Analytics extension​

  • TS - A timestamp taken when this request was made

• The optional adobe_aa_vid attribute is the URL-encoded Analytics Custom Visitor ID (VID), if previously set in the Analytics extension.

Dart

Syntax

Future<String> appendToUrl (String url);

• url is the URL to which the visitor information needs to be appended. If the visitor information is nil or empty, the URL is returned as is.

Example

String result = "";
​
try {
  result = await FlutterACPIdentity.appendToUrl("https://example.com");
} on PlatformException {
  log("Failed to append URL");
}

scheme://authority/path?query=param#fragment

scheme://authority/path?query=param&TS=timestamp&MCMID=ecid&[email protected]#fragment

scheme://authority/path#fragment

scheme://authority/path?TS=timestamp&MCMID=ecid&[email protected]#fragment

appendVisitorInfoForURL

This API appends Adobe visitor information to the query component of the specified URL.

If the specified URL is nil or empty, it is returned as is. Otherwise, the following information is added to the query component of the specified URL.

• The adobe_mc attribute is a URL encoded list that contains:

  • MCMID - Experience Cloud ID (ECID)

  • MCORGID - Experience Cloud Org ID

  • MCAID - Analytics Tracking ID (AID), if available from the Analytics extension​

  • TS - A timestamp taken when this request was made

• The optional adobe_aa_vid attribute is the URL-encoded Analytics Custom Visitor ID (VID), if previously set in the Analytics extension.

Cordova

Syntax

ACPIdentity.appendVisitorInfoForUrl = function(url, success, fail);

• url (String) is the URL to which the visitor information needs to be appended. If the visitor information is nil or empty, the URL is returned as is.

• success is a callback containing the provided URL with the visitor information appended if the appendVisitorInfoForUrl API executed without any errors.

• fail is a callback containing error information if the appendVisitorInfoForUrl API was executed with errors.

Example

ACPIdentity.appendVisitorInfoForUrl("https://example.com", function(handleCallback) {
  console.log("AdobeExperenceSDK: Url with Visitor Data = " + handleCallback);
}, function(handleError) {
  console.log("AdobeExperenceSDK: Failed to append URL : " + handleError);
});

scheme://authority/path?query=param#fragment

scheme://authority/path?query=param&TS=timestamp&MCMID=ecid&[email protected]#fragment

scheme://authority/path#fragment

scheme://authority/path?TS=timestamp&MCMID=ecid&[email protected]#fragment

AppendToUrl

This API appends Adobe visitor information to the query component of the specified URL.

If the specified URL is nil or empty, it is returned as is. Otherwise, the following information is added to the query component of the specified URL.

• The adobe_mc attribute is a URL encoded list that contains:

  • MCMID - Experience Cloud ID (ECID)

  • MCORGID - Experience Cloud Org ID

  • MCAID - Analytics Tracking ID (AID), if available from the Analytics extension​

  • TS - A timestamp taken when this request was made

• The optional adobe_aa_vid attribute is the URL-encoded Analytics Custom Visitor ID (VID), if previously set in the Analytics extension.

C#

Syntax

public static void AppendToUrl(string url, AdobeIdentityAppendToUrlCallback callback)

• url (String) is the URL to which the visitor information needs to be appended. If the visitor information is nil or empty, the URL is returned as is.

• callback is a callback containing the provided URL with the visitor information appended if the AppendToUrl API executed without any errors.

Example

[MonoPInvokeCallback(typeof(AdobeIdentityAppendToUrlCallback))]
public static void HandleAdobeIdentityAppendToUrlCallback(string url)
{
    print("Url is : " + url);
}
ACPIdentity.AppendToUrl("https://www.adobe.com", HandleAdobeIdentityAppendToUrlCallback);

scheme://authority/path?query=param#fragment

scheme://authority/path?query=param&TS=timestamp&MCMID=ecid&[email protected]#fragment

scheme://authority/path#fragment

scheme://authority/path?TS=timestamp&MCMID=ecid&[email protected]#fragment

AppendToUrl

This API appends Adobe visitor information to the query component of the specified URL.

If the specified URL is nil or empty, it is returned as is. Otherwise, the following information is added to the query component of the specified URL.

• The adobe_mc attribute is a URL encoded list that contains:

  • MCMID - Experience Cloud ID (ECID)

  • MCORGID - Experience Cloud Org ID

  • MCAID - Analytics Tracking ID (AID), if available from the Analytics extension​

  • TS - A timestamp taken when this request was made

• The optional adobe_aa_vid attribute is the URL-encoded Analytics Custom Visitor ID (VID), if previously set in the Analytics extension.

C#

iOS Syntax

public unsafe static void AppendToUrl (NSUrl baseUrl, Action<NSUrl> callback);

• baseUrl (NSUrl) is the URL to which the visitor information needs to be appended. If the visitor information is nil or empty, the URL is returned as is.

• callback is a callback containing the provided URL with the visitor information appended if the AppendToUrl API executed without any errors.

Android Syntax

public unsafe static void AppendVisitorInfoForURL (string baseURL, IAdobeCallback callback);

• baseURL (string) is the URL to which the visitor information needs to be appended. If the visitor information is nil or empty, the URL is returned as is.

• callback is a callback containing the provided URL with the visitor information appended if the AppendVisitorInfoForURL API executed without any errors.

iOS Example

ACPIdentity.AppendToUrl(url, callback => {
  Console.WriteLine("Appended url: " + callback);
});

Android Example

ACPIdentity.AppendVisitorInfoForURL("https://example.com", new StringCallback());
​
class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Appended url: " + stringContent);
    } 
    else 
    {
      Console.WriteLine("null content in string callback");
    }
  }
}

scheme://authority/path?query=param#fragment

scheme://authority/path?query=param&TS=timestamp&MCMID=ecid&MCORGID=[email protected]#fragment

scheme://authority/path#fragment

scheme://authority/path?TS=timestamp&MCMID=ecid&MCORGID=[email protected]#fragment

iOS

Objective-C

NSString *identityExtensionVersion = [ACPIdentity extensionVersion];

Swift

var identityExtensionVersion  = ACPIdentity.extensionVersion()

JavaScript

ACPIdentity.extensionVersion().then(identityExtensionVersion => console.log("AdobeExperienceSDK: ACPIdentity version: " + identityExtensionVersion));

Dart

String identityExtensionVersion = FlutterACPIdentity.extensionVersion;

Cordova

Syntax

ACPIdentity.extensionVersion = function(success, fail);

• success is a callback containing the ACPIdentity extension version if the extensionVersion API executed without any errors.

• fail is a callback containing error information if the appendVisitorInfoForUrl API was executed with errors.

Example

ACPIdentity.extensionVersion(function (handleCallback) {
  console.log("AdobeExperienceSDK: ACPIdentity version: " + handleCallback)
}, function (handleError) {
  console.log("AdobeExperenceSDK: failed to get extension version : " + handleError)
});

C#

Syntax

public static string ExtensionVersion()

Example

string identityVersion = ACPIdentity.ExtensionVersion();

C#

Syntax

public static string ExtensionVersion ();

Example

string identityVersion = ACPIdentity.ExtensionVersion();

getExperienceCloudId

This API retrieves the ECID that was generated when the app was initially launched and is stored in the ECID Service.

This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall. The values are returned via the callback.

Syntax

+ (void) getExperienceCloudId: (nonnull void (^) (NSString* __nullable experienceCloudId)) callback;
+ (void) getExperienceCloudIdWithCompletionHandler: (nonnull void (^) (NSString* __nullable experienceCloudId, NSError* __nullable error)) completionHandler;

• callback is invoked after the ECID is available.

• completionHandler is invoked with experienceCloudId after the ECID is available, or error if an unexpected error occurs or the request times out. The returned NSError contains the ACPError code of the specific error. The default timeout is 500ms.

Examples

Objective-C

[ACPIdentity getExperienceCloudId:^(NSString * _Nullable retrievedCloudId) {    
    // handle the retrieved ID here    
}];
​
[ACPIdentity getExperienceCloudIdWithCompletionHandler:^(NSString * _Nullable experienceCloudId, NSError * _Nullable error) {
  if (error) {
    // handle error here
  } else {
    // handle the retrieved ID here
  }
}];

Swift

ACPIdentity.getExperienceCloudId { (retrievedCloudId) in    
    // handle the retrieved ID here    
}
​
ACPIdentity.getExperienceCloudId { (retrievedCloudId, error) in
  if let error = error {
    // handle error here
  } else {
    // handle the retrieved ID here
  }
}

getExperienceCloudId

This API retrieves the ECID that was generated when the app was initially launched and is stored in the ECID Service.

This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall.

JavaScript

Syntax

getExperienceCloudId(): Promise<?string>;

Example

ACPIdentity.getExperienceCloudId().then(cloudId => console.log("AdobeExperienceSDK: CloudID = " + cloudId));

getExperienceCloudId

This API retrieves the ECID that was generated when the app was initially launched and is stored in the ECID Service.

This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall.

Dart

Syntax

Future<String> experienceCloudId;

Example

String result = "";
​
try {
  result = await FlutterACPIdentity.experienceCloudId;
} on PlatformException {
  log("Failed to get experienceCloudId");
}

getExperienceCloudId

This API retrieves the ECID that was generated when the app was initially launched and is stored in the ECID Service.

This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall.

Cordova

Syntax

ACPIdentity.getExperienceCloudId(success, fail);

• success is a callback containing the experience cloud id if the getExperienceCloudId API executed without any errors.

• fail is a callback containing error information if the getExperienceCloudId API was executed with errors.

Example

ACPIdentity.getExperienceCloudId(function (handleCallback) {
  console.log("AdobeExperienceSDK: experienceCloudId: " + handleCallback)
}, function (handleError) {
  console.log("AdobeExperenceSDK: Failed to retrieve experienceCloudId : " + handleError);
});

getExperienceCloudId

This API retrieves the ECID that was generated when the app was initially launched and is stored in the ECID Service.

This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall.

C#

Syntax

public static void GetExperienceCloudId(AdobeGetExperienceCloudIdCallback callback)

• callback is a callback containing the experience cloud id if the GetExperienceCloudId API executed without any errors.

Example

[MonoPInvokeCallback(typeof(AdobeGetExperienceCloudIdCallback))]
public static void HandleAdobeGetExperienceCloudIdCallback(string cloudId)
{
    print("ECID is : " + cloudId);
}
ACPIdentity.GetExperienceCloudId(HandleAdobeGetExperienceCloudIdCallback);

getExperienceCloudId

This API retrieves the ECID that was generated when the app was initially launched and is stored in the ECID Service.

This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall.

C#

iOS Syntax

public unsafe static void GetExperienceCloudId (Action<NSString> callback);

• callback is a callback containing the experience cloud id if the getExperienceCloudId API executed without any errors.

Android Syntax

public unsafe static void GetExperienceCloudId (IAdobeCallback callback);

• callback is a callback containing the experience cloud id if the getExperienceCloudId API executed without any errors.

iOS Example

ACPIdentity.GetExperienceCloudId(callback => {
  Console.WriteLine("Experience cloud id: " + callback);
});

Android Example

ACPIdentity.GetExperienceCloudId(new StringCallback());
​
class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Experience cloud id: " + stringContent);
    } 
    else 
    {
      Console.WriteLine("null content in string callback");
    }
  }
}

getIdentifiers

This getIdentifiers API returns all customer identifiers that were previously synced with the Adobe Experience Cloud.

iOS

Syntax

+ (void) getIdentifiers: (nonnull void (^) (NSArray<ADBMobileVisitorId*>* __nullable visitorIDs)) callback;
+ (void) getIdentifiersWithCompletionHandler: (nonnull void (^) (NSArray<ACPMobileVisitorId*>* __nullable visitorIDs, NSError* __nullable error)) completionHandler;

• callback is invoked after the customer identifiers are available.

• completionHandler is invoked with visitorIDs after the customer identifiers are available, or error if an unexpected error occurs or the request times out. The returned NSError contains the ACPError code of the specific error. The default timeout is 500ms.

Examples

Objective-C

[ACPIdentity getIdentifiers:^(NSArray<ACPMobileVisitorId *> * _Nullable retrievedVisitorIds) {    
    // handle the retrieved identifiers here     
}];
​
[ACPIdentity getIdentifiersWithCompletionHandler:^(NSArray<ACPMobileVisitorId *> * _Nullable visitorIDs, NSError * _Nullable error) {
  if (error) {
    // handle error here
  } else {
    // handle the retrieved identifiers here
  }
}];

Swift

ACPIdentity.getIdentifiers { (retrievedVisitorIds) in    
   // handle the retrieved identifiers here        
}
​
ACPIdentity.getIdentifiersWithCompletionHandler { (retrievedVisitorIds, error) in
  if let error = error {
    // handle error here
  } else {
    // handle the retrieved identifiers here
  }
}

getIdentifiers

This API returns all customer identifiers that were previously synced with the Adobe Experience Cloud.

JavaScript

Syntax

getIdentifiers(): Promise<Array<?ACPVisitorID>>;

Example

ACPIdentity.getIdentifiers().then(identifiers => console.log("AdobeExperienceSDK: Identifiers = " + identifiers));

getIdentifiers

This API returns all customer identifiers that were previously synced with the Adobe Experience Cloud.

Dart

Syntax

 Future<List<ACPMobileVisitorId>> identifiers;

Example

List<ACPMobileVisitorId> result;
​
try {
  result = await FlutterACPIdentity.identifiers;
} on PlatformException {
  log("Failed to get identifiers");
}

getIdentifiers

This API returns all customer identifiers that were previously synced with the Adobe Experience Cloud.

Cordova

Syntax

ACPIdentity.getIdentifiers(success, fail);

• success is a callback containing the previously synced identifiers if the getIdentifiers API executed without any errors.

• fail is a callback containing error information if the getIdentifiers API was executed with errors.