Skip to content

Commit

Permalink
Adding viewability schema
Browse files Browse the repository at this point in the history
  • Loading branch information
gabebarcelos-adobe committed Apr 26, 2018
1 parent cac62a4 commit 48eec15
Show file tree
Hide file tree
Showing 6 changed files with 149 additions and 2 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "xdm",
"version": "0.9.0",
"version": "0.9.1",
"description": "Experience Data Models",
"main": "",
"config": {
"aem_user": "packageUser",
"aem_password": "override me securely",
"markdown-importer-version": "0.0.4",
"schemas": 137
"schemas": 138
},
"scripts": {
"clean": "rm -rf docs/reference",
Expand Down
13 changes: 13 additions & 0 deletions schemas/context/environment.example.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,19 @@
"xdm:viewportHeight": 900,
"xdm:viewportWidth": 1680
},
"xdm:viewabilityDetails": {
"xdm:windowDepth": 0,
"xdm:viewportHeight": 1250,
"xdm:viewportWidth": 1600,
"xdm:adHeight": 250,
"xdm:adWidth": 300,
"xdm:playerVolume": 85,
"xdm:viewabilityInstrumented": true,
"xdm:version": "1",
"xdm:viewable": true,
"xdm:activeWindow": true,
"xdm:percentViewable": 89
},
"xdm:operatingSystem": "MAC OS",
"xdm:operatingSystemVersion": "10.13",
"xdm:connectionType": "cable"
Expand Down
6 changes: 6 additions & 0 deletions schemas/context/environment.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@
"description":
"The browser specific details such as browser name, version, javascript version, user agent string, accept language."
},
"xdm:viewabilityDetails": {
"title": "Viewability Measurement Details",
"$ref": "https://ns.adobe.com/xdm/context/viewability-details",
"description":
"The runtime measured viewability specific details such as player volume, library version, window status, viewport/ad measured dimensions, etc."
},
"xdm:operatingSystem": {
"title": "Operating System",
"type": "string",
Expand Down
13 changes: 13 additions & 0 deletions schemas/context/experienceevent.example.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,19 @@
"xdm:viewportHeight": 900,
"xdm:viewportWidth": 1680
},
"xdm:viewabilityDetails": {
"xdm:windowDepth": 0,
"xdm:viewportHeight": 1250,
"xdm:viewportWidth": 1600,
"xdm:adHeight": 250,
"xdm:adWidth": 300,
"xdm:playerVolume": 85,
"xdm:viewabilityInstrumented": true,
"xdm:version": "1",
"xdm:viewable": true,
"xdm:activeWindow": true,
"xdm:percentViewable": 89
},
"xdm:operatingSystem": "MAC OS",
"xdm:operatingSystemVersion": "10.13",
"xdm:connectionType": "cable"
Expand Down
13 changes: 13 additions & 0 deletions schemas/context/viewability-details.example.1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"xdm:windowDepth": 0,
"xdm:viewportHeight": 1250,
"xdm:viewportWidth": 1600,
"xdm:adHeight": 250,
"xdm:adWidth": 300,
"xdm:playerVolume": 85,
"xdm:viewabilityInstrumented": true,
"xdm:version": "1",
"xdm:viewable": true,
"xdm:activeWindow": true,
"xdm:percentViewable": 89
}
102 changes: 102 additions & 0 deletions schemas/context/viewability-details.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
{
"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/viewability-details",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Viewability",
"type": "object",
"description":
"Description of viewability measured properties of an advertisement",
"definitions": {
"viewabilityDetails": {
"properties": {
"xdm:windowDepth": {
"title": "Window Depth",
"type": "integer",
"description":
"The number of iFrames the ad is displayed inside of.",
"minimum": 0
},
"xdm:viewportHeight": {
"title": "Viewport Height",
"type": "integer",
"description":
"The number of vertical pixels of the window the ad is displayed in as measured by the viewability library.",
"minimum": 0

},
"xdm:viewportWidth": {
"title": "Viewport Width",
"type": "integer",
"description":
"The number of horizontal pixels of the window the ad is displayed in as measured by the viewability library.",
"minimum": 0
},
"xdm:adHeight": {
"title": "Ad Height",
"type": "integer",
"description":
"The number of vertical pixels of the player as measured by the viewability library. 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 as measured by the viewability library. 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",
"type": "integer",
"description":
"The volume of the player was at video start.",
"minimum": 0,
"maximum": 100
},
"xdm:viewabilityInstrumented": {
"title": "Viewabiltity Measurement Instrumented",
"type": "boolean",
"description":
"Whether or not viewability was enabled on for this ad instance."
},
"xdm:version": {
"title": "Viewabiltity Library Version",
"type": "string",
"description":
"The version of the library instrumented to measure viewability metrics."
},
"xdm:viewable": {
"title": "Viewable Ad",
"type": "boolean",
"description":
"Indicates whether ad was measured as viewable during ad play."
},
"xdm:activeWindow": {
"title": "Active Window",
"type": "boolean",
"description":
"Indicates whether ad was shown on active window on users' browser."
},
"xdm:percentViewable": {
"title": "Percent Viewable",
"type": "integer",
"description":
"Percent of pixels in the ad deemed viewable at measurement time.",
"minimum": 0,
"maximum": 100
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/viewabilityDetails"
}
],
"meta:status": "experimental"
}

0 comments on commit 48eec15

Please sign in to comment.