Advertising Schema

https://ns.adobe.com/xdm/context/advertising

The information related to advertising activity in relationship to the experience event.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stabilizing	No	Forbidden	Permitted	context/advertising.schema.json

Schema Hierarchy

Advertising https://ns.adobe.com/xdm/context/advertising
- Extensibility base schema https://ns.adobe.com/xdm/common/extensible
- MRC Viewability https://ns.adobe.com/xdm/context/adviewability
- Ad asset reference https://ns.adobe.com/xdm/context/advertising-timed-asset-reference
- Ad asset view details https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details
- Measure https://ns.adobe.com/xdm/data/measure

Advertising Example

{
  "xdm:adViewability": {
    "xdm:adUnitDepth": 0,
    "xdm:viewportHeight": 1250,
    "xdm:viewportWidth": 1600,
    "xdm:adHeight": 250,
    "xdm:adWidth": 300,
    "xdm:playerVolume": 85,
    "xdm:measurementEligible": true,
    "xdm:implementationDetails": {
      "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability",
      "xdm:version": "1"
    },
    "xdm:viewable": true,
    "xdm:activeWindow": true,
    "xdm:percentViewable": 89,
    "xdm:viewableFirstQuartile": {
      "xdm:value": 1
    }
  },
  "xdm:firstQuartiles": {
    "xdm:value": 1
  }
}

Advertising Properties

Property	Type	Required	Defined by
xdm:adAssetReference	Ad asset reference	Optional	Advertising (this schema)
xdm:adAssetViewDetails	Ad asset view details	Optional	Advertising (this schema)
xdm:adViewability	MRC Viewability	Optional	Advertising (this schema)
xdm:clicks	Measure	Optional	Advertising (this schema)
xdm:completes	Measure	Optional	Advertising (this schema)
xdm:conversions	Measure	Optional	Advertising (this schema)
xdm:federated	Measure	Optional	Advertising (this schema)
xdm:firstQuartiles	Measure	Optional	Advertising (this schema)
xdm:impressions	Measure	Optional	Advertising (this schema)
xdm:midpoints	Measure	Optional	Advertising (this schema)
xdm:starts	Measure	Optional	Advertising (this schema)
xdm:thirdQuartiles	Measure	Optional	Advertising (this schema)
xdm:timePlayed	Measure	Optional	Advertising (this schema)
`*`	any	Additional	this schema allows additional properties

xdm:adAssetReference

Ad asset reference

Asset information about the ad captured by the experience event.

xdm:adAssetReference

is optional
type: Ad asset reference
defined in this schema

xdm:adAssetReference Type

Ad asset reference – https://ns.adobe.com/xdm/context/advertising-timed-asset-reference

xdm:adAssetViewDetails

Ad asset view details

View details for the ad playback captured by the experience event.

xdm:adAssetViewDetails

is optional
type: Ad asset view details
defined in this schema

xdm:adAssetViewDetails Type

Ad asset view details – https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details

xdm:adViewability

MRC viewability

Media Rating Council (MRC) defines viewability as an online advertising metric that indicates the number of impressions that are actually “seen” by end-users. Viewability captures specific details such as player volume, library version, window status, and viewport ad measured dimensions.

xdm:adViewability

is optional
type: MRC Viewability
defined in this schema

xdm:adViewability Type

MRC Viewability – https://ns.adobe.com/xdm/context/adviewability

xdm:clicks

Click actions on an advertisement.

xdm:clicks

is optional
type: Measure
defined in this schema

xdm:clicks Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:completes

Completes

Indicates if a timed media asset was watched to completion but doesn't necessarily mean the end-user watched the whole video as the they could have skipped ahead.

xdm:completes

is optional
type: Measure
defined in this schema

xdm:completes Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:conversions

A customer pre-defined action or actions which triggers an event for performance evaluation.

xdm:conversions

is optional
type: Measure
defined in this schema

xdm:conversions Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:federated

Federated

Indicates if an experience event was created through data federation such as data sharing between customers.

xdm:federated

is optional
type: Measure
defined in this schema

xdm:federated Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:firstQuartiles

A digital video ad that has played through 25% of its duration at normal speed.

xdm:firstQuartiles

is optional
type: Measure
defined in this schema

xdm:firstQuartiles Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:impressions

Impression of an advertisement to a end-user with the potential of being viewed.

xdm:impressions

is optional
type: Measure
defined in this schema

xdm:impressions Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:midpoints

A digital video ad has played through 50% of its duration at normal speed.

xdm:midpoints

is optional
type: Measure
defined in this schema

xdm:midpoints Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:starts

A digital video ad has started playing.

xdm:starts

is optional
type: Measure
defined in this schema

xdm:starts Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:thirdQuartiles

A digital video ad has played through 75% of its duration at normal speed.

xdm:thirdQuartiles

is optional
type: Measure
defined in this schema

xdm:thirdQuartiles Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:timePlayed

Time spent

Describes the amount of time spent by an end-user on a specific timed media asset.

xdm:timePlayed

is optional
type: Measure
defined in this schema

xdm:timePlayed Type

Measure – https://ns.adobe.com/xdm/data/measure

Files

advertising.schema.md

Latest commit

History