rAI Website Personalization - Adobe Experience Platform(AEP) API Implementation Guide

Introduction

The Resonate Adobe Experience Platform (AEP) tag extension aims to make it easy for customers to integrate Resonate Attributes into their new or existing AEP workflows in order to provide first or second touch personalization to unknown website visitors. The Resonate tag extension acts as a wrapper around the Resonate Attribute API so Attribute API and AEP customers do not have to write their own code. To learn more about what a AEP Tag Extension is or the AEP Platform in general, view the Adobe Official Documentation.

Extension Features

The Resonate Tag Extension provides two features to make it easy for clients to include Resonate attributes in their AEP workflows. 

Fetch Attributes for IP Action

The Fetch Attributes Action is the functionality that actually performs the call to the Attributes API and gets the customer’s subscribed attribute for the website viewer’s IP address.

The attribute data is stored into local storage on the user’s browser, and can be retrieved and used as a Data Element (more on this in the following section).

To use this action, you can configure a new Tag Rule and add the Resonate Fetch Attributes for IP action as an action in that rule. To learn more about action and Tag Rules, read the following documentation: Action Types for Web Extensions | Adobe Data Collection. See the following screenshot for an example setup:

Resonate Action added to a Tag Rule

Resonate Attributes Data Element

In addition to the Fetch action, the Resonate AEP Tag Extension also provides a Resonate Attributes Data Element. This data element is where the attributes are stored after the API call has returned. The extension consumer can then use this data element as a value in other tag rules, data elements, and configurations making it flexible to build their tag around their workflows.

In order to properly use the data element, it is imperative to call the Fetch Resonate Attributes Action BEFORE any other component using that data element.

This data element is a key-value pair mapping of the Resonate Attribute Keys to one of the following values:

• 0 - The attribute does not represent the viewer

• 1 - The attribute does represent the viewer

• null - The attribute is sensitive

The Data Element will have the following structure:

{
  "1234": 1, // Attribute key-value mapping
  "2345": 0,
  "3456": null
}

Additionally, the extension can be configured with a JSON object mapping that can map the Attribute Keys to a human-readable label. This can be useful in other parts of the platform so the customer can remember what a specific key is used for.

Here is an example of how to use the data element in another component in the tag:

Configuring the Resonate Attributes Data Element

Using the Resonate Attributes Data Element

Extension Configuration

The Resonate AEP Tag Extension has two configuration options that control how the extension behaves.

1. API Key - This is the Resonate Attributes API Key that was provided upon onboarding to the Resonate Attributes API. This field is required for access to the API.
2. Attribute Mappings - This is an optional JSON value that maps an attribute key to a human-readable name. This is useful for referencing a Resonate Attribute in other places in AEP. Any attributes that do not have a mapping here will default to the original attribute key.

Here is an example configuration for the extension:

Example Extension Configuration

It is recommended to not use spaces in the names of the attribute mappings, and spaces should be replaced with underscore characters.