Skip to content

README.md

Latest commit

 

History

History
250 lines (186 loc) · 8.27 KB

README.md

File metadata and controls

250 lines (186 loc) · 8.27 KB

Adobe Journey Optimizer

The Adobe Journey Optimizer extension for Adobe Experience Platform Mobile SDKs powers push notifications for your mobile apps. This extension helps you collects user push tokens and manages interaction measurement with Adobe Experience Platform services.

The following documentation details how to use the extension as well as the required configuration across Adobe Experience Platform services, app stores, and your apps to get started with push notifications for Adobe Journey Optimizer.

Before starting

  1. Follow the steps in this page to configure push channel in Adobe Journey Optimizer.
  2. Update your app's Datastream in Adobe Experience Platform Data Collection
  3. Integrate with following extensions:

Update Datastream with Profile Dataset

Navigate to a previously configured Datastream by following Configure datastreams in Adobe Experience Platform Data Collection, then:

Select the pre-created CJM Push Profile Dataset in Profile Dataset dropdown (under Adobe Experience Platform section) and select Save.

Setup Adobe Journey Optimizer extension

Configure extension in Launch

Navigate to Experience Platform Data Collection - select mobile property and navigate to Extensions from the left navigation panel**:**

  1. Navigate to the Catalog tab, locate the Adobe Journey Optimizer extension, and select Install
  2. Select the pre-created CJM Push Tracking Event Dataset from the Event Dataset dropdown.
  3. Click Save.
  4. Follow the publishing process to update SDK configuration.

{% hint style="info" %} The datasets selected should use a schema that uses the Push Notification Tracking XDM field group. The pre-created CJM Push Tracking Dataset contains this XDM field group in its schema definition. For more information, see Set up schemas and datasets. {% endhint %}

Implement extension in mobile app

Follow these steps to integrate the Adobe Journey Optimizer extension.

Import the extension

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

Java

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

    implementation 'com.adobe.marketing.mobile:core:1.+'
implementation 'com.adobe.marketing.mobile:edge:1.+'
implementation 'com.adobe.marketing.mobile:edgeidentity:1.+'
implementation 'com.adobe.marketing.mobile:messaging:1.+'

  2. Import the Mobile Core, Edge, EdgeIdentity and Messaging extensions in your application class.

     import com.adobe.marketing.mobile.*;
 import com.adobe.marketing.mobile.edge.identity.Identity;

{% endtab %}

{% tab title="iOS" %}

  1. Add the Mobile Core, Edge, EdgeIdentity and Messaging extensions to your project using Cocoapods. Add following pods in your Podfile:

    use_frameworks!
target 'YourTargetApp' do
    pod 'AEPCore'
    pod 'AEPEdge'
    pod 'AEPEdgeIdentity'
    pod 'AEPMessaging'
end

  2. Import the Mobile Core, Edge, EdgeIdentity and Messaging libraries:

Swift

// AppDelegate.swift
import AEPCore
import AEPEdge
import AEPEdgeIdentity
import AEPMessaging

Objective-C

// AppDelegate.h
@import AEPCore;
@import AEPEdge;
@import AEPEdgeIdentity;
@import AEPMessaging;

{% endtab %} {% endtabs %}

Register extension with Mobile Core

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

Java

public class MobileApp extends Application {
    @Override
    public void onCreate() {
      super.onCreate();
      MobileCore.setApplication(this);
      MobileCore.configureWithAppID("yourLaunchEnvironmentID");
      try {
        Edge.registerExtension();
        Identity.registerExtension();
        Messaging.registerExtension(); // register Messaging
        MobileCore.start(new AdobeCallback() {
          @Override
          public void call(final Object o) {
            // processing after start
          }});
      } catch (Exception e) {
        //Log the exception
      }
    }
}

{% endtab %}

{% tab title="iOS" %}

Swift

// AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    MobileCore.registerExtensions([Identity.self, Edge.self, Messaging.self], {
        MobileCore.configureWith(appId: "yourLaunchEnvironmentID")
    })
  ...
}

Objective-C

// AppDelegate.m
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@[AEPMobileEdgeIdentity.class, AEPMobileEdge.class, AEPMobileMessaging.class] completion:^{
    [AEPMobileCore configureWithAppId: @"yourLaunchEnvironmentID"];
  }];
  ...
}

{% endtab %} {% endtabs %}

Synch user push token with Adobe

Use the setPushIdentifier API to sync user push token from the device with Adobe Experience Platform services.

{% tabs %} {% tab title="Android" %} To retrieve the push token from Firebase Messaging Service follow this Firebase documentation. After retrieving the push token use the below core API to sync it with profile in platform.

Java

Syntax

public static void setPushIdentifier(final String pushIdentifier);
  • pushIdentifier - A String value denoting the push token.

Examples

FirebaseMessaging.getInstance().getToken()
        .addOnCompleteListener(new OnCompleteListener<String>() {
            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (task.isSuccessful()) {
                    String token = task.getResult();
                    MobileCore.setPushIdentifier(token);
                }
            }
        });

{% endtab %}

{% tab title="iOS" %}

Swift

To retrieve the push token in iOS, checkout the apple documentation Apple's documentation.
After retrieving the push token use the below core API to sync it with profile in platform.

Syntax

public static func setPushIdentifier(_ deviceToken: Data?)
  • deviceToken - A Data value denoting the push token.

Examples

func application(_: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    MobileCore.setPushIdentifier(deviceToken)
}

Objective-C

Syntax

public static func setPushIdentifier(_ deviceToken: Data?)
  • deviceToken - A Data value denoting the push token.

Examples

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { 
    [AEPMobileCore setPushIdentifier:deviceToken];
}

{% endtab %} {% endtabs %}

Next Steps

Configuration keys

To update the SDK configuration programmatically, use the following information to change the Messaging configuration values.

Key Required Description Data Type Platform
messaging.eventDataset Yes Experience Event Dataset Id which can be found from experience platform String Android/iOS
messaging.useSandbox No See more details in the Messaging documentation Boolean iOS