Send parameters to Target using the Offer Decisioning and Target extension
Target implementations differ across mobile applications due to app architecture, business requirements, and features used. Most Target implementations include passing various parameters for contextual information, audiences, and content recommendations.
With the Target extension, all Target paramters were passed using the TargetParameters
function.
With the Offer Decisioning and Target extension:
- Parameters intended for multiple Adobe applications can be passed in the XDM object
- Parameters intended only for Target can be passed in the
data.__adobe.target
object
Custom parameters
Custom mbox parameters are the most basic way to pass data to Target and can be be passed in the xdm
or data.__adobe.target
objects.
Profile parameters
Profile parameters store data for an extended period of time in the user’s Target profile and must be passed in the data.__adobe.target
object.
Entity parameters
Entity parameters are used to pass behavioral data and supplemental catalog information for Target Recommendations. Similar to profile parameters, most entity parameters should be passed under the data.__adobe.target
object. The only exception is the xdm.productListItems
array is present, then the first SKU
value is used as the entity.id
.
Entity parameters for a specific item must be prefixed with entity.
for proper data capture. The reserved cartIds
and excludedIds
parameters for recommendations algorithms should not be prefixed and the value for each must contain a comma-separated list of entity IDs.
Purchase parameters
Purchase parameters are passed on an order confirmation page after a successful order and are used for Target conversion and optimization goals. With a Platform Mobile SDK implementation using the Offer Decisioning and Target extension, these parameters and are automatically mapped from XDM data passed as part of the commerce
field group.
Purchase information is passed to Target when the commerce
field group has purchases.value
set to 1
. The order ID and order total are automatically mapped from the order
object. If the productListItems
array is present, then the SKU
values are use for productPurchasedId
.
If you are not passing commerce
fields in the xdm
object, you can pass the order details to target using the data.__adobe.target.orderId
, data.__adobe.target.orderTotal
, and data.__adobe.target.productPurchasedId
fields.
Customer Id (mbox3rdPartyId)
Target allows profile synching across devices and systems using a single customer id. This customer id should be passed in the identityMap
field of the XDM object and mapped to the Target Third Party Id field in the datastream.
Table
at_property
sendEvent
call.pageName
xdm.web.webPageDetails.name
ordata.__adobe.target.pageName
xdm
object or part of the data.__adobe.target
object.profile.gender
data.__adobe.target.profile.gender
data
object and prefixed with profile.
to be mapped appropriately.user.categoryId
data.__adobe.target.user.categoryId
data
object.entity.id
data.__adobe.target.entity.id
OR
xdm.productListItems[0].SKU
data
object or automatically mapped from the first item in the xdm.productListItems
array if your implementation uses that field group.entity.categoryId
data.__adobe.target.entity.categoryId
data
object.entity.customEntity
data.__adobe.target.entity.customEntity
data
object.cartIds
data.__adobe.target.cartIds
excludedIds
data.__adobe.target.excludedIds
mbox3rdPartyId
xdm.identityMap
objectorderId
xdm.commerce.order.purchaseID
(when
commerce.purchases.value
is set to 1
)or
data.__adobe.target.orderId
orderTotal
xdm.commerce.order.priceTotal
(when
commerce.purchases.value
is set to 1
)or
data.__adobe.target.orderTotal
productPurchasedId
xdm.productListItems[0-n].SKU
(when
commerce.purchases.value
is set to 1
)OR
data.__adobe.target.productPurchasedId
Examples of passing parameters
Let’s use a simple example to demonstrate the differences between the extensions when passing parameters to Target.
Android
code language-java |
---|
|
code language-java |
---|
|
iOS
code language-swift |
---|
|
code language-swift |
---|
|
Next, learn how to track Target conversion events with the Platform Web SDK.