Edit in GitHubLog an issue

Frequently asked questions

Q: I am using Edge and Adobe Solutions extensions, which Identity extension should I install and register?

A: Both.

When using both Adobe Experience Platform Edge and Adobe Solutions extensions, both Identity for Edge Network and Identity for Experience Cloud ID Service extensions can be registered with the Mobile SDK at the same time.

Download and import the Identity and Identity for Edge Network extensions

  1. Add the Mobile Core and Edge extensions to your project using the app's Gradle file.

Kotlin

Copied to your clipboard
implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:identity")
implementation("com.adobe.marketing.mobile:edge")
implementation("com.adobe.marketing.mobile:edgeidentity")

Groovy

Copied to your clipboard
implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:identity'
implementation 'com.adobe.marketing.mobile:edge'
implementation 'com.adobe.marketing.mobile:edgeidentity'
  1. Import the Mobile Core and Edge extensions in your application class but do not include the Identity or Identity for Edge Network extensions. Instead, use their fully qualified names during registration and when calling their APIs.
Copied to your clipboard
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Edge;

Register the Identity and Identity for Edge Network extensions with Mobile Core

Java

Copied to your clipboard
public class MobileApp extends Application {
    // Set up the preferred Environment File ID from your mobile property configured in Data Collection UI
    private final String ENVIRONMENT_FILE_ID = "";


    @Override
    public void onCreate() {
      super.onCreate();
      MobileCore.setApplication(this);
      MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);


      // Register Adobe Experience Platform SDK extensions
      MobileCore.registerExtensions(
         Arrays.asList(
            Edge.EXTENSION, 
            com.adobe.marketing.mobile.edge.identity.Identity.EXTENSION,
            com.adobe.marketing.mobile.Identity.EXTENSION
            ),
         o -> Log.debug("MobileApp", "MobileApp", "Adobe Experience Platform Mobile SDK initialized.")
       );
    }
}

Kotlin

Copied to your clipboard
class MobileApp : Application() {
    // Set up the preferred Environment File ID from your mobile property configured in Data Collection UI
    private var ENVIRONMENT_FILE_ID: String = ""
    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID)
        // Register Adobe Experience Platform SDK extensions
        MobileCore.registerExtensions(
            listOf(
                Edge.EXTENSION, 
                com.adobe.marketing.mobile.edge.identity.Identity.EXTENSION,
                com.adobe.marketing.mobile.Identity.EXTENSION
                )
        ) {
            Log.debug("MobileApp", "MobileApp", "Adobe Experience Platform Mobile SDK initialized.")
        }
    }
}

Q: Will an existing Experience Cloud ID (ECID) migrate to the Identity for Edge Network extension?

A: Yes.

If the application previously installed the Identity for Experience Cloud ID Service extension and upgrades to the Identity for Edge Network extension, the existing ECID value is migrated to the Identity for Edge Network extension on first launch of the application.

Note, however, if the Mobile SDK's privacy status was set to optedOut at the time the application is upgraded, the Identity for Experience Cloud ID Service extension will not have an ECID, as it was cleared. In this case, the Identity for Edge Network extension will generate a new ECID.

Q: What is the Experience Cloud ID (ECID) used by the SDK when using both AEP Edge extensions and Adobe Solutions extensions?

A: The Identity for Edge Network extension and the Identity for Experience Cloud ID Service extension each manage their own ECID. However, the two ECIDs are synced as part of the XDM IdentityMap.

At first launch of the application after upgrading to the Identity for Edge Network extension, the existing ECID from the Identity for Experience Cloud ID Service extension is migrated to the Identity for Edge Network extension. In this case both extensions will have the same ECID value.

The resetIdentities API causes the Identity for Edge Network extension and the Identity for Experience Cloud ID Service extension to independently generate new ECID values. After calling this API, the ECID used by each identity extension will be different.

Changing the privacy status to optedOut will clear the ECID value used by the Identity for Experience Cloud ID Service extension. Changing the privacy status back to optedIn will generate a new ECID used by the Identity for Experience Cloud ID Service extension. Privacy status changes do not change the ECID used by the Identity for Edge Network extension. Changing the privacy status will cause the ECID used by each identity extension to be different.

When each identity extension has a different ECID, the Identity for Edge Network extension will include the Identity for Experience Cloud ID Service ECID in its IdentityMap, and so the Adobe Experience Platform Identity Service will link the the two ECIDs in the customer's Identity Graph.

The following example shows an IdentityMap containing the ECIDs from both Identity for Edge Network extension and Identity for Experience Cloud ID Service extension. The ECID from the Identity for Edge Network extension is always listed first in the list of ECIDs.

