advertising.schema.json

{
    "meta:license": [
        "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/context/advertising",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Advertising",
    "type": "object",
    "description": "The information related to advertising activity in relationship to the experience event.",
    "meta:extensible": true,
    "definitions": {
        "advertising": {
            "properties": {
                "xdm:adViewability": {
                    "title": "MRC viewability",
                    "$ref": "https://ns.adobe.com/xdm/context/adviewability",
                    "description": "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:adAssetReference": {
                    "title": "Ad asset reference",
                    "description": "Asset information about the ad captured by the experience event.",
                    "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference"
                },
                "xdm:adAssetViewDetails": {
                    "title": "Ad asset view details",
                    "description": "View details for the ad playback captured by the experience event.",
                    "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details"
                },
                "xdm:completes": {
                    "title": "Ad completes",
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "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:timePlayed": {
                    "title": "Ad time spent",
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Describes the amount of time spent by an end-user on a specific timed media asset."
                },
                "xdm:federated": {
                    "title": "Ad federated",
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Indicates if an experience event was created through data federation such as data sharing between customers."
                },
                "xdm:downloadedPlayback": {
                    "title": "Ad downloaded flag",
                    "type": "boolean",
                    "description": "Set to true when the hit is generated due to playing a downloaded ad session."
                },
                "xdm:clicks": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Click actions on an advertisement."
                },
                "xdm:conversions": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "A customer pre-defined action or actions which triggers an event for performance evaluation."
                },
                "xdm:firstQuartiles": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "A digital video ad that has played through 25% of its duration at normal speed."
                },
                "xdm:impressions": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Impression of an advertisement to a end-user with the potential of being viewed."
                },
                "xdm:midpoints": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "A digital video ad has played through 50% of its duration at normal speed."
                },
                "xdm:starts": {
                    "title": "Ad starts",
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "A digital video ad has started playing."
                },
                "xdm:thirdQuartiles": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "A digital video ad has played through 75% of its duration at normal speed."
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/advertising"
        }
    ],
    "meta:status": "stable",
    "examples": [
        {
            "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:adAssetReference": {
                "@id": "https://data.adobe.io/entities/ad-id/AD1",
                "xdm:creativeID": "6738737",
                "dc:title": "adNumber2",
                "xdm:advertiser": "Sample advertiser",
                "xdm:campaign": "Sample campaign",
                "xmpDM:duration": 10,
                "xdm:creativeURL": "www.creative.com",
                "xdm:siteID": "www.ad-site.com",
                "xdm:placementID": "www.place.org"
            },
            "xdm:firstQuartiles": {
                "xdm:value": 1
            }
        }
    ]
}