Custom personalization connection

Overview

This destination provides a way to retrieve segment information from Adobe Experience Platform to external personalization platforms, content management systems, ad servers, and other applications that are running on customer websites.

Prerequisites

This integration is powered by the Adobe Experience Platform Web SDK or the Adobe Experience Platform Mobile SDK. You must be using one of these SDKs to use this destination.

IMPORTANT

Before creating a custom personalization connection, read the guide on how to configure personalization destinations for same-page and next-page personalization. This guide takes you through the required configuration steps for same-page and next-page personalization use cases, across multiple Experience Platform components.

Export type and frequency

Profile request - you are requesting all the segments that are mapped in the custom personalization destination for a single profile. Different custom personalization destinations can be set up for different Adobe Data Collection datastreams.

Use cases

The Custom personalization connection enables you to use your own personalization partner platforms (for example, Optimizely, Pega), while also leveraging Experience Platform Edge Network data collection & segmentation capabilities, to power a deeper customer personalization experience.

The use cases described below include both site personalization and targeted on-site advertising.

To enable these use cases, customers need a quick, streamlined way of retrieving segment information from Experience Platform and sending this information to their designated systems that they configured as custom personalization connections in the Experience Platform UI.

These systems can be external personalization platforms, content management systems, ad servers, and other applications running across customers’ web and mobile properties.

Same-page personalization

A user visits a page of your website. The customer can use the current page visit information (for example, referring URL, browser language, embedded product info) to select the next action / decision (for example, personalization), using the custom personalization connection for non-Adobe platforms (for example, Pega, Optimizely, etc.).

Next-page personalization

A user visits Page A on your website. Based on this interaction, the user has qualified for a set of segments. The user then clicks on a link that takes them from Page A to Page B. The segments that the user had qualified for during the previous interaction on Page A, together with the profile updates determined by the current website visit, will be used to power the next action / decision (for example, which advertising banner to display to the visitor, or, in case of A/B testing, which version of the page to display).

Next-session personalization

A user visits several pages on your website. Based on these interactions, the user has qualified for a set of segments. The user then terminates the current browsing session.

The following day, the user returns to the same customer website. The segments they had qualified for during the previous interaction with all the visited website pages, together with the profile updates determined by the current website visit, will be used to select the next action / decision (for example, which advertising banner to display to the visitor, or, in case of A/B testing, which version of the page to display).

Connect to the destination

To connect to this destination, follow the steps described in the destination configuration tutorial.

Connection 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: This value is sent to the Experience Platform Web SDK as a JSON object name.
  • Datastream ID: This determines in which Data Collection datastream the segments 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.

Activate segments to this destination

IMPORTANT

To activate data, you need the Manage Destinations, Activate Destinations, View Profiles, and View Segments access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.

Read Activate profiles and segments to profile request destinations for instructions on activating audience segments to this destination.

Exported data

If you are using Tags in Adobe Experience Platform to deploy the Experience Platform Web SDK, use the send event complete functionality and 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 the handling responses from events functionality to see the exported data.

The JSON response from Adobe Experience Platform can be parsed to find the corresponding integration alias of the application you are integrating with Adobe Experience Platform. The segment IDs can be passed into the application’s code as targeting parameters. Below is a sample of what this would look 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 segment 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 segment ids into the system that corresponds to adServerAlias
        }
     }
   })
  .catch(function(error) {
    // Tracking the event failed.
  });

Data usage and 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.

On this page