What Is Adobe Experience Platform - Interact?

Adobe Experience Platform - Interact integrates with the Adobe Experience Platform, utilizing the Interactive Data Collection API. This integration allows businesses to send server-side event data directly to Adobe. To access this endpoint and leverage the integration, the Adobe Experience Platform is required, as it serves as the foundation for connecting and managing data flows between different Adobe solutions. This integration may be used to send data to Adobe Analytics.

Adobe Analytics is a robust web analytics platform that provides insights into user behavior across digital channels. It allows businesses to track and analyze vast amounts of data, offering deep insights into customer journeys, conversions, and overall digital performance. With features like real-time data, customizable reports, and integration with other Adobe products, it helps organizations make data-driven decisions to optimize their digital marketing strategies. Adobe Analytics is particularly known for its powerful segmentation and audience targeting capabilities.

Capabilities and Considerations

May be used to send data to Adobe Analytics.
You must have access to Adobe Experience Platform for this integration.
Your Experience Platform account must have the developer and user roles enabled for the Adobe Experience Platform API product profile. Contact your Admin Console administrator to enable these roles for your account.
The standard integration is designed to collect standard page events, with additional events and parameters requiring mapping according to Adobe Analytics standards.
- Please refer to this guide for more information on mapping: Experience Data Model Guide.
Utilizes programmatic authentication refresh to automatically generate a new access token every 24 hours.
Leverages Adobe Experience Platform’s Interactive Data API for server-side collection and transmission of event data directly into Adobe Analytics.
Supports customized event data collection, allowing you to define and gather specific metrics and dimensions tailored to your business needs.
Enables batch processing of large volumes of event data.
Allows for near real-time data ingestion into Adobe Analytics, ensuring timely analysis and reporting.

Limitations

Real-time personalization: The Interactive Data API used in this integration does not support real-time client-side data collection necessary for immediate content personalization on webpages.
Dynamic variables and data points: Certain client-side interactions, such as real-time form inputs or browser-specific behaviors, may not be captured by the integration.
Advanced audience segmentation: Segmentation based on real-time client-side triggers, like user actions during a session, may not be fully supported by the integration.
Plug-ins and JavaScript customizations: Custom JavaScript code and browser-executed plug-ins are not supported by the Interactive Data API used in the integration and must remain client-side.
Timezone Reporting - There is a current bug within Adobe Analytics that will not allow the integration to populate timezone reporting.

Getting Started - From Your Adobe Account

Create Project

Navigate to the Adobe Developer Console and select the "Projects" tab.
Click the "Create new project" button.
Choose "Add API."
Select "Experience Platform API" and click "Next."
Check the "OAuth Server-to-Server" option and name your credentials.
Select product profiles. It is recommended to check all profiles. Then, click "Save configured API."
On the project details page, click on "OAuth Server-to-Server" and gather the following credentials:
- Org ID
- Client ID — This will be mapped to API_KEY in the connection file of the integration in MetaRouter.
- Client Secret

Datastream ID

Go to the Adobe Experience home page.
Click on "Experience Platform."
In the left-hand navigation, select "Datastreams."
Create a new datastream or retrieve the ID from an existing one. This ID will be needed in the connection file of the integration in MetaRouter.
Click on the name of your datastream.
Select "Add Service."
Choose "Adobe Analytics" from the drop-down menu.
Add your Report Suite ID from Adobe Analytics to connect the datastream to the report suite.
- To find your Report Suite ID, navigate to Adobe Analytics > Admin > All Admin > Report Suites, where you will find a column identifying your Report Suite ID.
For more details on configuring datastreams, refer to the guide: Create and configure datastreams.

Getting Started - From Your MetaRouter Account

Adding an Adobe Experience Platform - Interact integration.

From the integration library, add an Adobe Experience Platform - Interact integration. Then, fill out the Connection Parameters:

Connection Parameter	Description
`DATASTREAM_ID`	A unique identifier for a specific data stream in AEP, linking incoming data to the correct data processing workflow.
`ORG_ID`	The unique identifier for your Adobe organization, used to manage and authenticate access to Adobe Experience Platform.
`API_KEY`	A unique key that identifies your application to AEP, allowing it to authenticate and interact with AEP APIs.
`CLIENT_SECRET`	A secure, private key used with the API key to authenticate server-to-server requests to AEP.

Event Mappings

MetaRouter provides suggested, standard event mappings for Adobe Analytics. You may add custom events, parameters or mappings in accordance with Adobe's API documentation.

NOTE: While not required, the mapping below may be required for specific reporting in Adobe Analytics. Removing parameters may impact your reporting in Adobe Analytics.

Global

Global mappings will be applied to all events. If your parameter names do not match the Expected Inputs provided, you will need to overwrite the Inputs provided with your own.

Output Key	Description	Expected Input
`event.xdm.identityMap.FPID` Required	String: FPID (First-Party ID) is a unique identifier assigned by Adobe Experience Platform to track users across devices within a first-party context.	Expression - The code hashes `input.anonymousId` with SHA-256, marks it as the primary ID, and returns it as a structured output.
`event.xdm.identityMap.Email_LC_SHA256` Recommended	String: SHA-256 hashed email.	Expression - If an email exists, the code returns a hashed, trimmed, lowercase version as a non-primary ID. If not, it returns nothing.
`event.xdm.timestamp` Highly Recommended	String: Timestamp of event. You must include this parameter to view date-related metrics in reporting.	`timestamp`
`event.xdm._id`	String: Unique message identifier for the event.	`messageID`
`event.xdm.environment.language`	String: Language setting of the environment (locale).	`context.locale`
`event.xdm.environment.browserDetails.acceptLanguage`	String: Browser's accepted language setting.	`context.locale`
`event.xdm.environment.browserDetails.userAgent`	String: User agent details of the browser.	`context.userAgent`
`event.xdm.environment.ipV4`	String: IPv4 address of the user’s environment.	`context.ip`
`event.xdm.marketing.trackingCode`	String: Tracking code for the associated marketing campaign.	`context.campaign.name`

Event Specific

Page

Output Key	Description	Expected Input
`event.xdm.eventType` Required	String: Specifies the event type, essential for categorizing and processing events in Adobe Analytics.	Enrichment - `web.webpagedetails.pageViews`
`event.xdm.web.webPageDetails.URL`	String: Captures the URL of the web page, recommended for accurate page tracking and reporting.	`context.page.url`
`event.xdm.web.webPageDetails.name`	String: Records the name of the web page, helpful for identification and reporting in Adobe Analytics.	`context.page.title`
`event.data.prop1`	String: Tracks the referrer URL, indicating the previous page visited before landing on the current page.	`context.page.referrer`
`event.xdm.web.webPageDetails.siteSection`	String: Represents the section of the website being viewed, useful for site structure analysis.	`properties.category`
`event.xdm.web.webReferrer.URL`	String: Captures the URL of the referring page, providing context on the traffic source.	`context.page.referrer`

Product Added

Output Key	Description	Expected Input
`event.xdm.eventType` Required	String: Specifies the event type for product additions, allowing for tracking additions to the product list.	Enrichment - `commerce.productListAdds`
`event.xdm.commerce.productListAdds.value`	Integer: Indicates the count of items added, set to 1 for single-item addition.	Enrichment - `1`
`event.xdm.commerce.cart.cartID`	String: Identifies the shopping cart associated with the addition.	`properties.cart_id`
`event.xdm.commerce.productListAdds.id`	String: Unique identifier for the product addition event.	`messageId`
`event.xdm.productListItems`	Object: Details of the added product, including SKU, name, price, quantity, and categories.	Enriched from input data

Order Completed Event

Output Key	Description	Expected Input
`event.xdm.eventType` Required	String: Specifies the event type for order completion, useful for tracking purchases in Adobe Analytics.	Enrichment - `commerce.purchases`
`event.xdm.commerce.purchases.value`	Integer: Represents the completion of a purchase, with a count of 1.	Enrichment - `1`
`event.xdm.commerce.order.payments.transactionID`	String: Identifier for the transaction associated with the purchase.	`properties.order_id`
`event.xdm.commerce.order.currencyCode`	String: Currency code for the order, allowing for consistent currency reporting.	`properties.currency`
`event.xdm.commerce.order.purchaseID`	String: Unique identifier for the purchase event.	`properties.order_id`
`event.xdm.commerce.purchases.id`	String: Unique identifier for the specific purchase instance.	`messageId`
`event.xdm.productListItems`	Object: Array of purchased products, including SKU, name, price, quantity, and categories.	Enriched from input data

Cart Viewed

Output Key	Description	Expected Input
`event.xdm.eventType` Required	String: Specifies the event type for viewing a shopping cart.	Enrichment - `commerce.productListViews`
`event.xdm.commerce.productListViews.value`	Integer: Represents the viewing of a product list, with a count of 1.	Enrichment - `1`
`event.xdm.commerce.cart.cartID`	String: Identifies the shopping cart that is being viewed.	`properties.cart_id`
`event.xdm.commerce.productListViews.id`	String: Unique identifier for the cart view event.	`messageId`
`event.xdm.productListItems`	Object: Details of the products in the cart, including SKU, name, price, quantity, and categories.	Enriched from input data

Product Removed

Output Key	Description	Expected Input
`event.xdm.eventType` Required	String: Specifies the event type for product removals, allowing for tracking products removed from the cart.	Enrichment - `commerce.productListRemovals`
`event.xdm.commerce.productListRemovals.value`	Integer: Indicates the count of items removed, set to 1 for single-item removal.	Enrichment - `1`
`event.xdm.commerce.cart.cartID`	String: Identifies the shopping cart associated with the removal.	`properties.cart_id`
`event.xdm.commerce.productListRemovals.id`	String: Unique identifier for the product removal event.	`messageId`
`event.xdm.productListItems`	Object: Details of the removed product, including SKU, name, price, quantity, and categories.	Enriched from input data

Product Viewed

Output Key	Description	Expected Input
`event.xdm.eventType` Required	String: Specifies the event type for product views, allowing for tracking views of specific products.	Enrichment - `commerce.productViews`
`event.xdm.commerce.productViews.value`	Integer: Represents the viewing of a product, with a count of 1.	Enrichment - `1`
`event.xdm.commerce.productViews.id`	String: Unique identifier for the product view event.	`messageId`
`event.xdm.productListItems`	Object: Details of the viewed product, including SKU, name, price, quantity, and categories.	Enriched from input data

Required & Recommended Identifiers

These identifiers must be mapped to Adobe Experience Platform in order for successful user matching to occur. Without these IDs, any events sent to Adobe Analytics may not be accurately reflected in reporting. For your convenience, required and recommended IDs are mapped as Global parameters to ensure they are added to every event.

Attribute	Example	Sync Injector Required?
`fpid` Required	3d174aa12d3b28a11bb3d48fb7120d6d582f8ff1d4eb1f1736b5c7e22c52ee67	No
`email` Recommended	6b1b36cbb04b41490bfc0ab2bfa26f86d4a2f1d6f09fb08e391ffbdb716d7011	No

Additional Adobe Experience Platform Documentation

XDM System Overview

Authentication

Interactive Data Collection API