Skip to content

Latest commit

 

History

History
329 lines (168 loc) · 5.74 KB

advertisingdetails.schema.md

File metadata and controls

329 lines (168 loc) · 5.74 KB
Raw

Advertising details information Schema

https://ns.adobe.com/xdm/datatypes/advertisingDetails

Advertising details information.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/advertisingdetails.schema.json

Advertising details information Example

{
  "xdm:name": "123456789",
  "xdm:length": 100,
  "xdm:podPosition": 1,
  "xdm:playerName": "playerName"
}

Advertising details information Properties

Property Type Required Defined by
xdm:name string Required Advertising details information (this schema)
xdm:advertiser string Optional Advertising details information (this schema)
xdm:campaignID string Optional Advertising details information (this schema)
xdm:creativeID string Optional Advertising details information (this schema)
xdm:creativeURL string Optional Advertising details information (this schema)
xdm:isCompleted boolean Optional Advertising details information (this schema)
xdm:isStarted boolean Optional Advertising details information (this schema)
xdm:length integer Required Advertising details information (this schema)
xdm:friendlyName string Optional Advertising details information (this schema)
xdm:placementID string Optional Advertising details information (this schema)
xdm:playerName string Required Advertising details information (this schema)
xdm:podPosition integer Required Advertising details information (this schema)
xdm:siteID string Optional Advertising details information (this schema)
xdm:timePlayed integer Optional Advertising details information (this schema)
* any Additional this schema allows additional properties

xdm:name

Ad ID

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

xdm:name

  • is required
  • type: string
  • defined in this schema

xdm:name Type

string

All instances must conform to this regular expression (test examples here):

^.{1,}$

xdm:advertiser

Ad Advertiser

Company/Brand whose product is featured in the ad.

xdm:advertiser

  • is optional
  • type: string
  • defined in this schema

xdm:advertiser Type

string

xdm:campaignID

Ad Campaign

ID of the ad campaign.

xdm:campaignID

  • is optional
  • type: string
  • defined in this schema

xdm:campaignID Type

string

xdm:creativeID

Ad Creative ID

ID of the ad creative.

xdm:creativeID

  • is optional
  • type: string
  • defined in this schema

xdm:creativeID Type

string

xdm:creativeURL

Ad Creative URL

URL of the ad creative.

xdm:creativeURL

  • is optional
  • type: string
  • defined in this schema

xdm:creativeURL Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:isCompleted

Ad Completed

Ad is completed.

xdm:isCompleted

  • is optional
  • type: boolean
  • defined in this schema

xdm:isCompleted Type

boolean

xdm:isStarted

Ad Started

Ad is started.

xdm:isStarted

  • is optional
  • type: boolean
  • defined in this schema

xdm:isStarted Type

boolean

xdm:length

Ad Length Or Duration

Length of video ad in seconds.

xdm:length

  • is required
  • type: integer
  • defined in this schema

xdm:length Type

integer

xdm:friendlyName

Ad Name

Friendly name of the ad. In reporting, “Ad Name” is the classification and “Ad Name (variable)” is the eVar.

xdm:friendlyName

  • is optional
  • type: string
  • defined in this schema

xdm:friendlyName Type

string

xdm:placementID

Ad Placement ID

Placement ID of the ad.

xdm:placementID

  • is optional
  • type: string
  • defined in this schema

xdm:placementID Type

string

xdm:playerName

Ad Player Name

The name of the player responsible for rendering the ad.

xdm:playerName

  • is required
  • type: string
  • defined in this schema

xdm:playerName Type

string

xdm:podPosition

Ad In Pod Position (Ad Start)

The index of the ad inside the parent ad start, for example, the first ad has index 0 and the second ad has index 1.

xdm:podPosition

  • is required
  • type: integer
  • defined in this schema

xdm:podPosition Type

integer

  • minimum value: 0

xdm:siteID

Ad Site ID

ID of the ad site.

xdm:siteID

  • is optional
  • type: string
  • defined in this schema

xdm:siteID Type

string

xdm:timePlayed

Ad Time Played

The total amount of time, in seconds, spent watching the ad (i.e., the number of seconds played).

xdm:timePlayed

  • is optional
  • type: integer
  • defined in this schema

xdm:timePlayed Type

integer