DocumentationAnalyticsMedia Analytics Guide

Request parameters request-parameters

Last update: Fri Nov 11 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
  • Admin
  • Developer

Analytics Data

Request Key
Required
Request Type Key
Set On…
Description
analytics.trackingServer
Y
string
sessionStart
The URL of your Adobe Analytics server
analytics.reportSuite
Y
string
sessionStart
The ID that identifies your Analytics reporting data
analytics.enableSSL
N
boolean
sessionStart
True or false for enabling SSL
analytics.visitorId
N
string
sessionStart
The Adobe Visitor ID is a custom ID you can use across multiple Adobe applications. The Heartbeat visitorId equals the Analytics VID.

Visitor Data

Request Key
Required
Request Type Key
Set On…
Description
visitor.marketingCloudOrgId
Y
string
sessionStart
The Experience Cloud Organization ID; identifies your organization within the Adobe Experience Cloud eco system
visitor.marketingCloudUserId
N
string
sessionStart
This is the Experience Cloud User ID (ECID). In most scenarios this is the ID you should use to identify a user. The Heartbeat marketingCloudUserId equals the MID in Adobe Analytics. While not technically required, this parameter is necessary for accessing the Experience Cloud family of apps.
visitor.aamLocationHint
N
integer
sessionStart
Provides Adobe Audience Manager Edge data — If a value is not entered, the value is null.
appInstallationId
N
string
sessionStart
The appInstallationId uniquely identifies the app and the device

Content Data

Request Key
Required
Request Type Key
Set On…
Description
media.id
Y
string
sessionStart
Unique identifer for the content
media.name
N
string
sessionStart
Human readible name for the content
media.length
Y
number
sessionStart
Content length (seconds)
media.contentType
Y
string
sessionStart
Format of the stream (can be any string, a few recommanded values are “Live”, “VOD”, or “Linear”)
media.playerName
Y
string
sessionStart
The name of the player responsible for rendering the content
media.channel
Y
string
sessionStart
The channel of distribution of the content. This could be an mobile application name or a web site name, property name
media.resume
N
boolean
sessionStart
Indicates whether or not a user is resuming a previous session (as opposed to starting a new session)
media.sdkVersion
N
string
sessionStart
The SDK verison used by the player

Content Standard Metadata

Request Key
Required
Request Type Key
Set On…
Description
media.streamFormat
N
string
sessionStart
Stream format, e.g. “HD”
media.show
N
string
sessionStart
The program or series name
media.season
N
string
sessionStart
The season number the show or series belongs to
media.episode
N
string
sessionStart
The number of the episode
media.assetId
N
string
sessionStart
The unique identifier for the content of the video asset, such as the TV series episode identifier, movie asset identifier, or live event identifier. Typically these IDs are derived from metadata authorities such as EIDR, TMS/Gracenote, or Rovi. These identifiers can also be from other proprietary or in-house systems.
media.genre
N
string
sessionStart
The type of content as defined by the content producer
media.firstAirDate
N
string
sessionStart
The date when the content first aired on television
media.firstDigitalDate
N
string
sessionStart
The date when the content first aired on any digital platform
media.rating
N
string
sessionStart
The rating as defined by TV Parental Guidelines
media.originator
N
string
sessionStart
The creator of the content
media.network
N
string
sessionStart
The network / channel name
media.showType
N
string
sessionStart

The type of content, expressed as an integer between 0 and 3:

  • 0 - Full episode
  • 1 - Preview
  • 2 - Clip
  • 3 - Other
media.adLoad
N
string
sessionStart
The type of ad loaded
media.pass.mvpd
N
string
sessionStart
The MVPD provided by Adobe authentication
media.pass.auth
N
string
sessionStart
Indicates the user has been authorized by Adobe authentication (can only be true if set)
media.dayPart
N
string
sessionStart
The time of day when the content was broadcast
media.feed
N
string
sessionStart
The type of feed, e.g., “West-HD”

Ad Data

Request Key
Required
Request Type Key
Set On…
Description
media.ad.podFriendlyName
N
string
adBreakStart
Friendly name of the ad break
media.ad.podIndex
Y
integer
adBreakStart
The index of the ad pod in the video
media.ad.podSecond
Y
number
adBreakStart
The second at which the pod started
media.ad.podPosition
Y
integer
adStart
The index of the ad inside the ad break starting at 1
media.ad.name
N
string
adStart
Friendly name of the ad
media.ad.id
Y
string
adStart
Name of the ad
media.ad.length
Y
number
adStart
Length of the video ad in seconds
media.ad.playerName
Y
string
adStart
The name of the player responsible for rendering the ad

