Adobe Journey Optimizer - Decisioning
⚠️ This site will no longer be maintained ⚠️
The Adobe Journey Optimizer - Decisioning extension powers real-time personalization workflows using Adobe Journey Optimizer - Offer Decisioning or Adobe Target in mobile apps via the Edge Network. It helps deliver personalized decisions to your app and enables tracking user interactions with the proposed decisions.
Before starting, make sure the following steps are completed.
- Your organization is provisioned for edge decisioning.
- If using Adobe Target, Target activities are set up in your desired workspace in your organization on Target UI. For more details, see the Target activities guide.
- If using Journey Optimizer - Offer Decisioning, decisions are set up in your desired sandbox in your organization on Experience Platform UI. For more details, see the create decisions guide.
On Experience Platform Data Collection, navigate to Data Collection > Datatreams using the left navigation panel. Select an existing datastream or create a new datastream. For more details, see the configure datastreams guide.
- 1.In the datastream, click on the desired environment from the list. Make sure Adobe Experience Platform section is enabled and configured with the required information like Sandbox and Event Dataset.
- 2.For Journey Optimizer - Offer Decisioning, navigate to Adobe Experience Platform section and enable Offer Decisioning checkbox.
- 3.For Adobe Target, navigate to Adobe Target section and enable it. Specify the configuration. For more information on the configuration settings, refer to the Administer Target Overview.
- 4.Click Save.
On Experience Platform Data Collection, navigate to Data Collection > Tags using the left navigation panel. Select an existing mobile tag property or create a new property.
- 1.In your mobile property, navigate to Extensions in the left navigation panel and click on the Catalog tab.
- 2.In the extensions Catalog, search or locate the Adobe Journey Optimizer - Decisioning extension, and click Install.
- 3.Since an extension configuration is not necessary, click Save.
- 4.Follow the publishing process to update SDK configuration. For more details, see the publish the configuration guide.
Adobe Journey Optimizer - Decisioning extension configuration
For the AEPOptimize APIs to work properly, you need to integrate Mobile Core and Edge extensions in your mobile app. For more details see, documentation on Mobile Core and Adobe Experience Platform Edge Network.
Android
iOS (AEP 3.x)
Add the Mobile Core, Edge, Identity for Edge Network and Optimize dependencies in your 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:optimize:1.+'
Configure your app target to fetch Mobile Core, Edge, Identity for Edge Network and Optimize from Cocoapods by specifying the following pod dependencies in your
Podfile.platform :ios, '10.0'
use_frameworks!
target 'YourAppTarget' do
pod 'AEPCore'
pod 'AEPEdge'
pod 'AEPEdgeIdentity'
pod 'AEPOptimize'
end
Android
iOS (AEP 3.x)
Java
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Edge;
import com.adobe.marketing.mobile.edge.identity.Identity;
import com.adobe.marketing.mobile.optimize.Optimize;
import com.adobe.marketing.mobile.AdobeCallback;
public class MobileApp extends Application {
@Override
public void onCreate() {
super.onCreate();
MobileCore.setApplication(this);
MobileCore.configureWithAppID(<YOUR_ENVIRONMENT_FILE_ID>); // Replace <YOUR_ENVIRONMENT_FILE_ID> with a String containing your own ID.
Edge.registerExtension();
Identity.registerExtension();
Optimize.registerExtension();
MobileCore.start(new AdobeCallback() {
@Override
public void call(final Object o) {
// processing after start
}});
}
}
Swift
// AppDelegate.swift
import AEPCore
import AEPEdge
import AEPEdgeIdentity
import AEPOptimize
@UIApplicationMain
final class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
// register the extensions
MobileCore.registerExtensions([Edge.self, AEPEdgeIdentity.Identity.self, Optimize.self]) {
MobileCore.configureWith(appId: <YOUR_ENVIRONMENT_FILE_ID>) // Replace <YOUR_ENVIRONMENT_FILE_ID> with a String containing your own ID.
}
return true
}
}
Objective-C
// AppDelegate.m
@import AEPCore;
@import AEPEdge;
@import AEPEdgeIdentity;
@import AEPOptimize;
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// register the extensions
[AEPMobileCore registerExtensions:@[AEPMobileEdge.class, AEPMobileEdgeIdentity.class, , AEPMobileOptimize.class] completion:^{
[AEPMobileCore configureWithAppId: <YOUR_ENVIRONMENT_FILE_ID>]; // Replace <YOUR_ENVIRONMENT_FILE_ID> with a String containing your own ID.
}];
...
}
Some offer constraints, such as Capping, are currently unsupported with the mobile Experience Edge workflows. The Capping field value specifies the number of times an offer can be presented across all users. For more details, see the offer eligibility rules and constraints guide.
The
DecisionScope public class provides a constructor to create a scope object using the activityId, placementId, and optional itemCount. The decision scope activity and placement information can be obtained from the decision on the Experience Platform UI.Android
iOS (AEP 3.x)
Java
final DecisionScope decisionScope = DecisionScope("xcore:offer-activity:1111111111111111", "xcore:offer-placement:1111111111111111", 3);
Swift
let decisionScope = DecisionScope(activityId: "xcore:offer-activity:1111111111111111",
placementId: "xcore:offer-placement:1111111111111111",
itemCount: 3)
Objective-C
AEPDecisionScope* decisionScope = [[AEPDecisionScope alloc] initWithActivityId:@"xcore:offer-activity:1111111111111111"
placementId:@"xcore:offer-placement:1111111111111111"
itemCount:3];
Alternately, another of the class's constructor can be used to create a scope object using the encoded decision scope. The encoded scope can also be read directly from the decision on the Experience Platform UI.
Android
iOS (AEP 3.x)
Java
final DecisionScope decisionScope = DecisionScope("eyJ4ZG06YWN0aXZpdHlJZCI6Inhjb3JlOm9mZmVyLWFjdGl2aXR5OjEyYmEyZjM4MWJjYTY3NWUiLCJ4ZG06cGxhY2VtZW50SWQiOiJ4Y29yZTpvZmZlci1wbGFjZW1lbnQ6MTJiOWEwMDA1NTUwNzM1NyIsICJ4ZG06aXRlbUNvdW50IjozfQ==");
Swift
let decisionScope = DecisionScope(name: "eyJ4ZG06YWN0aXZpdHlJZCI6Inhjb3JlOm9mZmVyLWFjdGl2aXR5OjEyYmEyZjM4MWJjYTY3NWUiLCJ4ZG06cGxhY2VtZW50SWQiOiJ4Y29yZTpvZmZlci1wbGFjZW1lbnQ6MTJiOWEwMDA1NTUwNzM1NyIsICJ4ZG06aXRlbUNvdW50IjozfQ==")
Objective-C
AEPDecisionScope* decisionScope = [[AEPDecisionScope alloc] initWithName:@"eyJ4ZG06YWN0aXZpdHlJZCI6Inhjb3JlOm9mZmVyLWFjdGl2aXR5OjEyYmEyZjM4MWJjYTY3NWUiLCJ4ZG06cGxhY2VtZW50SWQiOiJ4Y29yZTpvZmZlci1wbGFjZW1lbnQ6MTJiOWEwMDA1NTUwNzM1NyIsICJ4ZG06aXRlbUNvdW50IjozfQ=="];
The
DecisionScope public class provides a designated initializer which can be used to create a Target location (or mbox).Android
iOS (AEP 3.x)
Java
final DecisionScope decisionScope = DecisionScope("myTargetLocation");
Swift
let decisionScope = DecisionScope(name: "myTargetLocation")
Objective-C
AEPDecisionScope* decisionScope = [[AEPDecisionScope alloc] initWithName:@"myTargetLocation"];
Target Parameters can be sent in a personalization query request to the Experience Edge network by adding them in
data dictionary when calling the updatePropositions API.Android
iOS (AEP 3.x)
Java
final Map<String, Object> data = new HashMap<>();
final Map<String, String> targetParameters = new HashMap<>();
// Add mbox parameters
targetParameters.put("someKey", "someValue");
// Add profile parameters - prefix with profile.
targetParameters.put("profile.membershipLevel", "platinum");
// Add product parameters
targetParameters.put("productId", "111");
targetParameters.put("categoryId", "Books");
// Add order parameters
targetParameters.put("orderId", "10");
targetParameters.put("orderTotal", "110.56");
targetParameters.put("purchasedProductIds", "111");
data.put("__adobe", new HashMap<String, Object>() {
{
put("target", targetParameters);
}
});
final DecisionScope decisionScope = DecisionScope("myTargetLocation") // Target location (or mbox)
final List<DecisionScope> decisionScopes = new ArrayList<>();
decisionScopes.add(decisionScope);
Optimize.updatePropositions(decisionScopes, null, data);
Swift
var data: [String: Any] = [:]
var targetParameters: [String: String] = [:]
// Add mbox parameters
targetParameters["someKey"] = "someValue"
// Add profile parameters - prefix with profile.
targetParameters["profile.membershipLevel"] = "platinum"
// Add product parameters
targetParameters["productId"] = "111"
targetParameters["categoryId"] = "Books"
// Add order parameters
targetParameters["orderId"] = "10"
targetParameters["orderTotal"] = "110.56"
targetParameters["purchasedProductIds"] = "111"
data["__adobe"] = [
"target": targetParameters
]
let decisionScope = DecisionScope(name: "myTargetLocation") // Target location (or mbox)
Optimize.updatePropositions(for: [decisionScope] withXdm: nil andData: data)
Objective-C
NSMutableDictionary* data = [NSMutableDictionary dictionary];
NSMutableDictionary* targetParameters = [NSMutableDictionary dictionary];
// Add mbox parameters
targetParameters[@"someKey"] = @"someValue";
// Add profile parameters - prefix with profile.
targetParameters[@"profile.membershipLevel"] = @"platinum";
// Add product parameters
targetParameters[@"productId"] = @"111";
targetParameters[@"categoryId"] = @"Books";
// Add order parameters
targetParameters[@"orderId"] = @"10";
targetParameters[@"orderTotal"] = @"110.56";
targetParameters[@"purchasedProductIds"] = @"111";
[data setObject:[NSDictionary dictionaryWithObject:targetParameters forKey:@"target"] forKey:@"__adobe"];
AEPDecisionScope* decisionScope = [[AEPDecisionScope alloc] initWithName:@"myTargetLocation"]; // Target location (or mbox)
[AEPMobileOptimize updatePropositions:@[decisionScope] withXdm:nil andData:data];
To use Target Third Party ID in the Experience Edge mobile workflows, the corresponding namespace needs to be configured in Experience Platform Data Collection.
- 1.On Experience Platform Data Collection, navigate to Data Collection > Datatreams using the left navigation panel.
- 2.Select your configured datastream and click on the desired environment from the list.
- 3.Navigate to Adobe Target section, specify the Target Third Party ID Namespace.
- 4.Click Save.
Target Third Party ID configuration
In your mobile application, integrate the Identity for Edge Network extension to add the Target Third Party ID in the Identity Map in the personalization query request to the Edge network when calling the
updatePropositions API. For more details, see the Identity for Edge Network - updateIdentities API.Android
iOS (AEP 3.x)
Java
final IdentityItem item = new IdentityItem("1111", AuthenticatedState.AUTHENTICATED, true);
final IdentityMap identityMap = new IdentityMap();
identityMap.addItem(item, "userCRMID") // userCRMID being used as Third Party ID
Identity.updateIdentities(identityMap);
Swift
let identityMap = IdentityMap()
identityMap.add(item: IdentityItem(id: "1111", authenticatedState: AuthenticatedState.authenticated, primary: true),
withNamespace: "userCRMID") // userCRMID being used as Third Party ID
Identity.updateIdentities(with: identityMap)
Objective-C
AEPIdentityItem *item = [[AEPIdentityItem alloc] initWithId:@"1111" authenticatedState:AEPAuthenticatedStateAuthenticated primary:true];
AEPIdentityMap *identityMap = [[AEPIdentityMap alloc] init];
[identityMap addItem:item withNamespace:@"userCRMID"]; // userCRMID being used as Third Party ID
[AEPMobileEdgeIdentity updateIdentities:identityMap];
To send mobile Lifecycle metrics to Target for creating audiences, a rule needs to be set up on Experience Platform Data Collection to attach these metrics to the Edge personalization query requests. Follow the link to learn how to target visitors using Custom Parameters in Adobe Target.
On Experience Platform Data Collection, navigate to Data Collection > Tags using the left navigation panel. Select an existing mobile tag property or create a new property.
- 1.In your mobile property, navigate to Rules in the left navigation panel and click on Create New Rule. If there already are existing rules, you can click on Add Rule to add a new rule.
- 2.Provide a name for your rule. In the example here, the rule is named "Attach Mobile Lifecycle Metrics to Personalization Query Requests".
- 1.Under the Events section, click on Add.
- 2.From the Extension dropdown list, select Adobe Experience Platform Edge Network.
- 3.From the Event Type dropdown list, select AEP Request Event.
- 4.On the right pane, click on + to specify XDM Event Type equals personalization.request.
- 5.Click on Keep Changes.
Adobe Journey Optimizer - Decisioning extension Lifecycle rule Event Configuration
- 1.Under the Actions section, click on Add.
- 2.From the Extension dropdown list, select Mobile Core.
- 3.From the Action Type dropdown list, select Attach Data.
- 4.On the right pane, specify the JSON Payload containing metrics of interest. An example JSON Payload containing all of the mobile Lifecycle metrics is shown below.
- 5.Click on Keep Changes.
Adobe Journey Optimizer - Decisioning extension Lifecycle rule Action Configuration
{
"data": {
"__adobe": {
"target": {
"a.appID": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.appid%}",
"a.locale": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.locale%}",
"a.RunMode": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.runmode%}",
"a.Launches": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.launches%}",
"a.DayOfWeek": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.dayofweek%}",
"a.HourOfDay": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.hourofday%}",
"a.OSVersion": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.osversion%}",
"a.CrashEvent": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.crashevent%}",
"a.DeviceName": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.devicename%}",
"a.Resolution": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.resolution%}",
"a.CarrierName": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.carriername%}",
"a.InstallDate": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.installdate%}",
"a.LaunchEvent": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.launchevent%}",
"a.InstallEvent": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.installevent%}",
"a.UpgradeEvent": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.upgradeevent%}",
"a.DaysSinceLastUse": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.dayssincelastuse%}",
"a.DailyEngUserEvent": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.dailyenguserevent%}",
"a.DaysSinceFirstUse": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.dayssincefirstuse%}",
"a.PrevSessionLength": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.prevsessionlength%}",
"a.MonthlyEngUserEvent": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.monthlyenguserevent%}",
"a.DaysSinceLastUpgrade": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.dayssincelastupgrade%}",
"a.LaunchesSinceUpgrade": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.launchessinceupgrade%}",
"a.ignoredSessionLength": "{%~state.com.adobe.module.lifecycle/lifecyclecontextdata.ignoredsessionlength%}
"
}
}
}
}
After you finish your rule configuration, verify the rule details are as shown below:
Adobe Journey Optimizer - Decisioning extension Lifecycle rule Configuration
- 1.Click on Save.
- 2.
Set up the Analytics for Target (A4T) cross-solution integration by enabling the A4T campaigns to use Analytics as the reporting source for an activity. Subsequently, all reporting and segmentation for that activity is based on Analytics data collection. For more information, see Adobe Analytics for Adobe Target (A4T).
Once Analytics is listed as the reporting source for an activity on Target UI, A4T works out of the box in the Optimize SDK. The Experience Edge handles forwarding any Target A4T payloads to Adobe Analytics and no additional action is required on the client-side.
For this integration to work, make sure Analytics is enabled in your datastream configuration for the desired environment and Report Suite information is provided.
User interactions with the decision propositions can be tracked using the following public methods in the
Offer class.Android
iOS (AEP 3.x)
Java
public class Offer {
...
/**
* Dispatches an event for the Edge network extension to send an Experience Event to the Edge network with the display interaction data for the
* given {@code Proposition} offer.
*/
public void displayed() {...}
/**
* Dispatches an event for the Edge network extension to send an Experience Event to the Edge network with the tap interaction data for the
* given {@code Proposition} offer.
*/
public void tapped() {...}
}
Swift
public extension Offer {
/// Dispatches an event for the Edge extension to send an Experience Event to the Edge network with the display interaction data for the given proposition item.
func displayed() {...}
/// Dispatches an event for the Edge extension to send an Experience Event to the Edge network with the tap interaction data for the given proposition item.
func tapped() {...}
}
Upon calling these
Offer methods, an Experience Event is sent to the Edge network with the proposition interaction data for the given offer.Android
iOS (AEP 3.x)
Java
offer.displayed(); // Sends an Offer display notification to Edge network
Swift
offer.displayed() // Sends an Offer display notification to Edge network
Objective-C
[offer displayed]; // Sends an Offer display notification to Edge network
For more advanced tracking use cases, additional public methods are available in the
Offer and Proposition classes. These methods can be used to generate XDM formatted data for Experience Event - Proposition Interactions and Experience Event - Proposition Reference field groups.Android
iOS (AEP 3.x)
Java
public class Offer {
...
/**
* Generates a map containing XDM formatted data for {@code Experience Event - Proposition Interactions} field group from this {@code Proposition} item.
*
* The returned XDM data does contain the {@code eventType} for the Experience Event with value {@code decisioning.propositionDisplay}.
*
* Note: The Edge sendEvent API can be used to dispatch this data in an Experience Event along with any additional XDM, free-form data, and override
* dataset identifier.
*
* @return {@code Map<String, Object>} containing the XDM data for the proposition interaction.
*/
public Map<String, Object> generateDisplayInteractionXdm() {...}
/**
* Generates a map containing XDM formatted data for {@code Experience Event - Proposition Interactions} field group from this {@code Proposition} offer.
*
* The returned XDM data contains the {@code eventType} for the Experience Event with value {@code decisioning.propositionInteract}.
*
* Note: The Edge sendEvent API can be used to dispatch this data in an Experience Event along with any additional XDM, free-form data, and override
* dataset identifier.
*
* @return {@code Map<String, Object>} containing the XDM data for the proposition interaction.
*/
public Map<String, Object> generateTapInteractionXdm() {...}
}
public class Proposition {
...
/**
* Generates a map containing XDM formatted data for {@code Experience Event - Proposition Reference} field group from this {@code Proposition}.
*
* The returned XDM data does not contain {@code eventType} for the Experience Event.
*
* @return {@code Map<String, Object>} containing the XDM data for the proposition reference.
*/
public Map<String, Object> generateReferenceXdm() {...}
}
Swift
public extension Offer {
/// Creates a dictionary containing XDM formatted data for `Experience Event - Proposition Interactions` field group from the given proposition option.
///
/// The Edge `sendEvent(experienceEvent:_:)` API can be used to dispatch this data in an Experience Event along with any additional XDM, free-form data, or override dataset identifier.
///
/// - Note: The returned XDM data also contains the `eventType` for the Experience Event with value `decisioning.propositionDisplay`.
/// - Returns A dictionary containing XDM data for the propositon interactions.
func generateDisplayInteractionXdm() -> [String: Any] {...}
/// Creates a dictionary containing XDM formatted data for `Experience Event - Proposition Interactions` field group from the given proposition option.
///
/// The Edge `sendEvent(experienceEvent:_:)` API can be used to dispatch this data in an Experience Event along with any additional XDM, free-form data, or override dataset identifier.
///
/// - Note: The returned XDM data also contains the `eventType` for the Experience Event with value `decisioning.propositionInteract`.
/// - Returns A dictionary containing XDM data for the propositon interactions.
func generateTapInteractionXdm() -> [String: Any] {...}
}
public extension Proposition {
/// Creates a dictionary containing XDM formatted data for `Experience Event - Proposition Reference` field group from the given proposition.
///
/// The Edge `sendEvent(experienceEvent:_:)` API can be used to dispatch this data in an Experience Event along with any additional XDM, free-form data, or override dataset identifier.
///
/// - Note: The returned XDM data does not contain an `eventType` for the Experience Event.
/// - Returns A dictionary containing XDM data for the propositon reference.
func generateReferenceXdm() -> [String: Any] {...}
}
The Edge
sendEvent API can then be used to send this tracking XDM data along with any additional XDM and freeform data to the Experience Edge network. Additionally, an override dataset can also be specified for tracking data. For more details, see Edge - sendEvent API.Android
iOS (AEP 3.x)
Java
// When a proposition is retrieved using getPropositions API or onUpdatePropositions API callback
// and the corresponding offer is displayed, invoke method on Offer object to get the XDM data.
final Map<String, Object> displayInteractionXdm = offer.generateDisplayInteractionXdm() // Offer display tracking XDM
final Map<String, Object> additionalData = new HashMap<>();
additionalData.put("someDataKey", "someDataValue");
final ExperienceEvent experienceEvent = new ExperienceEvent.Builder().setXdmSchema(displayInteractionXdm).setData(additionalData).build();
Edge.sendEvent(experienceEvent, null)
Swift
// When a proposition is retrieved using getPropositions API or onUpdatePropositions API callback
// and the corresponding offer is displayed, invoke method on Offer object to get the XDM data.
let displayInteractionXdm = offer.generateDisplayInteractionXdm() // Offer display tracking XDM
let additionalData: [String: Any] = ["someDataKey": "someDataValue"]
let experienceEvent = ExperienceEvent(xdm: displayInteractionXdm, data: additionalData)
Edge.sendEvent(experienceEvent)
Objective-C
// When a proposition is retrieved using getPropositions API or onUpdatePropositions API callback
// and the corresponding offer is displayed, invoke method on Offer object to get the XDM data.
NSDictionary* displayInteractionXdm = [offer generateDisplayInteractionXdm];
NSDictionary* additionalData = @{@"someDataKey": @"someDataValue"};
AEPExperienceEvent* experienceEvent = [[AEPExperienceEvent alloc] initWithXdm:displayInteractionXdm data:additionalData datasetIdentifier:nil];
[AEPMobileEdge sendExperienceEvent:event completion:nil];
To update the SDK configuration programmatically, use the following information to change the Optimize extension configuration values. For more information, see the programmatic updates to Configuration guide.
Key | Required | Description | Data Type |
|---|---|---|---|
optimize.datasetId | No | Override dataset's Identifier which can be obtained from the Experience Platform UI. For more details see, Datasets UI guide | String |
If the override dataset is used for proposition tracking, make sure the corresponding schema definition contains the
Experience Event - Proposition Interaction field group. For more information, see the setup schemas and datasets guide.Last modified 4mo ago