Ad parameters

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

This section contains the following information:

Table data description:

  • Label: The name of the parameter.
  • 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: Initiate is the analytics call sent on video start, Ad Start is the analytics call sent on ad start, Chapter Start is the analytics call sent on chapter start, and Close is the compiled analytics call sent directly from the heartbeat server to the analytics server at the end of the media session, or the end of the ad. 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

Label

Implementation

Network Parameters

Reporting

Ad ID

  • 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"
  • 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

ID of the ad. (Any integer and/or letter combination)

* createAdObject(name, adId, position, length)

Ad In Pod Position

  • 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
  • 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

The position (index) of the ad inside the parent ad break. The first ad has index 0, the second ad has index 1, etc.

* createAdObject(name, adId, position, length)

Ad Length

  • 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"
  • 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

Length of video ad in seconds.

* createAdObject(name, adId, position, length)

Ad Player Name

  • 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", etc.
  • 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

The name of the player responsible for rendering the ad.

* MediaHeartbeatConfig.playerName

Ad Break Name

  • 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"
  • 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: videoadpod
  • Audience Manager: c_contextdata.a.media.ad.podFriendlyName

The friendly name of the Ad Break.

* createAdBreakObject(name, position, startTime)

Ad Break Index

  • SDK Key: position*
  • API Key: media.ad.podPosition
  • Required: Yes
  • Type: number
  • Sent with:
  • Min. SDK Version: Any
  • Sample value: 1
  • Adobe Analytics:

  • Heartbeat:

  • Available: No
  • Reserved Variable: N/A
  • Report Name: N/A
  • Context Data:
  • Data Feed:
  • Audience Manager:

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.

* createAdBreakObject(name, position, startTime)

Ad Break Position

  • 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
  • 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:
  • Audience Manager: c_contextdata.a.media.ad.podSecond

The offset of the ad break inside the content, in seconds.

* createAdBreakObject(name, position, startTime)

Ad Break ID

  • 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:

    l: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:
 

Ad Name

  • 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"
  • 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

Friendly name of the ad.

In reporting, "Ad Name" is the classification and "Ad Name (variable)" is the eVar.

* createAdObject(name, adId, position, length)

Standard Ad Metadata

Label

Implementation

Network Parameters

Reporting

Advertiser

  • 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:
  • 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

Company/Brand whose product is featured in the ad.

MediaHeartbeat.AdMetadataKeys

Campaign ID

  • 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).
  • 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

ID of the ad campaign.

MediaHeartbeat.AdMetadataKeys

Creative ID

  • 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).
  • 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

ID of the ad creative.

MediaHeartbeat.AdMetadataKeys

Site ID

  • 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:
  • 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:
  • Context Data: a.media.ad.site
  • Data Feed: N/A
  • Audience Manager: c_contextdata.a.media.ad.site

ID of the ad site.

MediaHeartbeat.AdMetadataKeys

Creative URL

  • 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:
  • Adobe Analytics:

    a.media.ad.creativeURL

  • Heartbeat:

    s:meta:a.media.ad.creativeURL

  • Available: Use custom processing rule
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name:
  • Context Data: a.media.ad.creativeURL
  • Data Feed: N/A
  • Audience Manager: c_contextdata.a.media.ad.creativeURL

URL of the ad creative.

MediaHeartbeat.AdMetadataKeys

Placement ID

  • 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:
  • 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:
  • Context Data: a.media.ad.placement
  • Data Feed: N/A
  • Audience Manager: c_contextdata.a.media.ad.placement

Placement ID of the ad.

MediaHeartbeat.AdMetadataKeys

Ad Metrics

Label

Implementation

Network Parameters

Reporting

Ad Start

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: Yes
  • Type: string
  • Sent with: Ad Start
  • Min. SDK Version: Any
  • Sample value: TRUE
  • 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: videoadstart
  • Context Data: a.media.ad.view
  • Audience Manager: c_contextdata.a.media.ad.view

Number of video ad starts.

Ad Complete

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: Yes
  • Type: string
  • Sent with: Ad Close
  • Min. SDK Version: Any
  • Sample value: TRUE
  • 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: videoadcomplete
  • Context Data: a.media.ad.complete
  • Audience Manager: c_contextdata.a.media.ad.complete

Number of video ad completes.

Ad Time Spent

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: Yes
  • Type: string
  • Sent with: Ad Close
  • Min. SDK Version: Any
  • Sample value: 15
  • Adobe Analytics:

    a.media.ad.timePlayed

  • Heartbeat:

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Ad Time Spent
  • Data Feed: videoadtime
  • Context Data: a.media.ad.timePlayed
  • Audience Manager: c_contextdata.a.media.ad.timePlayed

Release Date: 09/13/18

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.