description |
---|
Step-by-Step guide to set up Adobe Analytics as a destination in RudderStack. |
To enable sending data to Adobe Analytics, you will first need to add it as a destination in RudderStack. Once the destination is configured and enabled, events from RudderStack will start flowing to Adobe Analytics.
Before configuring Adobe Analytics as a destination, verify if the source platform supports sending events to RudderStack, by referring to the table below:
Connection Mode | Web | Mobile | Server |
---|---|---|---|
Device Mode | Supported | - | - |
Cloud Mode | - | - | - |
{% hint style="info" %} To know more about the difference between Cloud mode and Device mode in RudderStack, read the RudderStack connection modes guide. {% endhint %}
Once you've confirmed that the source platform supports sending data to Adobe Analytics, follow these steps:
- Choose a source for which you would like to add Adobe Analytics as a destination.
{% hint style="info" %} Follow the guide on How to Add a Source and Destination in RudderStack for more details. {% endhint %}
- From the list of destinations, select Adobe Analytics. Assign a name to the destination and click on Next.
- Enter the relevant Connection Settings by referring to the following section.
This section lists all the relevant connection settings to successfully set up Adobe Analytics as a destination in RudderStack.
- Tracking Server URL: The
trackingServer
variable determines the location an image request is sent. Eg: If url ishttp://abc.a.b
,the tracking server URL will beabc.a.b
.
{% hint style="warning" %} If this variable is defined incorrectly, your implementation may experience data loss. {% endhint %}
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Tracking Server Secure URL: The
trackingServerSecure
variable determines the location an image request is sent over HTTPS. If this variable is not defined correctly, your implementation can experience data loss.
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Report Suite ID(s): The Report Suite ID can be found in your Adobe Analytics Settings page. Multiple IDs can be separated by commas. For example:
ab.cd
,ef.gh
,ij.kl
. - Check for Heartbeat calls to be made over HTTPS: If this setting is enabled and the Heartbeat Tracking Server URL is present, the SSL value will be set to
true
so that the calls go over HTTPs. - Heartbeat Tracking Server URL: If assigned, this will be used as tracking server URL instead of the URL assigned in the Tracking Server URL field. RudderStack will set all heartbeat configurations if this URL is present.
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Adobe Heartbeat Settings: This setting is used to map your RudderStack video events to Adobe Heartbeat Events. Find more information on how this mapping is done in the Adobe Analytics Heartbeat Measurement page.
- Adobe Analytics Javascript SDK URL/Heartbeat SDK URL: Add your proxy URL where you will be hosting the
adobe-analytics-js.js
andadobe-analytics-js-heartbeat.js
. By default, we host them at https://cdn.rudderlabs.com/adobe-analytics-js/adobe-analytics-js.js and https://cdn.rudderlabs.com/adobe-analytics-js/adobe-analytics-js-heartbeat.js respectively.
- Marketing Cloud Organization ID: If you want to use
visitorAPI.js
, enter this field. For example:99887766ABC@AdobeOrg
. - Drop Visitor ID: If enabled, RudderStack does not assign the
userId
tovisitorID
.
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Timestamp Option: Adobe Analytics has Report Suites that accepts timestamped, non-timestamped or hybrid data. Note that
window.s.timestamp
will be affected. Also depending on this value,visitorID
will be set if the drop visitor id is off.
{% hint style="info" %}
- If the timestamp option is disabled, then
visitorID
will be set. - If timestamp option is set to hybrid and the Prefer Visitor ID setting is on, then
visitorID
will be set. - For all other cases, RudderStack does not set a
visitorID
.
Also note the following regarding timestamps:
-
If the timestamp option is enabled, then timestamp will be set.
-
If the timestamp option is hybrid and Prefer Visitor ID is off, then timestamp will be set. {% endhint %}
-
Prefer Visitor ID: Adobe does not allow sending both
visitorID
and timestamp. Hence, this option is used when the timestamp option is set as hybrid. Also, note that if this option is enabled,visitorID
will be set. If disabled, the timestamp value will be set.
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Enable pageName for Track Events: When enabled, RudderStack only tracks events by sending a
pageName
.
- Map Rudder Events to Adobe Custom Events: This setting allows you to add one or multiple custom Adobe events separated by comma.
- Map Rudder Context data to Adobe Context Data: Context data variables allow you to you define custom variables on each page that the processing rules apply and can read. Instead of explicitly assigning values to the analytics variables, you can send your data in via these context data variables. The processing rules take the values from the context data variables and pass them into the respective analytics variables.
This setting allows you to map the key present under the context/properties of the RudderStack message to the property name you want to send to the Adobe context data. An example is as shown below:
"context": {
"contextProperties": {
"prop1": "val1",
"prop2": "val2"
}
}
If you want to set prop1
to Adobe's context data property1
, then map with contextProperties.prop1
--> property1
.
If you want to send top level properties anonymousId
, messageId
, event
then simply enter the key.
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Add Prefix for Context Data: If you would like to prefix your RudderStack properties before sending them as
contextData
, you can enter a prefix here which will be automatically appended. - Map Rudder Properties to Adobe eVars: eVars are custom variables that you can use as per your requirement. Each eVar is a string containing custom values specific to your organization, with a maximum length of 255 bytes. Note that values longer than 255 bytes are automatically truncated when sent to Adobe.
This setting lets you map any RudderStack property with the eVar you want.
{% hint style="info" %} Only enter the index number of the eVar you want to set. {% endhint %}
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Map Rudder Properties to Adobe Hierarchy properties: Hierarchy variables are the custom variables that allow you to see a site’s structure. By default, Adobe supports up to 5 hierarchy variables in your implementation.
This setting lets you map any RudderStack property with the hierarchy variable you want.
{% hint style="info" %} Only enter the index number of the hierarchy variable that you want to set. {% endhint %}
{% hint style="info" %} For more information on this setting, refer to the Adobe Analytics documentation. {% endhint %}
- Map Rudder Properties to Adobe list properties: List variables are custom variables that you can use as per your requirement. They work similarly to eVars, except they can contain multiple values. Also, list variables do not have a character limit.
This setting lets you map any RudderStack property with the list you want.
{% hint style="info" %} Enter only the index number of the list you want to set to. The list properties should be an array/string separated by commas. Otherwise, they will be dropped.
For more information, refer to the Adobe Analytics documentation {% endhint %}
- Map Rudder Property with Delimiters for list properties: The list variables need to be sent as a string. So if there is a list of properties, it needs to be delimited. RudderStack lets you set any of the delimiters from
, ; / : |
.
- Map Rudder Properties to Adobe Custom properties: Props are custom variables that you can use as per your requirement. This setting lets you map any RudderStack property with the prop you want to set it to.
{% hint style="info" %} Enter only the index number of the prop you want to set.
For more information, refer to the Adobe Analytics documentation {% endhint %}
- Map Rudder Property with Delimiters for Adobe Custom properties: The property variables need to be sent as a string. So if there is a list of properties, it needs to be delimited. RudderStack lets you set any of the delimiters from
, ; / : |
.
- Map Rudder Events to Adobe Merchandise events: This setting lets you map the RudderStack event with the currency/purchase type of the Adobe event. For example:
event5
. - Increment or Currency Properties to add to merchandise events at event level: The RudderStack property that has a currency/counter value should be added here. This will then be used to create the event string like
purchase,event5=19.9
. RudderStack automatically sets thecurrencyCode
value. (The default value is USD).
{% hint style="info" %} For more information, refer to the Adobe Analytics documentation {% endhint %}
- Map Rudder Events to Adobe Merchandise events: This setting lets you map a RudderStack event with a currency/purchase type of an Adobe event.
- Properties to add to merchandise events at product level: With this setting, the RudderStack property that has a currency/counter value should be added. This will be used to create a product string like
[category][item][quantity][total][incrementor][merchString]
.
- Map Rudder Properties to eVars at product level: Lets you map the RudderStack properties you want to set to eVars.
{% hint style="info" %}
Set only the index. The eVars will be appended with |
and sent along with the product string.
For more information, refer to the Adobe Analytics documentation {% endhint %}
- Product Identifier: Adobe Analytics accepts only a single product identifier. This setting lets you choose from a SKU/ID/Name of the product.
For more information on any of the sections covered in this guide, you can contact us or start a conversation on our Slack _**_channel.