DocumentationAnalyticsStreaming Media Collection Guide

Ad parameters ad-parameters

Last update: Tue Oct 01 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
  • Admin
  • Developer

This topic presents a list of video ad data, including context data values, that Adobe collects via solution variables.

Table data description:

  • Implementation: Information on implementation values and requirements

    • Key - Variable, set either manually in your app, or automatically by the Adobe Media SDK.
    • Required - Indicates whether the parameter is required for basic video tracking.
    • Type - Specifies the type of the variable to be set, string or number.
    • Sent With - Indicates when the data is sent: Media Start is the analytics call sent on media start, Ad Start is the analytics call sent on ad start, and so on; the Close calls are the compiled analytics calls sent directly from the heartbeat server to the analytics server at the end of the media session, or the end of the ad, chapter, etc. The close calls are not available in network packet calls.
    • Min. SDK Version - Indicates which SDK version you would need to access the parameter.
    • Sample Value - Provides example of common variable usage.

  • Network Parameters: Displays the values that are passed to Adobe Analytics or Heartbeat servers. This column shows the names of the parameters that are seen in the network calls generated by Adobe Media SDKs.

  • Reporting: Information on how to view and analyze the video data.

    • Available - Indicates whether the data is available in reporting by default (Yes), or requires custom set-up (Custom)
    • Reserved Variable - Indicates whether the data is captured as an event, eVar, prop, or classification in a reserved variable.
    • Report Name - Name of Adobe Aanlytics report for variable
    • Context Data - Name of the Adobe Analytics context data passed to the reporting server and used in processing rules.
    • Data Feed - Column name for variable found in Clickstream or Live Stream data feeds
    • Audience Manager - Trait name found in Adobe Audience Manager
IMPORTANT
Do not change the classification names for any variables listed below that are
described under Reporting/Reserved Variable as “classification”.
The media classifications are defined when a report suite is enabled for media
tracking. From time to time, Adobe adds new properties, and, when this occurs,
customers must re-enable their report suites to get access to the new media
properties. During the update process Adobe determines whether the
classifications are enabled by checking the names of the variables. If any of
them is missing, Adobe adds the missing ones again.

Ad Video Data ad-video-data

Ad ID

Implementation
Network Parameters
Reporting
  • SDK Key:
    adId
  • API Key:
    media.ad.id
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    “2125”
  • Description:
    ID of the ad. (Any integer and/or letter combination)
  • Adobe Analytics:
    (a.media.ad.
    name)
  • Heartbeat:
    (s:asset:ad_id)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On VISIT
  • Report Name:
    Ad
  • Context Data:
    (a.media.ad.
    name)
  • Data Feed:
    videoad
  • Audience Manager:
    (c_contextdata.
    a.media.ad.name)
  • XDM Field Path:
    advertising.adAssetReference.@id
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.name
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.name

Ad In Pod Position

Implementation
Network Parameters
Reporting
  • SDK Key:
    position
  • API Key:
    media.ad.podPosition
  • Required:
    Yes
  • Type:
    number
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    1
  • Description:
    The position (index) of the ad inside the parent ad break. The first ad has index 0, the second ad has index 1, etc.
  • Adobe Analytics:
    (a.media.ad.
    podPosition)
  • Heartbeat:
    (s:asset:pod_position)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Ad In Pod Position
  • Context Data:
    (a.media.ad.
    podPosition)
  • Data Feed:
    videoadinpod
  • Audience Manager:
    (c_contextdata.
    a.media.ad.podPosition)
  • XDM Field Path:
    advertising.adAssetViewDetails.index
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.podPosition
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.podPosition

Ad Length

Implementation
Network Parameters
Reporting
  • SDK Key:
    length
  • API Key:
    media.ad.length
  • Required:
    Yes
  • Type:
    number
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.1
  • Sample Value:
    “15”
  • Description:
    Length of video ad in seconds.
  • Adobe Analytics:
    (a.media.ad.
    length)
  • Heartbeat:
    (l:asset:ad_length)
  • Available:
    Yes
  • Reserved Variable:
    eVar and classification
  • Expiration:
    On HIT
  • Report Name:
    Ad Length and Ad Length (variable)
  • Context Data:
    (a.media.ad.
    length)
  • Data Feed:
    videoadlength
  • Audience Manager:
    (c_contextdata.
    a.media.ad.length)
  • XDM Field Path:
    advertising.adAssetReference.
    xmpDM:duration
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.length
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.length

Ad Player Name

Implementation
Network Parameters
Reporting
  • SDK Key:
    playerName
  • API Key:
    media.ad.playerName
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    “Freewheel”
  • Description:
    The name of the player responsible for rendering the ad.
  • Adobe Analytics:
    (a.media.ad.
    playerName)
  • Heartbeat:
    (s:sp:player_name)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Ad Player Name
  • Context Data:
    (a.media.ad.
    playerName)
  • Data Feed:
    videoadplayername
  • Audience Manager:
    (c_contextdata.
    a.media.ad.playerName)
  • XDM Field Path:
    advertising.adAssetViewDetails.playerName
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.
    playerName
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.
    playerName

Ad Break Name

