After you configure the Adobe Experience Platform Web SDK tag extension, you must configure your action types.
This page describes the action types supported by the Adobe Experience Platform Web SDK tag extension.
The Apply propositions action type allows you to render propositions in single-page applications without incrementing metrics.
This action type is useful when working with single-page applications where portions of the page get re-rendered, potentially overwriting any personalizations already applied to the page.
You can use this action type for various use cases, such as:
This action type will not send a display event for rendered propositions. It will keep track of rendered propositions so that these can be included in subsequent Send event calls.
This action type supports the following fields:
Use the Apply response action type when you want to perform various actions based on a response from the Edge Network. This action type is typically used in hybrid deployments where the server makes an initial call to the Edge Network, then this action type takes the response from that call and initializes the Web SDK in the browser.
Using this action type may reduce client load times for hybrid personalization use cases.
This action type supports the following configuration options:
This action type manually triggers ruleset evaluation. Rulesets are returned by Adobe Journey Optimizer to support features like in-browser messages.
This action type supports the following options:
This action is used to get the legacy Media Analytics API. When configuring the action and an object name is provided, then the legacy Media Analytics API will be exported to that window object. If none is provided it will be exported to window.Media
as the current Media JS library does.
Use this action type to share identities from the current page to other domains. This action is designed to be used with a click event type and a value comparison condition. See append identity to URL using the Web SDK extension for more information on how to use this action type.
Sends an event to Experience Platform so that Platform can collect the data you send and act on that information. Any data that you want to send can be sent in the XDM Data field. Use 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.
The Send Event action type supports the fields and settings described below. These fields are all optional.
Use the Instance selector to choose your Web SDK instance that you want to configure. If you have only one instance, it is preselected.
Instance: Select the Web SDK instance that you want to configure. If you only have one instance, it will be preselected.
Use guided events: Enable this option to automatically fill in or hide certain fields to enable a particular use case. Enabling this option triggers the display of the following settings.
The guided events are related to top and bottom of page events.
type
in the sendEvent
command for more information.data
in the sendEvent
command for more information._experience.decisioning
XDM field with information about the rendered propositions.eventMergeId
XDM field.sendEvent
call of the page load. You can choose from the following options:
requestDefaultPersonalization
not set in the Web SDK command.requestDefaultPersonalization
set to true
.requestDefaultPersonalization
set to false
.Datastream overrides allow you to define additional configurations for your datastreams, which get passed to the Edge Network via the Web SDK.
This helps you trigger different datastream behaviors than the default ones, without creating a new datastream or modifying your existing settings. See the documentation on configuring datastream overrides for more details.
Sends a media event to Adobe Experience Platform and/or Adobe Analytics. This action is useful when you are tracking media events on your website. Select an instance (if you have more than one). The action requires a playerId
that represents a unique identifier for a tracked media session. It also requires a Quality of Experience and a playhead
data element when starting a media session.
The Send media event action type supports the following properties:
AdBreakStart
event, you must specify the required advertising details.AdStart
event.After you have received consent from your user, this consent must be communicated to the Adobe Experience Platform Web SDK by using the “Set Consent” action type. Currently, two types of standards are supported: “Adobe” and “IAB TCF.” See Supporting Customer Consent Preferences. When using Adobe version 2.0, only a data element value is supported. You will need to create a data element that resolves to the consent object.
In this action, you are also provided with an optional field to include an Identity Map so that identities can be synced once consent is received. Syncing is useful when the consent is configured as “Pending” or “Out” because the consent call is likely the first call to fire.
Use this action to modify an XDM object as a result of an event. This action is intended to build up an object that can later be referenced from a Send event action, to record the event XDM object.
In order to use this action type you must have defined a variable data element. Once you choose a variable data element to modify, an editor appears, similar to the editor for the XDM object data element.
The XDM schema that is used for the editor is the schema that is selected on the variable data element. You can set one or more properties of the object by clicking on one of the properties in the tree on the left, and then modifying the value on the right.For example, in the screenshot below, the producedBy property is getting set to the data element “Produced by data element.”
There are some differences between the editor in the update variable action versus the editor in the XDM object data element. First, the update variable action has a root level item labeled “xdm.” If you click on this item, you can specify a data element to use to set the entire object. Second, the update variable action has checkboxes to clear the data from the xdm object. Click on one of the properties on the left, and then check the checkbox on the right to clear the value. This will clear out the current value before setting any values on the variable.
After reading this article, you should have a better understanding of how to configure your actions. Next, read about how to configure your data element types.