xdm/docs/reference/datatypes/adviewability.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
{
    "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/adviewability",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "MRC Viewability",
    "type": "object",
    "meta:extensible": true,
    "description": "Browser environment measured at runtime describing the viewability of an advertisement or content associated with each page load.\n\nAccording to [IAB/MRC definition](https://www.iab.com/wp-content/uploads/2015/06/MRC-Viewable-Ad-Impression-Measurement-Guideline.pdf) of Viewable Browser Space is defined as: \n\n> Advertisements and content associated with each\npage load can appear either within or outside the viewable space of the browser\non a user’s screen—i.e., that part of the page within the browser that a user can\nsee. This is similar to the concepts once referred to as “Above the Fold” (i.e.,\nwithin the viewable browser space) and “Below the Fold” (i.e., outside the\nviewable browser space). The “fold” was traditionally considered to be where the\ninitially-loaded viewable space of the page ends – so advertisements and content\nabove the fold were considered likely to be viewable upon load, and for content\nbelow the fold, it was considered necessary to scroll to in order for that content to\nbe viewable. In reality, the location of the fold, and consequently the viewable\nstatus of advertising and content, is variable based on the browser settings of the\nuser (resolution, font size, window size, etc.) and there are generally four\nlocations (top, bottom, left and right sides) where advertising and content may be\ncut-off from being viewable based on user actions and settings. Upon initial page\nload, advertising or content placed at the top and left side of the page is most \nlikely to be viewable, however this can change if content or ads are obscured by\noverlays or with further user action (scrolling) coupled with latency; therefore,\nplacement and viewable status are separate attributes to be assessed.\n\nViewability details are always measured fields during runtime.\n\n>Note regarding the applicability of these guidelines for mobile viewable ad\n impression measurement: While these viewability guidelines are primarily\n designed for desktop browser-based advertising rather than mobile advertising,\n the following points should be noted: 1) measurers of viewability of mobile\n browser-based web ads are encouraged to consider these guidelines in\n measurements until such time as guidance specifically designed for the\n measurement of viewability in mobile web based ads is created; and 2) as noted\n in the [Mobile Application Advertising Measurement Guidelines issued by IAB,\n MMA and MRC in July 2013](http://www.iab.net/inappguidelines), ad impressions\n served in an in-application environment are currently generally assumed to be\n viewable.\n\n\n\n",
    "definitions": {
        "adviewability": {
            "properties": {
                "xdm:adUnitDepth": {
                    "title": "Ad Unit Depth",
                    "type": "integer",
                    "description": "Publishers may embed ad units inside containers/iFrames in order limit the ad's access solely to the code of the page. This describes how many 'containers' or iFrames the ad unit is displayed inside of.",
                    "minimum": 0
                },
                "xdm:viewportHeight": {
                    "title": "Viewport Height",
                    "type": "integer",
                    "description": "The vertical size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport height.",
                    "minimum": 0
                },
                "xdm:viewportWidth": {
                    "title": "Viewport Width",
                    "type": "integer",
                    "description": "The horizontal size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport width.",
                    "minimum": 0
                },
                "xdm:adHeight": {
                    "title": "Ad Height",
                    "type": "integer",
                    "description": "The number of vertical pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.",
                    "minimum": 0
                },
                "xdm:adWidth": {
                    "title": "Ad Width",
                    "type": "integer",
                    "description": "The number of horizontal pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.",
                    "minimum": 0
                },
                "xdm:playerVolume": {
                    "title": "Player Volume Percentage",
                    "type": "integer",
                    "description": "The player volume percentage, measured at runtime where 0 is muted and 100 is maximum volume.",
                    "minimum": 0,
                    "maximum": 100
                },
                "xdm:measurementEligible": {
                    "title": "Viewability Measurement Eligible",
                    "type": "boolean",
                    "description": "Whether or not the ad was eligible to viewability measurement. An ad is eligible if the unit has a supported creative format and tag type."
                },
                "xdm:implementationDetails": {
                    "title": "Viewabiltity Implementation Details",
                    "$ref": "https://ns.adobe.com/xdm/context/implementationdetails",
                    "description": "The name and version of the library instrumented to measure viewability metrics."
                },
                "xdm:viewable": {
                    "title": "Viewable Ad",
                    "type": "boolean",
                    "description": "Display ads are considered viewable when at least 50% of the ad is visible for at least 1 second. Video ads are considered viewable when at least 50% of the ad is visible while the video is playing for at least 2 consecutive seconds. All viewable ads are measurable, because you can't confirm that an ad has met the criteria for viewability unless it can be measured."
                },
                "xdm:activeWindow": {
                    "title": "Active Window",
                    "type": "boolean",
                    "description": "Indicates whether ad was shown on active window on users' device."
                },
                "xdm:percentViewable": {
                    "title": "Percent Viewable",
                    "type": "integer",
                    "description": "Percent of pixels in the ad deemed viewable at measurement time.",
                    "minimum": 0,
                    "maximum": 100
                },
                "xdm:viewabilityEligibleImpressions": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Impression(s) of an advertisement to an end-user with viewablility library instrumented."
                },
                "xdm:measuredAdNotVisible": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Indicator of ad not being visible as measured by a viewability library at impression time."
                },
                "xdm:measuredMuted": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Indicator of ad being muted as measured by a viewability library at impression time."
                },
                "xdm:measuredWindowInactive": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Indicator of ad being displayed in an inactive window as measured by a viewability library at impression time."
                },
                "xdm:unmeasurableIframe": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Indicator of viewability library not being able to properly execute measurements due to ad being displayed inside an iframe."
                },
                "xdm:unmeasurableOther": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Indicator of viewability library not being able to properly execute measurements due to non-predefined error."
                },
                "xdm:viewableCompletes": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Completion(s) of an advertisement to an end-user deemed viewable at completion time by a viewability library."
                },
                "xdm:viewableFirstQuartiles": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "First quartile(s) of an advertisement to an end-user deemed viewable at first quartile of play by a viewability library."
                },
                "xdm:viewableImpressions": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Impressions of an advertisement to an end-user deemed viewable after two seconds of play by a viewability library."
                },
                "xdm:viewableMidpoints": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Midpoint(s) of an advertisement to an end-user deemed viewable at midpoint of play by a viewability library."
                },
                "xdm:viewableThirdQuartiles": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Third quartile(s) of an advertisement to an end-user deemed viewable at third quartile of play by a viewability library."
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/adviewability"
        }
    ],
    "meta:status": "stable",
    "examples": [
        {
            "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:viewableImpressions": {
                "xdm:value": 1
            }
        }
    ]
}