Implementation
Network Parameters
Reporting
  • SDK Key:
    name
  • API Key:
    media.ad.podFriendlyName
  • Required:
    SDK: Yes; API: No.
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    “pre-roll”
  • Description:
    The friendly name of the Ad Break.
  • Adobe Analytics:
    (a.media.ad.
    podFriendlyName)
  • Heartbeat:
    (s:asset:pod_name)
  • Available:
    Yes
  • Reserved Variable:
    Classification
  • Report Name:
    Pod Name
  • Context Data:
    (a.media.ad.
    podFriendlyName)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.ad.podFriendlyName)
  • XDM Field Path:
    advertising.adAssetViewDetails.
    adBreak.dc:title
  • Collection XDM Field Path:
    mediaCollection.advertisingPodDetails.
    friendlyName
  • Reporting XDM Field Path:
    mediaReporting.advertisingPodDetails.
    friendlyName

Ad Break Index

Implementation
Network Parameters
Reporting
  • SDK Key:
    position
  • API Key:
    media.ad.podIndex
  • Required:
    Yes
  • Type:
    number
  • Sent with:
  • Min. SDK Version: Any
  • Sample Value:
    1
  • Description:
    The index of the ad break inside the content starting at 1. This property is used only by the Media SDK to generate the Pod ID.
  • Adobe Analytics:
  • Heartbeat:
  • Available:
    No
  • Reserved Variable:
    N/A
  • Report Name:
    N/A
  • Context Data:
  • Data Feed:
    N/A
  • Audience Manager:
  • XDM Field Path:
    advertising.adAssetViewDetails.index
  • Collection XDM Field Path:
    mediaCollection.advertisingPodDetails.index

Ad Break Position

Implementation
Network Parameters
Reporting
  • SDK Key:
    startTime
  • API Key:
    media.ad.podSecond
  • Required:
    Yes
  • Type:
    number
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    90
  • Description:
    The offset of the ad break inside the content, in seconds.
  • Adobe Analytics:
    (a.media.ad.
    podSecond)
  • Heartbeat:
    (l:asset:pod_offset)
  • Available:
    Yes
  • Reserved Variable:
    Classification
  • Report Name:
    Pod Position
  • Context Data:
    (a.media.ad.
    podSecond)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.ad.podSecond)
  • XDM Field Path:
    advertising.adAssetViewDetails.adBreak.
    offset
  • Collection XDM Field Path:
    mediaCollection.advertisingPodDetails.
    offset
  • Reporting XDM Field Path:
    mediaReporting.advertisingPodDetails.
    offset

Ad Break ID

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    c4a577424c84067899b807c76722d495_1
  • Adobe Analytics:
    (a.media.ad.
    pod)
  • Heartbeat:
    (s:asset:pod_id)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Ad Pod
  • Context Data:
    (a.media.ad.
    pod)
  • Data Feed:
    videoadpod
  • Audience Manager:
  • XDM Field Path:
    advertising.adAssetViewDetails.adBreak.@id
  • Reporting XDM Field Path:
    mediaReporting.advertisingPodDetails.
    ID

Ad Name

Implementation
Network Parameters
Reporting
  • SDK Key:
    name
  • API Key:
    media.ad.name
  • Required:
    No
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.1
  • Sample Value:
    “Ford F-150”
  • Description:
    Friendly name of the ad. In reporting, “Ad Name” is the classification and “Ad Name (variable)” is the eVar.
  • Adobe Analytics:
    (a.media.ad.
    friendlyName)
  • Heartbeat:
    (s:asset:ad_name)
  • Available:
    Yes
  • Reserved Variable:
    eVar and classification
  • Expiration:
    On HIT
  • Report Name:
    Ad Name and Ad Name (variable)
  • Context Data:
    (a.media.ad.
    friendlyName)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.ad.friendlyName)
  • XDM Field Path:
    advertising.adAssetReference.dc:title
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.friendlyName
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.friendlyName

Standard Ad Metadata standard-ad-metadata

Advertiser

Implementation
Network Parameters
Reporting
  • SDK Key:
    ADVERTISER
  • API Key:
    media.ad.advertiser
  • Required:
    No
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.7
  • Sample Value:
  • Description:
    Company/Brand whose product is featured in the ad.
  • Adobe Analytics:
    (a.media.ad.
    advertiser)
  • Heartbeat:
    (s:meta:
    a.media.ad.advertiser)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Advertiser
  • Context Data:
    (a.media.ad.
    advertiser)
  • Data Feed:
    videoadvertiser
  • Audience Manager:
    (c_contextdata.
    a.media.ad.advertiser)
  • XDM Field Path:
    advertising.adAssetReference.advertiser
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.advertiser
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.advertiser

Campaign ID

Implementation
Network Parameters
Reporting
  • SDK Key:
    CAMPAIGN_ID
  • API Key:
    media.ad.campaignId
  • Required:
    No
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.7
  • Sample Value:
    Integer, or name (string).
  • Description:
    ID of the ad campaign.
  • Adobe Analytics:
    (a.media.ad.
    campaign)
  • Heartbeat:
    (s:meta:
    a.media.ad.campaign)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Campaign ID
  • Context Data:
    (a.media.ad.
    campaign)
  • Data Feed:
    videocampaign
  • Audience Manager:
    (c_contextdata.
    a.media.ad.campaign)
  • XDM Field Path:
    advertising.adAssetReference.campaign
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.
    campaignID
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.
    campaignID

