Custom Personalization Connection custom-personalization-connection
Destination changelog changelog
Use this changelog to track updates to the Custom Personalization destination.
Overview overview
Set up this destination to allow external personalization platforms, content management systems, ad servers, and other applications running on customer websites to retrieve audience information from Adobe Experience Platform.
Prerequisites prerequisites
This destination requires one of the following data collection methods, depending on your implementation:
- Use the Adobe Experience Platform Web SDK to collect data from your website.
- Use the Adobe Experience Platform Mobile SDK to collect data from your mobile application.
- Use the Edge Network API if you are not using the Web SDK or Mobile SDK, or if you want to personalize the user experience based on profile attributes.
Supported audiences supported-audiences
The following table lists the audience types you can export to this destination.
This category includes all audience origins outside of audiences generated through the Segmentation Service. Read about the various audience origins. Some examples include:
- custom upload audiences imported into Experience Platform from CSV files,
- look-alike audiences,
- federated audiences,
- audiences generated in other Experience Platform apps such as Adobe Journey Optimizer,
- and more.
Supported audiences by audience data type:
Export type and frequency export-type-frequency
The following table describes the export type and frequency for this destination.
Connect to the destination connect
To connect to this destination, follow the steps described in the destination configuration tutorial.
Connection parameters parameters
While setting up this destination, you must provide the following information:
- Name: Fill in the preferred name for this destination.
- Description: Enter a description for your destination. For example, you can mention which campaign you are using this destination for. This field is optional.
- Integration alias: A required string that identifies this destination in the personalization response. The alias value is returned to your website or app together with the audiences (and, if configured, attributes) associated with this destination. Use the alias in your client-side or server-side code to locate and process the correct personalization object when multiple personalization destinations are active on the same datastream. The alias must be unique within a sandbox across all Custom Personalization destinations.
- Datastream: This determines in which Data Collection datastream the audiences will be included in the response to the page. The drop-down menu shows only datastreams that have the destination configuration enabled. See Configuring a datastream for more details.
Enable alerts enable-alerts
Enable alerts to receive notifications on the status of your dataflow to this destination. Select an alert from the list to subscribe to receive notifications on the status of your dataflow. For more information on alerts, see the guide on subscribing to destinations alerts using the UI.
When you are finished providing details for your destination connection, select Next.
Activate audiences to this destination activate
Read Activate profiles and audiences to edge personalization destinations for instructions on activating audiences to this destination.
Exported data exported-data
If you are using Tags in Adobe Experience Platform to deploy the Experience Platform Web SDK, use the send event complete functionality. Your custom code action will have an event.destinations variable that you can use to see the exported data.
Here is a sample value for the event.destinations variable:
[
{
"type":"profileLookup",
"destinationId":"7bb4cb8d-8c2e-4450-871d-b7824f547111",
"alias":"personalizationAlias",
"segments":[
{
"id":"399eb3e7-3d50-47d3-ad30-a5ad99e8ab77"
},
{
"id":"499eb3e7-3d50-47d3-ad30-a5ad99e8ab77"
}
]
}
]
If you are not using Tags to deploy the Experience Platform Web SDK, use command responses to see the exported data.
Parse the JSON response from Adobe Experience Platform to find the integration alias of the application you are integrating with Adobe Experience Platform. Pass the audience IDs into the application’s code as targeting parameters. Below is a sample of what this looks like specific to the destination response.
alloy("sendEvent", {
"renderDecisions": true,
"xdm": {
"commerce": {
"order": {
"purchaseID": "a8g784hjq1mnp3",
"purchaseOrderNumber": "VAU3123",
"currencyCode": "USD",
"priceTotal": 999.98
}
}
}
}).then(function(result) {
if(result.destinations) { // Looking to see if the destination results are there
// Get the destination with a particular alias
var personalizationDestinations = result.destinations.filter(x => x.alias == "personalizationAlias")
if(personalizationDestinations.length > 0) {
// Code to pass the audience IDs into the system that corresponds to personalizationAlias
}
var adServerDestinations = result.destinations.filter(x => x.alias == "adServerAlias")
if(adServerDestinations.length > 0) {
// Code to pass the audience IDs into the system that corresponds to adServerAlias
}
}
})
.catch(function(error) {
// Tracking the event failed.
});
Example response for Custom Personalization With Attributes example-response-attributes
When using Custom Personalization With Attributes, the API response will look similar to the example below.
The difference between Custom Personalization With Attributes and Custom Personalization is the inclusion of the attributes section in the API response.
[
{
"type": "profileLookup",
"destinationId": "7bb4cb8d-8c2e-4450-871d-b7824f547130",
"alias": "personalizationAlias",
"attributes": {
"countryCode": {
"value" : "DE"
},
"membershipStatus": {
"value" : "PREMIUM"
}
},
"segments": [
{
"id": "399eb3e7-3d50-47d3-ad30-a5ad99e8ab77"
},
{
"id": "499eb3e7-3d50-47d3-ad30-a5ad99e8ab77"
}
]
}
]
Data usage and governance data-usage-governance
All Adobe Experience Platform destinations are compliant with data usage policies when handling your data. For detailed information on how Adobe Experience Platform enforces data governance, read the Data Governance overview.