Ad Standard Metadata

Request Key
Required
Request Type Key
Set On…
Description
media.ad.advertiser
N
string
adStart
The company or brand whose product is featured in the ad
media.ad.campaignId
N
string
adStart
The ID of the ad campaign
media.ad.creativeId
N
string
adStart
The ID of the ad creative
media.ad.siteId
N
string
adStart
The ID of the ad site
media.ad.creativeURL
N
string
adStart
The URL of the ad creative
media.ad.placementId
N
string
adStart
The placement ID of the ad

Chapter Data

Request Key
Required
Request Type Key
Set On…
Description
media.chapter.index
Y
integer
chapterStart
Identifies the chapter’s position in the content
media.chapter.offset
Y
number
chapterStart
The second in the playback where the chapter starts
media.chapter.length
Y
number
chapterStart
The length of the chapter in seconds
media.chapter.friendlyName
N
string
chapterStart
The human-friendly name of the chapter

Quality Data

Request Key
Required
Request Type Key
Set On…
Description
media.qoe.bitrate
N
integer
Any
The average bitrate (in bps). The Average Bitrate is computed as a weighted average of all bitrate values related to the play duration that occurred during a playback session.
media.qoe.droppedFrames
N
integer
Any
The number of dropped frames in the stream
media.qoe.framesPerSecond
N
integer
Any
The number of frames per second
media.qoe.timeToStart
N
integer
Any
The amount of time (in milliseconds) passed between when the user hits play and the content loads and starts playing

California Consumer Privacy Act (CCPA) Parameters ccpa-params

Request Key
Required
Request Type Key
Set On…
Description
analytics.optOutServerSideForwarding
N
boolean
sessionStart
Set to true when the end user has opted out of their data being shared between Adobe Analytics and other Experience Cloud solutions (e.g., Audience Manager)
analytics.optOutShare
N
boolean
sessionStart
Set to true when the end user has opted out of their data being federated (e.g., to other Adobe Analytics clients).

Additional Details additional-details

visitor.marketingCloudUserId

Pass the Experience Cloud User ID (also known as the MID or MCID) on the sessionStart call by including it inside the params map using the following key: visitor.marketingCloudUserId. This is a useful feature if you already integrate with other Experience Cloud products and have already obtained the MCID.

NOTE
Media Analytics (MA) is integrated with the Experience Cloud family of apps (Adobe Analytics, Audience Manager, Target, and so on). You need an Experience Cloud ID to access these apps. The ECID is what you should use to identify users in most scenarios.

appInstallationId

  • If you do not pass an appInstallationId value - The MA back-end will no longer generate a MCID, but instead will rely on Adobe Analytics to do this. Adobe’s recommendation is to either send a MCID if available, or an appInstallationId (along with the still mandatory marketingCloudOrgId) so that the Media Collection API generates the MCID and sends it on all calls.

  • If you do pass appInstallationId value - The MCID can be generated by the MA back-end, if you pass values for appInstallationId and the (required) marketingCloudOrgId parameters. If you do pass appInstallationId yourself, you must persist its value on the client side. It must be unique to the app on a device, and must be persistent for as long as the app is not re-installed.

NOTE
The appInstallationId uniquely identifies the app and the device. It needs to be unique for each app on each device, i.e., two users using the same version of the same app on different devices must each send a different (unique) appInstallationId.

visitor.marketingCloudOrgId

In addition to being necessary for MCID generation when that is not provided, this parameter is also used as the value for the publisher ID (based on which Media Analytics performs federation rule matching.)

Analytics Legacy User ID (aid) and Declared User IDs (customerIDs)

  • analytics.aid:

    The value of this key must be a string that represents the Analytics Legacy User ID

  • visitor.customerIDs:

    The value of this key must be an object of the following format:

    code language-js 
    "<<insert your ID name here>>": {
  "id": " <<insert your id here>>",
   "authState": <<insert one of 0, 1, 2>>
}

Note that the visitor.customerIDs value can have any number of objects in the presented format.

visitor.aamLocationHint

This parameter indicates which Adobe Audience Manager (AAM) Edge would be hit when Adobe Analytics sends the customer data to Audience Manager. If a value is not entered, the value is null. This is particularly important when end users tend to use their devices in geographically distant locations (e.g., US-East, US-West, Europe, Asia). Otherwise, user data will be spread across multiple AAM Edges.

media.resume

If the app determines that a session was closed and then resumed at a later time, e.g., the user left the video but eventually came back, and the player resumed the video from the playhead where it was stopped, you can send an optional boolean media.resume parameter inside the params bucket of the sessionStart call.

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