Creative ID

Implementation
Network Parameters
Reporting
  • SDK Key:
    CREATIVE_ID
  • API Key:
    media.ad.creativeId
  • Required:
    No
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.7
  • Sample Value:
    Integer, or name (string).
  • Description:
    ID of the ad creative.
  • Adobe Analytics:
    (a.media.ad.
    creative)
  • Heartbeat:
    (s:meta:
    a.media.ad.creative)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Creative ID
  • Context Data:
    (a.media.ad.
    creative)
  • Data Feed:
    adclassificationcreative
  • Audience Manager:
    (c_contextdata.
    a.media.ad.creative)
  • XDM Field Path:
    advertising.adAssetReference.creativeID
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.creativeID
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.creativeID

Site ID

Implementation
Network Parameters
Reporting
  • SDK Key:
    SITE_ID
  • API Key:
    media.ad.siteId
  • Required:
    No
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.7
  • Sample Value:
  • Description:
    ID of the ad site.
  • Adobe Analytics:
    (a.media.ad.
    site)
  • Heartbeat:
    (s:meta:
    a.media.ad.site)
  • Available:
    Use custom processing rule
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Custom
  • Context Data:
    (a.media.ad.
    site)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.ad.site)
  • XDM Field Path:
    advertising.adAssetReference.siteID
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.siteID
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.siteID

Creative URL

Implementation
Network Parameters
Reporting
  • SDK Key:
    CREATIVE_URL
  • API Key:
    media.ad.creativeURL
  • Required:
    No
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.7
  • Sample Value:
  • Description:
    URL of the ad creative.
  • Adobe Analytics:
    (a.media.ad.
    creativeURL)
  • Heartbeat:
    (s:meta:<c/ode> a.media.ad.creativeURL) ``
  • Available:
    Use custom processing rule
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Custom
  • Context Data:
    (a.media.ad.
    creativeURL)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.ad.creativeURL)
  • XDM Field Path:
    advertising.adAssetReference.creativeURL
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.
    creativeURL
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.
    creativeURL

Placement ID

Implementation
Network Parameters
Reporting
  • SDK Key:
    PLACEMENT_ID
  • API Key:
    media.ad.placementId
  • Required:
    No
  • Type:
    string
  • Sent with:
    Ad Start, Ad Close
  • Min. SDK Version: 1.5.7
  • Sample Value:
  • Description:
    Placement ID of the ad.
  • Adobe Analytics:
    (a.media.ad.
    placement)
  • Heartbeat:
    (s:meta:
    a.media.ad.placement)
  • Available:
    Use custom processing rule
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Custom
  • Context Data:
    (a.media.ad.
    placement)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.ad.placement)
  • XDM Field Path:
    advertising.adAssetReference.placementID
  • Collection XDM Field Path:
    mediaCollection.advertisingDetails.
    placementID
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.
    placementID

Ad Metrics ad-metrics

Ad Start

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Ad Start
  • Min. SDK Version: Any
  • Sample Value:
    TRUE
  • Description:
    Number of video ad starts.
  • Adobe Analytics:
    (a.media.ad.
    view)
  • Heartbeat:
    (s:event:type=start)
    (s:asset:type=ad) ``
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Ad Starts
  • Data Feed:
    N/A
  • Context Data:
    (a.media.ad.
    view)
  • Audience Manager:
    (c_contextdata.
    a.media.ad.view)
  • XDM Field Path:
    advertising.starts.value > 0 => “TRUE”
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.isStarted

Ad Complete

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    TRUE
  • Description:
    Number of video ad completes.
  • Adobe Analytics:
    (a.media.ad.
    complete)
  • Heartbeat:
    (s:event:type=complete)
    (s:asset:type=ad)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Ad Completes
  • Data Feed:
    N/A
  • Context Data:
    (a.media.ad.
    complete)
  • Audience Manager:
    (c_contextdata.
    a.media.ad.complete)
  • XDM Field Path:
    advertising.completes.value > 0 => “TRUE”
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.
    isCompleted

Ad Time Spent

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Ad Close
  • Min. SDK Version: Any
  • Sample Value:
    15
  • Description:
    The total amount of time, in seconds, spent watching the ad (i.e., the number of seconds played). The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
    Release Date: 09/13/18
  • Adobe Analytics:
    (a.media.ad.
    timePlayed)
  • Heartbeat:
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Ad Time Spent
  • Data Feed:
    N/A
  • Context Data:
    (a.media.ad.
    timePlayed)
  • Audience Manager:
    (c_contextdata.
    a.media.ad.timePlayed)
  • XDM Field Path:
    advertising.timePlayed.value
  • Reporting XDM Field Path:
    mediaReporting.advertisingDetails.
    timePlayed

createAdObject APIs:

createAdBreakObject APIs:

MediaHeartbeatConfig APIs:

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb