Identity API Reference

Synch Identifiers

Updates the specified customer ID with the Adobe Experience Cloud ID service.

This API synchronizes the provided customer identifier type key and value with the given authentication state to the Adobe Experience Cloud ID Service. If the specified customer ID type exists in the service, this ID type is updated with the new ID and authentication state. Otherwise, a new customer ID is added. This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall. If the current SDK privacy status is optedout, calling this method results in no operations being performed.

{% tabs %} {% tab title="Android" %}

syncidentifier

Syntax

public static void syncIdentifier(final String identifierType,
                                      final String identifier,
                                      final VisitorID.AuthenticationState authenticationState);

Example

Identity.syncIdentifier("idType", "idValue", VisitorID.AuthenticationState.AUTHENTICATED);

synchidentifiers

Tip: The identifiers map contains IDs with the Identifier type as the key, and the string identifier as the value.

Syntax

public static void syncIdentifiers(final Map<String, String> identifiers,
                                       final VisitorID.AuthenticationState authenticationState)

Example

Map<String, String> identifiers = new HashMap<String, String>();
identifiers.put("idType", "idValue");
Identity.syncIdentifier(identifiers, VisitorID.AuthenticationState.AUTHENTICATED);

synchidentifiers (overloaded)

Tip: All given customer IDs are given the default authentication state of UNKNOWN.

These IDs are preserved between app upgrades, are saved and restored during the standard application backup process, and are removed at uninstall. If the current SDK privacy status is optedout, calling this method results in no operations being performed.

Tip: The identifiers dictionary contains IDs with the Identifier type as the key, and the string identifier as the value.

Syntax

public static void syncIdentifiers(final Map<String, String> identifiers);

Example

Map<String, String> identifiers = new HashMap<String, String>();
identifiers.put("idType", "idValue");
Identity.syncIdentifier(identifiers);

{% endtab %}

{% tab title="iOS" %}

syncIdentifier

Updates the provided customer ID with the Adobe Experience Cloud ID Service.

This API synchronizes the provided customer identifier type key and value with the provided authentication state to the Adobe Experience Cloud ID Service. If this customer ID type exists in the service, this type is updated with the new ID and authentication state. Otherwise a new customer ID is added. This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall. If the current SDK privacy status is optedout, calling this method results in no operations being performed.

Syntax

+ (void) syncIdentifier: (nonnull NSString*) identifierType             
             identifier: (nonnull NSString*) identifier
         authentication: (ADBMobileVisitorAuthenticationState) authenticationState;

Examples

Objective-C

[ACPIdentity syncIdentifier:@"idType" identifier:@"idValue" authentication:ACPMobileVisitorAuthenticationStateUnknown];

Swift

ACPIdentity.syncIdentifier("idType", identifier: "idValue", authentication: ACPMobileVisitorAuthenticationState.unknown)

syncIdentifiers {#syncidentifiers}

Updates the provided customer IDs with the Adobe Experience Cloud ID Service.

This API synchronizes the provided customer identifiers to the Adobe Experience Cloud ID Service. If a customer ID type matches an existing ID type, it is updated with the new ID value and authentication state. New customer IDs are added. These IDs are preserved between app upgrades, are saved and restored during the standard application backup process, and are removed at uninstall. If the current SDK privacy status is optedout, calling this method results in no operations being performed.

Tip: The identifiers dictionary contains IDs with the Identifier type as the key, and the string identifier as the value.

Syntax

+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers;

Examples

Objective-C

NSDictionary *ids = @{@"idType":@"idValue"};
[ACPIdentity syncIdentifiers:ids];

Swift

let identifiers : [String: String] = ["idType1":"idValue1", "idType2":"idValue2"];
ACPIdentity.syncIdentifiers(identifiers)

syncIdentifiers (overloaded) {#syncidentifiers-overloaded}

Updates the provided customer IDs with the Adobe Experience Cloud ID Service.

This API synchronizes the provided customer identifiers to the Adobe Experience Cloud ID Service. If a customer ID type matches an existing ID type, the customer ID is updated with the new ID value and authentication state. New customer IDs are added. These IDs are preserved between app upgrades, are saved and restored during the standard application backup process, and are removed at uninstall. If the current SDK privacy status is optedout, calling this method results in no operations being performed.

Tip: The identifiers dictionary contains IDs with the Identifier type as the key, and the string identifier as the value.

Syntax

+ (void) syncIdentifiers: (nullable NSDictionary*) identifiers          
         authentication: (ACPMobileVisitorAuthenticationState) authenticationState;

Examples

Objective-C

NSDictionary *ids = @{@"idType":@"idValue"};
[ACPIdentity syncIdentifiers:ids authentication:ACPMobileVisitorAuthenticationStateAuthenticated];

Swift

let identifiers : [String: String] = ["idType1":"idValue1", "idType2":"idValue2"];ACPIdentity.syncIdentifiers(identifiers, authentication: 
ACPMobileVisitorAuthenticationState.authenticated)

{% endtab %} {% endtabs %}

Append Visitor Data to a URL

{% tabs %} {% tab title="Android" %}

appendVisitorInfoForURL

Appends Adobe visitor data to a URL string. If the provided URL is null or empty, it is returned as is. Otherwise, the following information is added to the url string that is returned in the AdobeCallback instance:

The adobe_mc attribute is an URL encoded list containing:
- Experience Cloud ID (ECID)
- Experience Cloud Org ID
- A timestamp taken when this request was made
The optional adobe_aa_vid attribute is the URL encoded Analytics Custom Visitor ID, if available

Syntax

public static void appendVisitorInfoForURL(final String baseURL, final AdobeCallback<String> callback);

Example

Identity.appendVisitorInfoForURL("http://myurl.com", new AdobeCallback<String>() {    
    @Override    
    public void call(String urlWithAdobeVisitorInfo) {        
        //handle the new URL here        
        //For example, open the URL on the device browser        
        //        
        Intent i = new Intent(Intent.ACTION_VIEW);        
        i.setData(Uri.parse(urlWithAdobeVisitorInfo));        
        startActivity(i);    
    }
});

{% endtab %}

{% tab title="iOS" %}

appendToURL

Appends Adobe visitor data to a URL.

If the provided URL is nil or empty, it is returned as is. Otherwise, the following information is added to the url string that is returned via the callback:

The adobe_mc attribute is an URL encoded list containing:
- Experience Cloud ID (ECID)
- Experience Cloud Org ID
- A timestamp taken when this request was made
The optional adobe_aa_vid attribute is the URL-encoded Analytics Custom Visitor ID, if available.

Syntax

+ (void) appendToUrl: (nullable NSURL*) baseUrl withCallback: (nullable void (^) (NSURL* __nullable urlWithVisitorData)) callback;

Examples

Objective-C

NSURL* url = [[NSURL alloc] initWithString:@"www.myUrl.com"];
[ACPIdentity appendToUrl:url withCallback:^(NSURL * _Nullable urlWithVisitorData) {    
// handle the appended url here}
}];

Swift

ACPIdentity.append(to:URL(string: "www.myUrl.com"), withCallback: {(appendedURL) in    
    // handle the appended url here

});

{% endtab %} {% endtabs %}

Get Identifiers

{% tabs %} {% tab title="Android" %}

getIdentifiers

Returns all customer identifiers which were previously synced with the Adobe Experience Cloud.

The values are returned through the AdobeCallback.

Syntax

public static void getIdentifiers(final AdobeCallback<List<VisitorID>> callback);

Example

Identity.getIdentifiers(new AdobeCallback<List<VisitorID>>() {    
    @Override    
    public void call(List<VisitorID> idList) {        
         //Process the IDs here    
    }

});

{% endtab %}

{% tab title="iOS" %}

getIdentifiers

Returns all customer identifiers which were previously synced with the Adobe Experience Cloud.

Syntax

+ (void) getIdentifiers: (nonnull void (^) (NSArray<ADBMobileVisitorId*>* __nullable visitorIDs)) callback;

Examples

Objective-C

[ACPIdentity getIdentifiers:^(NSArray<ACPMobileVisitorId *> * _Nullable retrievedVisitorIds) {    
    // handle the retrieved Identifiers here     
    }];

Swift

ACPIdentity.getIdentifiers { (retrievedVisitorIds) in    
   // handle the retrieved Identifiers here        
}

{% endtab %} {% endtabs %}

Get Experience Cloud IDs

{% tabs %} {% tab title="Android" %}

getExperienceCloudId

Retrieves the Experience Cloud ID from the Experience Cloud ID Service.

The Experience Cloud ID is generated at initial launch and is stored and used from that point forward. 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 AdobeCallback.

Syntax

public static void getExperienceCloudId(final AdobeCallback<String> callback);

Example

Identity.getExperienceCloudId(new AdobeCallback<String>() {    
    @Override    
    public void call(String id) {        
         //Handle the ID returned here    
    }
});

{% endtab %}

{% tab title="iOS" %}

getExperienceCloudId

Retrieves the Adobe Experience Cloud Visitor ID from the Adobe Experience Cloud ID Service.

The Experience Cloud ID is generated at initial launch and is stored and used from that point. This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall.

Syntax

+ (void) getExperienceCloudId: (nonnull void (^) (NSString* __nullable experienceCloudId)) callback;

Examples

Objective-C

[ACPIdentity getExperienceCloudId:^(NSString * _Nullable retrievedCloudId) {    
// handle the retrieved Id here    
}];

Swift

ACPIdentity.getExperienceCloudId { (retrievedCloudId) in    
    // handle the retrieved Id here    
}

{% endtab %} {% endtabs %}

Set an Advertising Identifier

{% tabs %} {% tab title="Android" %}

setAdvertisingIdentifier

This API is part of the MobileCore extension. Adobe Identity extension supports the API, and sets the advertising identifier in the SDK.

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

Remember the following information:

If the Adobe Cloud Platform SDK is configured with identity.adidEnabled set to false, then the advertising identifier is not set or stored.
If the current SDK privacy status is optedout, then the advertising identifier is not set.

Syntax

public static void setAdvertisingIdentifier(final String advertisingIdentifier);

Example

MobileCore.setAdvertisingIdentifier("advertising_identifier");

{% endtab %}

{% tab title="iOS" %}

setAdvertisingIdentifier

This API is part of the ACPCore extension. Adobe Identity extension supports the API and sets the advertising identifier in the SDK.

If the IDFA was set in the SDK, the IDFA will be sent in lifecycle. It can also be accessed in Signals (Postbacks). This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall.

Remember the following information:

If the Adobe Experience Cloud Platform SDKs is configured with identity.adidEnabled set to false, the advertising identifier is not set or stored.
If the current SDK privacy status is optedout, the advertising identifier is not set.

Syntax

+ (void) setAdvertisingIdentifier: (nullable NSString*) adId;

Examples

Objective-C

[ACPCore setAdvertisingIdentifier:@"AdvertisingId"];

Swift

ACPCore.setAdvertisingIdentifier("AdvertisingId")

{% endtab %} {% endtabs %}

Set the Push Identifier

{% tabs %} {% tab title="Android" %}

setPushIdentifier

This API is part of the MobileCore extension. Adobe Identity extension supports the API, and sets the device token for push notifications in the SDK. If the current SDK privacy status is optedout, the push identifier is not set.

Syntax

public static void setPushIdentifier(final String pushIdentifier);

Example

//Retrieve the token from either GCM or FCM, and pass it to the SDK
MobileCore.setPushIdentifier(token);

{% endtab %}

{% tab title="iOS" %}

setPushIdentifier

This API is part of the ACPCore extension. Adobe Identity extension supports the API, and sets the device token for push notifications in the SDK. If the current SDK privacy status is optedout, the push identifier is not set.

Syntax

+ (void) setPushIdentifier: (nullable NSData*) deviceToken;

Examples

Objective-C

// Set the deviceToken that the APNS has assigned to the device
[ACPCore setPushIdentifier:deviceToken];

Swift

// Set the deviceToken that the APNs has assigned to the device
ACPCore.setPushIdentifier(deviceToken)

{% endtab %} {% endtabs %}

Identity Service Classes

{% tabs %} {% tab title="Android" %} Here are the service classes for Identity in Android:

AdobeCallback {#adobecallback}

This class provides the interface to receive results when the async APIs perform the requested action. For more information about these methods, see Identity Service methods in Android.

public interface AdobeCallback<T> {    
    void call(final T value);
}

VisitorID {#visitorid}

An identifier to be used with the Experience Cloud Visitor ID Service.

public class VisitorID {    
     //Constructor    
     public VisitorID(String idOrigin, String idType, String id, VisitorID.AuthenticationState authenticationState);    

     public VisitorID.AuthenticationState getAuthenticationState();    

     public final String getId();    

     public final String getIdOrigin();    

     public final String getIdType();

}

AuthenticationState {#authenticationstate}

Used to indicate the authentication state for the current VisitorID.

public enum AuthenticationState {        
       UNKNOWN,        
       AUTHENTICATED,        
       LOGGED_OUT;
}

{% endtab %}

{% tab title="iOS" %}

ACPMobileVisitorId

An identifier to be used with the Experience Cloud Visitor ID Service.

Contains the origin, the type, a value, and the authentication state of the visitor ID.

@interface ACPMobileVisitorId : NSObject

@property(nonatomic, strong, nullable) NSString* idOrigin;
@property(nonatomic, strong, nullable) NSString* idType;
@property(nonatomic, strong, nullable) NSString* identifier;
@property(nonatomic, readwrite) ACPMobileVisitorAuthenticationState authenticationState;

@end

ACPMobileVisitorAuthenticationState {#acpmobilevisitorauthenticationstate}

Used to indicate the authentication state for the current VisitorID.

typedef NS_ENUM(NSUInteger, 
    ADBMobileVisitorAuthenticationState) {    
    ACPMobileVisitorAuthenticationStateUnknown          = 0,    
    ACPMobileVisitorAuthenticationStateAuthenticated    = 1,    
    ACPMobileVisitorAuthenticationStateLoggedOut        = 2  };

{% endtab %} {% endtabs %}

Files

identity-api-reference.md

Latest commit

History

identity-api-reference.md

File metadata and controls

Identity API Reference

Synch Identifiers

syncidentifier

Syntax

Example

synchidentifiers

Syntax

Example

synchidentifiers (overloaded)

Syntax

Example

syncIdentifier

Syntax

Examples

syncIdentifiers {#syncidentifiers}

Syntax

Examples

syncIdentifiers (overloaded) {#syncidentifiers-overloaded}

Syntax

Examples

Append Visitor Data to a URL

appendVisitorInfoForURL

Syntax

Example

appendToURL

Syntax

Examples

Get Identifiers

getIdentifiers

Syntax

Example

getIdentifiers

Syntax

Examples

Get Experience Cloud IDs

getExperienceCloudId

Syntax

Example

getExperienceCloudId

Syntax

Examples

Set an Advertising Identifier

setAdvertisingIdentifier

Syntax

Example

setAdvertisingIdentifier

Syntax

Examples

Set the Push Identifier

setPushIdentifier

Syntax

Example

setPushIdentifier

Syntax

Examples

Identity Service Classes

AdobeCallback {#adobecallback}

VisitorID {#visitorid}

AuthenticationState {#authenticationstate}

ACPMobileVisitorId

ACPMobileVisitorAuthenticationState {#acpmobilevisitorauthenticationstate}