Show Menu
TOPICS×

Adobe Experience Platform Extension

The Adobe Experience Platform Extension sends data to the Adobe Experience Cloud from web properties, through the Adobe Experience Platform Edge Network. The Adobe Experience Platform extension allows for streaming data into platform, syncing identities, opt-in and automatically collecting context data.

Configure the Adobe Experience Platform extension

This section provides a reference for the options available when configuring the Adobe Experience Platform extension.
If the Adobe Experience Platform Web SDK extension is not yet installed, open your property, then click Extensions > Catalog , hover over the Adobe Experience Platform Web SDK extension, and click Install .
To configure the extension, open the Extensions tab, hover over the extension, and then click Configure .

Instance Name

The Adobe Experience Platform extension supports multiple instances on the page. This is used to send data to multiple organizations with a single launch configuration. The Name defaults to alloy. However, you can change the instance name to any valid JavaScript object name. The Adobe Experience Platform extension requires that each instance have a different Config ID and a different Organization ID .

Config ID

The Config ID is what tells Adobe Experience Platform where the data should be routed and what configurations should be used on the server. This is required for the Adobe Experience Platform extension to work. You can obtain a configuration ID by contacting client care.

Organization ID

The Organization ID is the organization that you would like the data sent to at Adobe. Most of the time, you should use the default value that is autopopulated. When you have multiple instances on the page, populate this with the value of the second organization you want to send data to.

Edge Domain

The Edge Domain is the domain that the Adobe Experience Platform extension sends and receives data from. The extension requires that you use a 1st-party CNAME for production traffic. The default 3rd-party domain works for development environments but is not suitable for production environments. Instructions on how to set up a first-party CNAME are listed here .

Enable Errors

By default, if there is an error with the extension, it logs the error to the console. If you want to hide the errors in a production environment, you can uncheck the Enable Errors checkbox. Errors still print out when debugging is turned on in Launch.

Enable Opt-in

If Enable Opt-in is enabled, Adobe Experience Platform extension can hold hits until opt-in is received. The extension exposes an action to set the opt-in preferences.

Enable Migrate ECID

The Adobe Experience Platform extension uses a new cookie to store the ECID. This setting enables compatibility between the new cookie and the old cookie for migration purposes. Adobe highly recommends this be enabled, unless you have no existing visitors with an ECID.

Use 3rd Party Cookies

The Adobe Experience Platform will store a cookie in the first party domain always. This option allows you to use a third-party cookie set on demdex.net in addition to the cookie on the first-party domain. This can be helpful when you have users that move between multiple domains. This will disable calls to demdex.net.

Context

The extension collects information automatically about the context of the request (for example, details about the URL and the browser). This can be disabled by deselecting specific contexts.
  • web - Details about the webpage such as url, referrer, etc.
  • device - Details about the device such as the screen orientation, screen height and screen width.
  • environment - Information about the computing environment (Browser, connection, and so on)
  • location - Limited information about the location of the user

Action Types

Send Event

Sends an event to Adobe Experience Platform so that Adobe Experience Platform can collect the data you send and act on that information. You must select an instance (if you have more than one). If the event happens at the beginning of a page load or during a view change in a single page application, select Occurs at the start of a view .
Any data that you want to send can be sent in the XDM Data field. This should be a JSON object that conforms to the structure of your XDM schema. This object can either be created on your page or through a Custom Code Data Element .

Set Opt-in Preferences

There are currently two option for opt-in. All purpose sends data to Adobe Experience Platform and No purposes , sends no data. These can either be set on the event or pulled from a Data Element .