Copied to your clipboard
"identityMap" : {
      "ECID" : [
        {
          "id" : "73586628797489658169123381027155647197",
          "authenticatedState" : "ambiguous",
          "primary" : false
        },
        {
          "id" : "81117527655405132265917409409236407340",
          "authenticatedState" : "ambiguous",
          "primary" : false
        }
      ]
    }

Q: I set privacy status to opted out, why do I see an ECID value when calling Identity.getExperienceCloudId()?

A: The Identity for Edge Network extension does not change its ECID based on privacy status changes.

The Identity for Edge Network extension does not clear its stored identities or regenerate the ECID due to privacy status changes. Instead, use the resetIdentities API. Note this API does not clear the ECID but instead generates a new ECID.

Each identity extension has its own API to retrieve their respective ECIDs as well. Use Identity.getExperienceCloudId to get the Identity for Edge Network extension's ECID, and Identity.getExperienceCloudId to get the Identity for Experience Cloud ID Service extension's ECID.

Q: How can I get all the identifiers used by the SDK when using both Edge extensions and Adobe Solutions extensions?

A: Use both getSdkIdentities and getIdentities

To get the identifiers used by the Adobe Solutions extensions, call getSdkIdentities.

To get the identifiers used by the Edge extensions, call getIdentities.

Q: How can I clear all the identifiers from the SDK when using both Edge extensions and Adobe Solutions extensions?

A: Set privacy status to optedOut and call resetIdentities

To clear the identifiers used by the Adobe Solutions extensions, call setPrivacyStatus and set the privacy status to optedOut.

To clear the identifiers used by the Edge extensions, call resetIdentities

Q: In what cases is the Experience Cloud ID (ECID) reset or cleared?

A: The Identity for the Edge Network extension does not automatically reset or clear the ECID. If you observe the ECID being reset, identify if it falls into one of the following cases:

Q: What steps are needed to generate a new Experience Cloud ID (ECID) for a user when using both Edge extensions and Adobe Solutions extensions?

A: Both identity extensions' ECID must be regenerated in sequence to avoid linking the old and new ECIDs in Adobe Experience Platform.

When using Real-time Customer Profile and Identity Service, the ECIDs from both identity extensions are linked together in the customer's Identity Graph. Care must be taken when regenerating new ECIDs such that the old and new ECIDs are not linked within the same Identity Graph.

Perform the following API calls to regenerate the ECIDs in sequence:

  1. Set privacy status to optedOut to clear the ECID from the Identity direct service extension.
  2. Call resetIdentities to regenerate a new ECID in the Identity for Edge Network extension.
  3. Call getExperienceCloudId on the Identity for Edge Network extension. This ensures the new ECID is generated before continuing.
  4. Set privacy status to optedIn to generate a new ECID in the Identity direct service extension.

After completing the above steps, each identity extension will have its own, different, ECID. The new ECIDs will get linked under a new Identity Graph for the customer.

Java

Copied to your clipboard
MobileCore.setPrivacyStatus(MobilePrivacyStatus.OPT_OUT);
MobileCore.resetIdentities();
com.adobe.marketing.mobile.edge.identity.Identity.getExperienceCloudId(new AdobeCallback<String>() {
    @Override
    public void call(String s) {
        // ignore
    }
});
MobileCore.setPrivacyStatus(MobilePrivacyStatus.OPT_IN);

Q: Can I safely remove the Identity for Experience Cloud ID Service extension in an app if I am using the Edge Network extension?

If no other extension relies on the Identity for Experience Cloud ID Service extension, you can safely remove it. Please refer to the Identity consideration document for more information.

Q: I am passing the ECID from to the WebView using getUrlVariables API, but the web interactions get a new ECID assigned, how do I fix this?

  1. Ensure that the output from the getUrlVariables API includes accurate ECID and Experience Cloud orgID values. Please note that the orgID set up for the Mobile SDK must match the orgID configured in the Web SDK.
  2. Make sure the timestamp (TS) included in the getUrlVariables result did not expire (that is, it is not older than 5 minutes since the time it was retrieved). For this reason, it is recommended that the result from getUrlVariables is not cached and reused in the app, but retrieved on demand before loading the WebView.
  3. The query string returned by the getUrlVariables API is already encoded, so please ensure that you do not re-encode the generated query string.
  4. If you are using Visitor ID and AppMeasurement, please make sure that you have the latest versions.

For further information, refer to the documentation on mobile-to-web and cross-domain ID sharing and handling WebViews.

Calise CheungTim KimStephen Cheng
Last updated 10/18/2024
Was this helpful?

Community

Support

Adobe Developer

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.