Skip to content

Latest commit

 

History

History
249 lines (186 loc) · 8.41 KB

README.md

File metadata and controls

249 lines (186 loc) · 8.41 KB
Raw

Identity

The Identity framework is bundled with Mobile Core and enables your app with the ECID. This service helps with the synchronization of Adobe and other customer identifiers.

{% hint style="danger" %} On web or other platforms, there might situations where this framework might not be required, and the implementation of this SDK framework on mobile apps is required. {% endhint %}

{% hint style="info" %} If an application is using the Adobe Experience Platform Edge Network extension, then the Identity for Edge Network extension is required. {% endhint %}

To get started with Identity, complete the following steps:

  1. Add the Identity framework to your app.
  2. Implement the SDK APIs to complete the following tasks:
    • Update customer IDs.
    • Append Adobe visitor data to a URL string.
    • Return customer IDs.
    • Retrieve Experience Cloud IDs.
    • Set advertising IDs.
    • Set the device notification for push notifications.

Add the Identity framework to your app

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

Java

Import the library:

import com.adobe.marketing.mobile.*;

{% endtab %}

{% tab title="iOS" %}

iOS

Import the Identity extension:

Objective-C

@import AEPIdentity;

Swift

In swift, the ACPCore includes ACPIdentity :

import AEPIdentity

{% endtab %} {% endtabs %}

Register the Identity extension

The registerExtension() API registers the Identity extension with the Mobile Core extension. This API allows the extension to send and receive events to and from the Mobile SDK.

To register the Identity extension, use the following code sample:

{% tabs %} {% tab title="Android" %} After calling the setApplication() method in the onCreate() method, register the extension. If the registration was not successful, an InvalidInitException is thrown.

Java

public class MobiletApp extends Application {
@Override
public void onCreate() {
super.onCreate();
     MobileCore.setApplication(this);
     try {
         Identity.registerExtension();
     } catch (Exception e) {
         //Log the exception
     }
  }
}

{% endtab %}

{% tab title="iOS" %}

iOS

Register the Identity extension in your app's didFinishLaunchingWithOptions function:

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPCore configureWithAppId:@"yourAppId"];
    NSArray *extensionsToRegister = @[AEPMobileIdentity.class, AEPMobileLifecycle.class, AEPMobileSignal.class];
    [AEPMobileCore registerExtensions:extensionsToRegister completion:^{
        [AEPMobileCore lifecycleStart:@{@"contextDataKey": @"contextDataVal"}];
    }];
    // Override point for customization after application launch.
    return YES;
 }

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
     ACPCore.configure(withAppId: "yourAppId")   
     MobileCore.registerExtensions([Lifecycle.self, Identity.self, Signal.self]){       
       MobileCore.lifecycleStart(additionalContextData: ["contextDataKey": "contextDataVal"])
     }
     // Override point for customization after application launch.
     return true;
}

{% endtab %} {% endtabs %}

{% hint style="info" %} Previously known as MCID, the Experience Cloud ID (ECID) uniquely identifies each visitor in the Adobe Experience Platform and is a 38-character ID. {% endhint %}

After the configuration is complete, an ECID is generated and, where applicable, is included on all Analytics and Audience Manager hits. Other IDs, such as custom and automatically-generated IDs, continue to be sent with each hit.

Version of the Identity extension

The extensionVersion() API returns the version of the Identity extension that is registered with the Mobile Core extension.

To get the version of the Identity extension, use the following code sample:

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

Java

String identityExtensionVersion = Identity.extensionVersion();

{% endtab %}

{% tab title="iOS" %}

iOS

Objective-C

NSString *identityExtensionVersion = [AEPMobileIdentity extensionVersion];

Swift

var identityExtensionVersion  = AEPIdentity.extensionVersion

{% endtab %} {% endtabs %}

Visitor tracking between an app and the mobile web

If your app opens mobile web content, you need to ensure that visitors are not identified separately as they move between the native and mobile web.

Visitor IDs in apps

The Mobile SDK generates a unique visitor ID when the app is installed. This ECID is stored in persistent memory on the mobile device and is sent with every hit. The ECID is removed when the user uninstalls the app or when the user sets the Mobile SDK global privacy status to Opt-out.

{% hint style="info" %} When the Mobile SDK privacy status is set to Opt-out, and the ECID is removed, a new unique visitor ID (ECID) is generated when the user sets the global privacy status to Opt-In. {% endhint %}

{% hint style="info" %} App visitor IDs persist through upgrades. {% endhint %}

Visitor IDs in the mobile web

Typical mobile web implementations use the same standard analytics s_code.js or AppMeasurement.js that is used in desktop sites. The JavaScript libraries have their own methods of generating unique visitor IDs, which causes a different visitor ID to be generated when you open mobile web content from your app.

To use the same visitor ID in the app and mobile web and pass the visitor ID to the mobile web in the URL, complete the following steps:

Implementing visitor tracking between an app and the mobile web

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

Java

To append visitor information to the URL that is being used to open the web view, call appendVisitorInfoForUrl:

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);    
    }
});

Alternately, starting in SDK version 1.4.0 (Identity version 1.1.0), you can call getUrlVariables and build your own URL:

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

{% endtab %}

{% tab title="iOS" %}

Objective-C

To append visitor information to the URL that is being used to open the web view, call appendToUrl:

NSURL* url = [[NSURL alloc] initWithString:@"www.myUrl.com"];

[AEPMobileIdentity appendToUrl:url completion:^(NSURL * _Nullable url, NSError * error) { 
// handle the appended url here
}];

Alternately, you can call getUrlVariables and build your own URL:

[AEPMobileIdentity getUrlVariables:^(NSString * _Nullable urlVariables, NSError * error) { 
  // handle the URL query parameter string here
  NSString* urlString = @"http://myUrl.com";
  NSString* urlStringWithVisitorData = [NSString stringWithFormat:@"%@?%@", urlString, urlVariables];
  NSURL* urlWithVisitorData = [NSURL URLWithString:urlStringWithVisitorData];
  [[UIApplication sharedApplication] openURL:urlWithVisitorData options:@{} completionHandler:^(BOOL success) {
    // handle openURL success
  }];
}];

{% endtab %} {% endtabs %}

The ID service code on the destination domain extracts the ECID from the URL instead of sending a request to Adobe for a new ID. The ID service code on the destination page uses this ECID to track the visitor. On hits from the mobile web content, verify that the mid parameter exists on each hit, and that this value matches the midvalue that is being sent by the app code.