# Adobe Analytics Destination Config Reference


> Complete Rudder CLI reference for the Adobe Analytics destination config keys, variable and merchandising mappings, video heartbeat, device mode, and source types.



[Adobe Analytics](https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/) is a web and app analytics destination. RudderStack sends events to Adobe's Data Insertion API from its servers, or loads Adobe's own libraries in device mode — in the browser, and in Android and iOS apps.

In an Adobe Analytics destination spec:

- `type: adobe_analytics`
- `definition_version: 1`

## Sample configuration

```yaml
version: rudder/v1
kind: destination
metadata:
  name: adobe-analytics-prod
spec:
  id: adobe-analytics-prod
  display_name: Adobe Analytics Production
  type: adobe_analytics
  definition_version: 1
  enabled: true
  config:
    report_suite_ids: acmeprod,acmeglobal
    tracking_server_url: "{{ .ADOBE_TRACKING_SERVER_URL }}"
    tracking_server_secure_url: acme.sc.omtrdc.net
    marketing_cloud_org_id: "{{ .ADOBE_MARKETING_CLOUD_ORG_ID }}"

    drop_visitor_id: false
    timestamp_option: disabled
    prefer_visitor_id: false

    rudder_events_to_adobe_events:
      - from: Signed Up
        to: event1
    track_page_name: true

    context_data_mapping:
      - from: section
        to: siteSection
    context_data_prefix: rs
    e_var_mapping:
      - from: plan
        to: "2"
    list_mapping:
      - from: interests
        to: "1"
        delimiter: ","
    custom_props_mapping:
      - from: category
        to: "3"
        delimiter: "|"

    event_merch_event_to_adobe_event:
      - from: Order Completed
        to: event5
    event_merch_properties:
      - revenue
    product_identifier: sku

    heartbeat_tracking_server_url: "{{ .ADOBE_HEARTBEAT_TRACKING_SERVER_URL }}"
    events_to_types:
      - from: Video Playback Started
        to: heartbeatPlaybackStarted
      - from: Video Playback Completed
        to: heartbeatPlaybackCompleted

    event_filtering:
      blacklist:
        - Product Viewed

    connection_mode:
      web: device
      cloud: cloud
    consent_management:
      web:
        - provider: oneTrust
          consents:
            - analytics
```

