Use these mapping recommendations for Mobile SDK Engagement Events. The three interaction subclasses are Catalog, Order, and Cart.
DMO Setup
Before starting Mobile SDK Engagement Event mapping, create custom attributes for these data model objects (DMOs).
| DMO | Custom Attribute | Data Type |
|---|---|---|
| Shopping Cart Product Engagement | Shopping Cart Product DateTime | dateTime |
| Sales Order Product Engagement | Sales Order Product Engagement DateTime | dateTime |
| Sales Order Product Engagement | Catalog Object Type | text |
| Sales Order Product Engagement | currency | text |
| Engagement | Source Page Type | text |
| Product Browse Engagement | Source Page Type | text |
| Product Order Engagement | Source Page Type | text |
Catalog
A catalog event has an interactionName that can include any of these values.
- ViewCatalogObject
- ViewCatalogObjectDetail
- QuickViewCatalogObject
- ShareCatalogObject
- ReviewCatalogObject
- CommentCatalogObject
- FavoriteCatalogObject
| DLO Field | Data Type | Required | DMO Object | DMO Field |
|---|---|---|---|---|
| eventId | text | Yes | Engagement | Engagement Id |
| dateTime | dateTime | Yes | Engagement | Engagement DateTime |
| eventType | text | Yes | ||
| sessionId | text | Yes | ||
| deviceId (CookieId) | text | Yes | Engagement | Individual |
| category | text | Yes | ||
| interactionName | text | Yes | Product Browse Engagement | Engagement Type |
| pageView | text | No | ||
| sourceChannel | text | No | Product Browse Engagement | Engagement Channel Type |
| sourceLocale | text | No | Product Browse Engagement | Device Locale |
| sourcePageType | text | No | Product Browse Engagement | Source Page Type |
| sourceUrl | text | No | Product Browse Engagement | Product View URL |
| sourceUrlReferrer | text | No | Product Browse Engagement | Referrer URL |
| type | text | Yes | Product Browse Engagement | Product Category |
| id | text | Yes | Product Browse Engagement | Product |
Order
An order event has an interactionName that can include any of these values.
- Purchase
- Preorder
- Cancel
- Ship
- Deliver
- Return
| DLO Field | Data Type | Required | DMO Object | DMO Field |
|---|---|---|---|---|
| eventId | text | Yes | Engagement | Engagement Id |
| dateTime | dateTime | Yes | Engagement | Engagement DateTime |
| eventType | text | Yes | ||
| sessionId | text | Yes | ||
| deviceId (CookieId) | text | Yes | Engagement | Individual |
| category | text | Yes | ||
| interactionName | text | Yes | Product Order Engagement | Product Order Event Type |
| pageView | text | No | ||
| sourceChannel | text | No | Engagement | Engagement Channel Type |
| sourceLocale | text | No | Engagement | Device Locale |
| sourcePageType | text | No | Source Page Type | Create custom attribute |
| sourceUrl | text | No | Engagement | Link URL |
| sourceUrlReferrer | text | No | Engagement | Referrer URL |
| orderId | text | Yes | Product Order Engagement | External Record Id |
| orderTotalValue | number | No | Product Order Engagement | Net Order Amount |
| orderCurrency | text | No | Product Order Engagement | Currency |
Order Item
| DLO Field | Data Type | Required | DMO Object | DMO Field |
|---|---|---|---|---|
| eventId | text | Yes | ||
| dateTime | dateTime | Yes | Sales Order Product Engagement | Sales Order Product Engagement DateTime |
| eventType | text | Yes | ||
| sessionId | text | Yes | ||
| deviceId | text | Yes | ||
| category | text | Yes | ||
| catalogObjectType | text | Yes | Sales Order Product Engagement | Catalog Object Type |
| catalogObjectId | text | Yes | Sales Order Product Engagement | Product |
| quantity | number | No | Sales Order Product Engagement | Ordered Quantity |
| price | number | No | Sales Order Product Engagement | Total Line Amount |
| currency | text | No | Sales Order Product Engagement | Currency |
| orderEventId | text | Yes | Sales Order Product Engagement | Product Order Engagement |
Cart
A cart event has an interactionName that can include any of these values.
- AddToCart
- RemoveFromCart
- ReplaceCart
| DLO Field | Data Type | Required | DMO Object | DMO Field |
|---|---|---|---|---|
| eventId | text | Yes | Engagement | Engagement Id |
| dateTime | dateTime | Yes | Engagement | Engagement DateTime |
| eventType | text | Yes | ||
| sessionId | text | Yes | ||
| deviceId | text | Yes | Shopping Cart Engagement | Individual |
| category | text | Yes | ||
| interactionName | text | Yes | Shopping Cart Engagement | Shopping Cart Event Type |
| pageView | text | No | ||
| sourceChannel | text | No | Engagement | Engagement Channel Type |
| sourceLocale | text | No | Engagement | Device Locale |
| sourcePageType | text | No | Engagement | Source Page Type |
| sourceUrl | text | No | Engagement | Link URL |
| sourceUrlReferrer | text | No | Referrer URL |
Cart Item
A cart item event is extracted from a parent cart event and represents the items contained in a user’s shopping cart.
| DLO Field | Data Type | Required | DMO Object | DMO Field |
|---|---|---|---|---|
| eventId | text | Yes | ||
| dateTime | dateTime | Yes | Shopping Cart Product Engagement | Shopping Cart Product DateTime |
| eventType | text | Yes | ||
| sessionId | text | Yes | ||
| deviceId | text | Yes | ||
| category | text | Yes | ||
| catalogObjectType | text | Yes | Shopping Cart Product Engagement | Product Category |
| catalogObjectId | text | Yes | Shopping Cart Product Engagement | Product |
| quantity | number | No | Shopping Cart Product Engagement | Product Quantity |
| price | number | No | Shopping Cart Product Engagement | Product Price |
| currency | text | No | Shopping Cart Product Engagement | Currency |
| cartEventId | text | Yes | Shopping Cart Product Engagement | Shopping Cart Engagement |
DMO Mapping of a Data Stream
| DLO | DMO |
|---|---|
| Identity | Individual |
| Catalog Events | Product Browse Engagement |
| Cart Events | Shopping Cart Engagement |
| Cart Events Items | Shopping Cart Product Engagement |
| Order Events | Product Order Engagement |
| Order Event Items | Sales Order Product Engagement |
Data Model Relationships
After mapping the Mobile SDK for Engagement Events, set up data model relationships using these examples.
Shopping Cart Product Engagement
Sales Order Product Engagement
Shopping Cart Engagement
Product Browse Engagement
Product Order Engagement