The above example loads Adobe's library on web sources in `device` mode and sends server-side events in `cloud` mode, which needs `tracking_server_secure_url` — see [Connection](#connection). It sends `userId` as Adobe's visitor ID, and sets up video heartbeat tracking for the web library — see [Identity and timestamps](#identity-and-timestamps) and [Video heartbeat](#video-heartbeat).

## Config keys

`config` accepts only the keys listed below. The [shared config key rules](https://www.rudderstack.com/docs/rudder-cli/destination-types/#config-key-rules) cover unknown keys, defaults, and immutability.

**Info**

Adobe Analytics keys split by connection mode and platform, and each group below says which mode its keys affect. Rudder CLI accepts every key whatever the mode — a key for another mode is stored and ignored.

In `cloud` mode Adobe Analytics accepts `track`, `page`, and `screen` events. In `device` mode, web sources send `page` and `track`, while Android and iOS sources send `identify`, `track`, and `screen`.

### Connection

These keys tell Adobe Analytics where the data belongs. In web device mode, a report suite or tracking server the page already sets on Adobe's `s_account` or `s` object takes precedence over these keys.

<div class="rs-ckeys">
<div class="rs-ckey" id="report_suite_ids">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">report_suite_ids</p>Required</div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Report suite IDs RudderStack sends events to, separated by commas — for example <code>acmeprod,acmeglobal</code>. They&rsquo;re listed on the Adobe Analytics settings page.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode. Android and iOS device mode take the report suite from the app&rsquo;s <code>ADBMobileConfig.json</code> file instead.</li>
<li>At most 300 characters, and must not contain line breaks.</li>
<li>A <code>{{ path || fallback }}</code> template is accepted in place of a literal, and isn&rsquo;t measured against the length limit.</li>
<li>A spec that omits this key fails validation with <code>'report_suite_ids' is required</code>.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="tracking_server_url">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">tracking_server_url</p>Secret</div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Hostname of your Adobe Analytics tracking server — Adobe&rsquo;s <code>trackingServer</code> variable — without <code>http://</code> or <code>https://</code>, for example <code>acme.sc.omtrdc.net</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies to <code>device</code> mode on <code>web</code> sources only.</li>
<li>At most 100 characters, and must not contain line breaks. A value containing <code>.ngrok.io</code> fails validation.</li>
<li>A <code>{{ path || fallback }}</code> template is accepted in place of a literal.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <p>Supply it as a <code>{{ .VAR }}</code> reference rather than a literal — see <a href="#secrets" >Secrets</a>.</p>
<p>See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/#connection-settings" >Connection settings</a>.</p>

</div>

</div>

<div class="rs-ckey" id="tracking_server_secure_url">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">tracking_server_secure_url</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Hostname of your Adobe Analytics tracking server for HTTPS requests — Adobe&rsquo;s <code>trackingServerSecure</code> variable — for example <code>acme.sc.omtrdc.net</code>. Cloud mode sends every event to this host.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode.</li>
<li>Rudder CLI doesn&rsquo;t require this key, even when a source connects in <code>cloud</code> mode. Without it, RudderStack can&rsquo;t deliver cloud-mode events.</li>
<li>At most 100 characters, and must not contain line breaks. A value containing <code>.ngrok.io</code> fails validation.</li>
<li>A <code>{{ path || fallback }}</code> template is accepted in place of a literal.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="marketing_cloud_org_id">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">marketing_cloud_org_id</p>Secret</div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Your Adobe Marketing Cloud organization ID, for example <code>1A2B3C4D5E6F7A8B9C0D1E2F@AdobeOrg</code>. In web device mode, setting it starts Adobe&rsquo;s Visitor ID service (<code>visitorAPI.js</code>) with this ID. In cloud mode, RudderStack sends it with each event.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode.</li>
<li>At most 100 characters, and must not contain line breaks.</li>
<li>Templates aren&rsquo;t accepted in place of a literal; a template is measured as text against the same limit.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <p>Supply it as a <code>{{ .VAR }}</code> reference rather than a literal — see <a href="#secrets" >Secrets</a>.</p>
<p>See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/#identity-resolution" >Identity resolution</a>.</p>

</div>

</div>

</div>

### Identity and timestamps

These keys apply in `cloud` mode and to `web` sources in `device` mode. Adobe doesn't accept both a visitor ID and a timestamp in one hit, so `drop_visitor_id`, `timestamp_option`, and `prefer_visitor_id` together decide which one each event carries:

| `timestamp_option` | Visitor ID | Timestamp |
| :-----| :-----| :-----|
| `disabled` | Sent, unless `drop_visitor_id` is `true` | Not sent |
| `enabled` | Not sent | Sent |
| `hybrid`, with `prefer_visitor_id: true` | Sent, unless `drop_visitor_id` is `true` | Not sent |
| `hybrid`, with `prefer_visitor_id: false` | Not sent | Sent |
| `optional` | Not sent | Not sent |

The visitor ID is the event's `userId`, so an event without one carries none. In `cloud` mode, a timestamp is sent only when `timestamp_optional_reporting` is also `true`.

<div class="rs-ckeys">
<div class="rs-ckey" id="drop_visitor_id">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">drop_visitor_id</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>true</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Don&rsquo;t send the event&rsquo;s <code>userId</code> as Adobe&rsquo;s visitor ID. Set it to <code>false</code> to send the visitor ID in the cases the table above lists.
</p>

</div>

<div class="rs-ckey" id="timestamp_option">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">timestamp_option</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>disabled</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Whether your report suites accept timestamped data, non-timestamped data, or both. It decides whether each event carries a visitor ID or a timestamp, as the table above shows.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>One of <code>disabled</code>, <code>enabled</code>, <code>hybrid</code>, or <code>optional</code>.</li>
<li><code>optional</code> sets neither a visitor ID nor a timestamp.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/#timestamps" >Timestamps</a>.
</div>

</div>

<div class="rs-ckey" id="prefer_visitor_id">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">prefer_visitor_id</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>false</code>
  </p>
<p class="rs-ckey__field">
  Description:
  With <code>timestamp_option: hybrid</code>, send the visitor ID instead of the timestamp.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies when <code>timestamp_option</code> is <code>hybrid</code>. Leave it unset otherwise.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="timestamp_optional_reporting">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">timestamp_optional_reporting</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>false</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Send event timestamps in cloud mode, for report suites where timestamps are optional. The dashboard calls it <strong>Send Both Timestamp and VisitorID for Timestamp Optional Reporting Suites</strong>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies to <code>cloud</code> mode only. Cloud mode sends no timestamp unless this is <code>true</code>.</li>
<li>Adobe advises against it, because it can put data out of order. It also needs <strong>Optional Timestamp</strong> turned on for the report suite.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="no_fallback_visitor_id">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">no_fallback_visitor_id</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>false</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Don&rsquo;t set Adobe&rsquo;s fallback visitor ID. When <code>false</code>, RudderStack sets it from the event&rsquo;s <code>AdobeFallbackVisitorId</code> external ID, if there is one.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies to <code>cloud</code> mode only.</li>
</ul>

</div>

</div>

</div>

### Event mapping

<div class="rs-ckeys">
<div class="rs-ckey" id="rudder_events_to_adobe_events">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">rudder_events_to_adobe_events</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps RudderStack event names to Adobe events.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — RudderStack event name.</li>
<li><code>to</code> — Adobe events to send for it, separated by commas, such as <code>event1,event2</code>. On Android and iOS, it&rsquo;s the action name sent to Adobe.</li>
<li>Both are required in each entry, each at most 100 characters and without line breaks.</li>
<li>Applies in every mode. In <code>cloud</code> mode, an event that&rsquo;s neither an ecommerce event nor mapped here fails, unless it carries <code>properties.overrideEventName</code>. That includes <code>page</code> and <code>screen</code> calls, which cloud mode matches by name.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">rudder_events_to_adobe_events:
  - from: Signed Up
    to: event1
  - from: Plan Upgraded
    to: event2,event3</code></pre></div>
</div><p>See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/cloud-mode/#overriding-adobe-parameters" >Overriding Adobe parameters</a> for <code>overrideEventName</code> and the other cloud-mode overrides.</p>
</div>

</div>

<div class="rs-ckey" id="track_page_name">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">track_page_name</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>true</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Send a <code>pageName</code> with every <code>track</code> event. The dashboard calls it <strong>Enable pageName for Track Events</strong>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode. In <code>cloud</code> mode, it affects only events whose <code>properties.overridePageView</code> is <code>true</code>.</li>
</ul>

</div>

</div>

</div>

### Variables

These keys map event fields to Adobe's custom variables. In every mapping, `from` and `to` are both required, each at most 100 characters and without line breaks. Templates aren't accepted in place of a literal; a template is measured as text against the same limit.

Index values are digit strings. Write `"2"`, not `2`, or validation fails.

<div class="rs-ckeys">
<div class="rs-ckey" id="context_data_mapping">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">context_data_mapping</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps event fields to Adobe context data variables, which Adobe processing rules can read.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — event field, such as a property name.</li>
<li><code>to</code> — context data variable name.</li>
<li>Applies in every mode.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">context_data_mapping:
  - from: section
    to: siteSection</code></pre></div>
</div><p>See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/#mappings" >Mappings</a>.</p>
</div>

</div>

<div class="rs-ckey" id="context_data_prefix">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">context_data_prefix</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Prefix added to context data variable names. The dashboard calls it <strong>Prefix to prepend to all contextData properties</strong>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>In <code>cloud</code> mode, it&rsquo;s prepended to each variable name from <code>context_data_mapping</code>.</li>
<li>In <code>device</code> mode, the SDK also sends event properties as context data under their own names, and prefixes those instead — <code>&lt;prefix&gt;.&lt;property&gt;</code> on web, <code>&lt;prefix&gt;&lt;property&gt;</code> on Android and iOS.</li>
<li>At most 100 characters, and must not contain line breaks.</li>
<li>Templates aren&rsquo;t accepted in place of a literal; a template is measured as text against the same limit.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="e_var_mapping">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">e_var_mapping</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps event fields to Adobe eVars.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — event field, such as a property name.</li>
<li><code>to</code> — eVar index, written as a string: <code>&quot;2&quot;</code> for <code>eVar2</code>.</li>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">e_var_mapping:
  - from: plan
    to: &#34;2&#34;</code></pre></div>
</div><p>See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/#mapping-for-evars-and-hierarchy-variables" >Mapping for eVars and hierarchy variables</a> for the values <code>from</code> accepts.</p>
</div>

</div>

<div class="rs-ckey" id="hier_mapping">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">hier_mapping</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps event fields to Adobe hierarchy variables, on the same terms as <code>e_var_mapping</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — event field, such as a property name.</li>
<li><code>to</code> — hierarchy index, written as a string: <code>&quot;1&quot;</code> for <code>hier1</code>.</li>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="list_mapping">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">list_mapping</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps event properties to Adobe list variables.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — event property holding an array, or a comma-separated string.</li>
<li><code>to</code> — list index, written as a string: <code>&quot;1&quot;</code> for <code>list1</code>.</li>
<li><code>delimiter</code> — <code>|</code>, <code>:</code>, <code>,</code>, <code>;</code>, or <code>/</code>, used to join the values. Set it on every entry, because an entry without one isn&rsquo;t sent. The dashboard defaults it to <code>,</code>, but Rudder CLI doesn&rsquo;t fill it in.</li>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">list_mapping:
  - from: interests
    to: &#34;1&#34;
    delimiter: &#34;,&#34;</code></pre></div>
</div>
</div>

</div>

<div class="rs-ckey" id="custom_props_mapping">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">custom_props_mapping</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps event properties to Adobe props, on the same terms as <code>list_mapping</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — event property holding an array, or a comma-separated string.</li>
<li><code>to</code> — prop index, written as a string: <code>&quot;3&quot;</code> for <code>prop3</code>.</li>
<li><code>delimiter</code> — <code>|</code>, <code>:</code>, <code>,</code>, <code>;</code>, or <code>/</code>. Set it on every entry here too. Without one, <code>cloud</code> mode skips the entry, and web device mode joins the values with <code>|</code>.</li>
<li>Applies to <code>cloud</code> mode and to <code>web</code> sources in <code>device</code> mode.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="mobile_event_mapping">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">mobile_event_mapping</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  The dashboard labels it <strong>Map RudderStack event field to Adobe mobile events</strong>, but no connection mode reads it. Android and iOS device mode take event names from <code>rudder_events_to_adobe_events</code>, and context data from <code>context_data_mapping</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> and <code>to</code> — the same shape as the other mappings.</li>
<li>Rudder CLI accepts it so that a destination already carrying a value keeps it. Leave it out of a new destination.</li>
</ul>

</div>

</div>

</div>

### Merchandising

These keys build Adobe's merchandising event and product strings for ecommerce events. They apply in `cloud` mode and to `web` sources in `device` mode, except `product_identifier`, which applies in every mode. In every mapping, `from` and `to` are both required, each at most 100 characters and without line breaks.

<div class="rs-ckeys">
<div class="rs-ckey" id="event_merch_event_to_adobe_event">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">event_merch_event_to_adobe_event</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps RudderStack events to Adobe merchandising events of the currency or counter type, in the event string.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — RudderStack event name, such as <code>Order Completed</code>.</li>
<li><code>to</code> — Adobe event, such as <code>event5</code>.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/#merchandise-event-level-settings" >Merchandise event level settings</a>.
</div>

</div>

<div class="rs-ckey" id="event_merch_properties">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">event_merch_properties</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of strings</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Event properties holding the currency or counter values for the events mapped in <code>event_merch_event_to_adobe_event</code>. With <code>revenue</code> listed, an <code>Order Completed</code> event mapped to <code>event5</code> produces an event string such as <code>purchase,event5=19.9</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Each name is at most 100 characters, and must not contain line breaks.</li>
<li>Templates aren&rsquo;t accepted in place of a literal; a template is measured as text against the same limit.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="product_merch_event_to_adobe_event">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">product_merch_event_to_adobe_event</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps RudderStack events to Adobe merchandising events of the currency or counter type, in the product string.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — RudderStack event name.</li>
<li><code>to</code> — Adobe event.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/#merchandise-product-level-settings" >Merchandise product level settings</a>.
</div>

</div>

<div class="rs-ckey" id="product_merch_properties">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">product_merch_properties</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of strings</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Properties holding the currency or counter values for the events mapped in <code>product_merch_event_to_adobe_event</code>. A name starting with <code>products.</code>, such as <code>products.price</code>, is read from each product.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Each name is at most 100 characters, and must not contain line breaks.</li>
<li>Templates aren&rsquo;t accepted in place of a literal; a template is measured as text against the same limit.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="product_merch_evars_map">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">product_merch_evars_map</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps properties to merchandising eVars in the product string, for the events mapped in <code>product_merch_event_to_adobe_event</code>. RudderStack joins them with <code>|</code> and appends them to each product.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — property name.</li>
<li><code>to</code> — eVar index, written as a string, such as <code>&quot;4&quot;</code>.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="product_identifier">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">product_identifier</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>name</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Product field that identifies each product to Adobe, which accepts only one.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>One of <code>name</code>, <code>id</code>, or <code>sku</code>. With <code>id</code>, RudderStack reads <code>product_id</code>, falling back to <code>id</code>.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/ecommerce-events/" >Ecommerce Events</a> for how RudderStack maps ecommerce events to Adobe.
</div>

</div>

</div>

### Video heartbeat

These keys configure Adobe's heartbeat tracking for video, so they apply only to sources connected in `device` mode — `web`, `android`, or `ios`.

<div class="rs-ckeys">
<div class="rs-ckey" id="heartbeat_tracking_server_url">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">heartbeat_tracking_server_url</p>Secret</div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Hostname of your Adobe heartbeat tracking server, such as <code>acme.hb.omtrdc.net</code>. Adobe provides it. Setting it turns on heartbeat tracking — on web, the SDK loads Adobe&rsquo;s heartbeat library in place of the standard one.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>At most 100 characters, and must not contain line breaks. A value containing <code>.ngrok.io</code> fails validation.</li>
<li>Templates aren&rsquo;t accepted — the value must be a literal.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <p>Supply it as a <code>{{ .VAR }}</code> reference rather than a literal — see <a href="#secrets" >Secrets</a>.</p>
<p>See <a href="https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/adobe-analytics-heartbeat/" >Adobe Analytics Heartbeat Measurement</a>.</p>

</div>

</div>

<div class="rs-ckey" id="ssl_heartbeat">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">ssl_heartbeat</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>boolean</code>
  </p><p class="rs-ckey__field">
    Default value:
    <code>true</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Send heartbeat calls over HTTPS.
</p>

</div>

<div class="rs-ckey" id="events_to_types">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">events_to_types</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>array of objects</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps RudderStack video events to Adobe heartbeat events.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>from</code> — RudderStack event name. Required, at most 100 characters and without line breaks.</li>
<li><code>to</code> — one of <code>initHeartbeat</code>, <code>heartbeatPlaybackStarted</code>, <code>heartbeatPlaybackPaused</code>, <code>heartbeatPlaybackResumed</code>, <code>heartbeatPlaybackCompleted</code>, <code>heartbeatPlaybackInterrupted</code>, <code>heartbeatContentStarted</code>, <code>heartbeatContentComplete</code>, <code>heartbeatAdBreakStarted</code>, <code>heartbeatAdBreakCompleted</code>, <code>heartbeatAdStarted</code>, <code>heartbeatAdCompleted</code>, <code>heartbeatAdSkipped</code>, <code>heartbeatSeekStarted</code>, <code>heartbeatSeekCompleted</code>, <code>heartbeatBufferStarted</code>, <code>heartbeatBufferCompleted</code>, <code>heartbeatQualityUpdated</code>, or <code>heartbeatUpdatePlayhead</code>. Rudder CLI doesn&rsquo;t require it, but an entry without one maps nothing.</li>
<li>On web, applies only when <code>heartbeat_tracking_server_url</code> is set. Android and iOS don&rsquo;t support <code>initHeartbeat</code> or <code>heartbeatUpdatePlayhead</code>.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">events_to_types:
  - from: Video Playback Started
    to: heartbeatPlaybackStarted</code></pre></div>
</div>
</div>

</div>

</div>

### Web library hosting

Both keys apply to `device` mode on `web` sources only. Each is at most 100 characters and must not contain line breaks, and a value containing `.ngrok.io` fails validation. Templates aren't accepted — the value must be a literal.

<div class="rs-ckeys">
<div class="rs-ckey" id="proxy_normal_url">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">proxy_normal_url</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  URL of your own copy of Adobe&rsquo;s JavaScript library. When omitted, the SDK loads RudderStack&rsquo;s hosted copy from <code>cdn.rudderlabs.com</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Used when <code>heartbeat_tracking_server_url</code> is unset.</li>
</ul>

</div>

</div>

<div class="rs-ckey" id="proxy_heartbeat_url">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">proxy_heartbeat_url</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>string</code>
  </p>
<p class="rs-ckey__field">
  Description:
  URL of your own copy of Adobe&rsquo;s heartbeat library. When omitted, the SDK loads RudderStack&rsquo;s hosted copy from <code>cdn.rudderlabs.com</code>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>Used when <code>heartbeat_tracking_server_url</code> is set.</li>
</ul>

</div>

</div>

</div>

### Event filtering

**Warning:** [Client-side event filtering](https://www.rudderstack.com/docs/sources/event-streams/sdks/event-filtering/) applies only to sources connected in `device` mode — `web`, `android`, or `ios` — because the SDK is what applies the filter. Rudder CLI accepts the block in any mode, but events sent in `cloud` mode reach Adobe Analytics unfiltered.

<div class="rs-ckeys">
<div class="rs-ckey" id="event_filtering">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">event_filtering</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>object</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Restricts which <code>track</code> events the SDK passes to Adobe Analytics, by event name.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li><code>whitelist</code> — array of event names to allow; every other <code>track</code> event is dropped.</li>
<li><code>blacklist</code> — array of event names to drop; every other <code>track</code> event is allowed.</li>
<li>The two are mutually exclusive, and Rudder CLI enforces it — setting both fails validation.</li>
<li>Each name is at most 100 characters, and must not contain line breaks.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">connection_mode:
  web: device
event_filtering:
  blacklist:
    - Product Viewed</code></pre></div>
</div>
</div>

</div>

</div>

### Per-source keys

Both keys are objects keyed by the local source type — the tokens listed under [Source types](#source-types). A key naming a source type this destination doesn't support fails validation.

<div class="rs-ckeys">
<div class="rs-ckey" id="connection_mode">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">connection_mode</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>object</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Maps each source type you connect to the mode its events reach Adobe Analytics in, using the modes in <a href="#source-types" >Source types</a>.
</p>

<div class="rs-ckey__notes">
  <p class="rs-ckey__field">Notes:</p>
  <ul>
<li>An entry is required for each source type you connect — see <a href="#connect-a-source" >Connect a source</a>.</li>
<li>A mode the source type doesn&rsquo;t support on this destination fails validation — for example <code>device</code> for <code>react_native</code>.</li>
</ul>

</div>

<div class="rs-ckey__extra">
  <div class="rs-code">
  <div class="rs-code__head">yaml<button class="rs-code__copy" type="button">
      
      Copy
    </button>
  </div>
  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">connection_mode:
  web: device
  ios: device
  cloud: cloud</code></pre></div>
</div>
</div>

</div>

<div class="rs-ckey" id="consent_management">
  <div class="rs-ckey__title">
    <p class="rs-ckey__name">consent_management</p></div>
  <p class="rs-ckey__field">
    Type:
    <code>object</code>
  </p>
<p class="rs-ckey__field">
  Description:
  Consent provider configuration per source type. The entry shape, accepted providers, and the rules on <code>resolution_strategy</code> and <code>consents</code> are shared across all destination types — see <a href="https://www.rudderstack.com/docs/rudder-cli/destination-types/#consent-management" >Consent management</a>.
</p>

</div>

</div>

## Source types

Adobe Analytics accepts events from these source types in the mentioned connection modes:

| Source type | Connection mode |
| :-----| :-----|
| `android` | `cloud`, `device` |
| `android_kotlin` | `cloud` |
| `ios` | `cloud`, `device` |
| `ios_swift` | `cloud` |
| `web` | `cloud`, `device` |
| `unity` | `cloud` |
| `react_native` | `cloud` |
| `flutter` | `cloud` |
| `cordova` | `cloud` |
| `cloud` | `cloud` |
| `warehouse` | `cloud` |

`web`, `android`, and `ios` offer `device` mode. On mobile, device mode runs through the Android (Java) and iOS (Obj-C) SDKs, which load Adobe's mobile SDK in the app. The Kotlin and Swift SDKs — `android_kotlin` and `ios_swift` — are `cloud` only. See [Sending events via web device mode](https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/adobe-analytics-web-device-mode/) and [Sending events via mobile device mode](https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/adobe-analytics-mobile-device-mode/).

`warehouse` is the token a [Reverse ETL source](https://www.rudderstack.com/docs/sources/reverse-etl/) resolves to. Rudder CLI manages the destination’s `warehouse` entry — if the destination is connected to a Reverse ETL source, set `connection_mode.warehouse: cloud` in its spec, or `apply` removes it.

Rudder CLI can also declare the Reverse ETL connection itself, for the types listed under [Supported destinations](https://www.rudderstack.com/docs/rudder-cli/yaml-retl-connections/#supported-destinations) — see [Manage Reverse ETL Connections using Rudder CLI](https://www.rudderstack.com/docs/rudder-cli/retl-connections/).

**Info:** The dashboard additionally offers Adobe Analytics to AMP and Shopify sources. Rudder CLI doesn&#39;t manage those connections, so `amp` and `shopify` are invalid here.

## Connect a source

An event stream connection to this destination is checked against two rules at `validate` time.

**The source's type must be supported.** A source's type resolves to one of the tokens above before the check — a JavaScript source resolves to `web`, and webhook and server-side SDK sources resolve to `cloud`. Every type an event stream source can resolve to is supported here, so this check always passes.

**The destination config must carry a `connection_mode` entry for that source type.** This lives on the destination spec, not on the [connection spec](https://www.rudderstack.com/docs/rudder-cli/yaml-connections/). Without it:

```text
destination 'adobe-analytics-prod' config has no 'connection_mode' entry for source type 'web'
```

Adobe Analytics needs no additional config keys to connect a source of any type, in any mode. However, `cloud` mode can't deliver events without [`tracking_server_secure_url`](#tracking_server_secure_url).

## Secrets

`tracking_server_url`, `marketing_cloud_org_id`, and `heartbeat_tracking_server_url` are the secret keys. Write each one you use as a `{{ .VAR }}` reference and supply the value at apply time:

```yaml
config:
  tracking_server_url: "{{ .ADOBE_TRACKING_SERVER_URL }}"
  marketing_cloud_org_id: "{{ .ADOBE_MARKETING_CLOUD_ORG_ID }}"
  heartbeat_tracking_server_url: "{{ .ADOBE_HEARTBEAT_TRACKING_SERVER_URL }}"
```

```bash
export RUDDER_ADOBE_TRACKING_SERVER_URL="..."
export RUDDER_ADOBE_MARKETING_CLOUD_ORG_ID="..."
export RUDDER_ADOBE_HEARTBEAT_TRACKING_SERVER_URL="..."
rudder-cli apply

# or
rudder-cli apply --var-file secrets.vars.yaml
```

Note that:

- `rudder-cli import` writes only the secrets the API returns, as `{{ .VAR }}` references, and leaves the others out. Add any secret key it leaves out, then supply the variables before you apply — see [Secrets](https://www.rudderstack.com/docs/rudder-cli/destination-types/#secrets).
- `tracking_server_secure_url` isn't a secret, though it often names the same host as `tracking_server_url`, so `rudder-cli import` writes it in plain text.
- In web `device` mode these values are embedded in the page's JavaScript, so masking them protects your YAML, not the values themselves.

See [How to Use Variable Substitution in Rudder CLI](https://www.rudderstack.com/docs/rudder-cli/variable-substitution/).

## Changes by release

<p>No changes since this type became available.</p>

For changes across every destination type, see [Destination Type Changes by Release](https://www.rudderstack.com/docs/rudder-cli/destination-types/changes/).

## See more

- [Adobe Analytics Setup Guide](https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/setting-up-adobe-analytics-in-rudderstack/) for the dashboard settings, identity resolution, timestamps, and mappings
- [Adobe Analytics Heartbeat Measurement](https://www.rudderstack.com/docs/destinations/streaming-destinations/adobe-analytics/adobe-analytics-heartbeat/) for the video events heartbeat tracking sends
- [Destination Type Reference for Rudder CLI](https://www.rudderstack.com/docs/rudder-cli/destination-types/) for the rules shared across destination types
- [Destination YAML Reference](https://www.rudderstack.com/docs/rudder-cli/yaml-destinations/) for the spec envelope