Skip to content

Commit

Permalink
proposal #1
Browse files Browse the repository at this point in the history
* no metric definitions
  • Loading branch information
Cosmin Ciobanu committed Jun 20, 2018
1 parent 9c96017 commit 914f0b7
Show file tree
Hide file tree
Showing 22 changed files with 1,216 additions and 23 deletions.
23 changes: 8 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,19 @@
"aem_user": "packageUser",
"aem_password": "override me securely",
"markdown-importer-version": "0.0.4",
"schemas": 173
"schemas": 202
},
"scripts": {
"clean": "rm -rf docs/reference",
"markdown":
"shx mkdir -p docs/reference && jsonschema2md -o docs/reference -d schemas --link-abstract abstract.md --link-extensible extensions.md --link-status status.md --link-id id.md --link-custom extensions.md --link-additional extensions.md",
"markdown": "shx mkdir -p docs/reference && jsonschema2md -o docs/reference -d schemas --link-abstract abstract.md --link-extensible extensions.md --link-status status.md --link-id id.md --link-custom extensions.md --link-additional extensions.md",
"test": "mocha",
"lint":
"prettier --write *.json CHANGELOG.md CONTRIBUTING.md README.md docs/*.md schemas/*/**/*.md schemas/*/**/*.json extensions/*/**/*.json && git diff --exit-code",
"lint": "prettier --write *.json CHANGELOG.md CONTRIBUTING.md README.md docs/*.md schemas/*/**/*.md schemas/*/**/*.json extensions/*/**/*.json && git diff --exit-code",
"lint-quick": "pretty-quick",
"package":
"npm run markdown && curl -o \"./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar\" -C - https://artifactory.corp.adobe.com/artifactory/maven-markdown-tools-release/io/adobe/udp/markdown-importer/0.0.4/markdown-importer-0.0.4-jar-with-dependencies.jar && java -jar ./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar markdown2aem.yaml",
"upload":
"curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-stage.adobemsbasic.com/crx/packmgr/service.jsp",
"upload:prod":
"curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-prod.adobemsbasic.com/crx/packmgr/service.jsp",
"activate":
"curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-stage.adobemsbasic.com/etc/replication/treeactivation.html",
"activate:prod":
"curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-prod.adobemsbasic.com/etc/replication/treeactivation.html",
"package": "npm run markdown && curl -o \"./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar\" -C - https://artifactory.corp.adobe.com/artifactory/maven-markdown-tools-release/io/adobe/udp/markdown-importer/0.0.4/markdown-importer-0.0.4-jar-with-dependencies.jar && java -jar ./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar markdown2aem.yaml",
"upload": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-stage.adobemsbasic.com/crx/packmgr/service.jsp",
"upload:prod": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-prod.adobemsbasic.com/crx/packmgr/service.jsp",
"activate": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-stage.adobemsbasic.com/etc/replication/treeactivation.html",
"activate:prod": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-prod.adobemsbasic.com/etc/replication/treeactivation.html",
"stability-check": "node bin/show-stablization-candidates.js"
},
"repository": {
Expand Down
94 changes: 86 additions & 8 deletions schemas/context/advertising.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,37 +20,115 @@
"description":
"The runtime measured viewability specific details such as player volume, library version, window status, viewport/ad measured dimensions, etc."
},
"xdm:clicks": {
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "Click(s) actions on an advertisement."
"xdm:adAssetReference": {
"title": "Ad Asset Reference",
"description": "Asset information about the ad captured by the experience event.",
"properties": {
"@id": {
"title": "Ad ID",
"type": "string",
"description": "Identifier of the ad asset."
},
"xdm:name": {
"title": "Ad Name",
"type": "string",
"description": "The friendly (human-readable) name of the ad asset."
},
"xdm:duration": {
"title": "Ad Length/Duration",
"type": "integer",
"description": "Length of ad asset in seconds."
}
},
"required": [
"@id",
"xdm:duration"
]
},
"xdm:adAssetViewDetails": {
"title": "Ad Asset View Details",
"description": "View details for the ad playback captured by the experience event.",
"properties": {
"xdm:playerName": {
"title": "Ad Player Name",
"type": "string",
"description": "The name of the player responsible for rendering the ad."
},
"xdm:podPosition": {
"title": "Ad Position in Pod",
"type": "integer",
"description": "The position (index) of the ad inside the parent ad break. The first ad has index 0, the second 1, and so on."
},
"xdm:adBreak": {
"properties": {
"@id": {
"title": "Ad Break ID",
"type": "string",
"description": "Identifier of the ad break."
},
"xdm:podName": {
"title": "Ad Break Name",
"type": "string",
"description": "The friendly name of the ad break."
},
"xdm:podOffset": {
"title": "Ad Break Offset",
"type": "integer",
"description": "The offset, in seconds, of the ad break from the start of the primary content."
}
},
"required": [
"@id",
"xdm:podOffset"
]
}
},
"required": [
"xdm:podPosition"
]
},
"xdm:completes": {
"title": "Completes",
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead."
},
"xdm:timePlayed": {
"title": "Time Spent",
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "A digital video ad has played through it's entirety."
"description": "Describes the amount of time spent by a user on a specific timed media asset."
},
"xdm:federated": {
"title": "Federated",
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "Indicates if an experience event was created through data federation (data sharing between customers)."
},
"xdm:clicks": {
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "Click(s) actions on an advertisement."
},
"xdm:conversions": {
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "A pre-defined action on a website triggered a conversion event to be fired"
"description": "A costumer pre-defined action(s) which triggers an event for performance evaluation."
},
"xdm:firstQuartiles": {
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "A digital video ad has played through 25% of it's duration at normal speed."
"description": "A digital video ad has played through 25% of its duration at normal speed."
},
"xdm:impressions": {
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "Impression(s) of an advertisement to an 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 it's duration at normal speed."
"description": "A digital video ad has played through 50% of its duration at normal speed."
},
"xdm: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 it's duration at normal speed."
"description": "A digital video ad has played through 75% of its duration at normal speed."
}
}
}
Expand Down
143 changes: 143 additions & 0 deletions schemas/context/experienceevent.example.4.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
{
"@id": "https://data.adobe.io/experienceid-123457",
"xdm:timestamp": "2017-09-26T15:52:25+00:00",
"xdm:endUserIDs": {
"https://ns.adobe.com/experience/mcid": {
"@id": "https://data.adobe.io/entities/identity/92312748749128",
"xdm:namespace": {
"xdm:code": "ECID"
}
},
"https://ns.adobe.com/experience/aaid": {
"@id": "https://data.adobe.io/entities/identity/2394509340-30453470347",
"xdm:namespace": {
"xdm:code": "AVID"
}
}
},
"xdm:environment": {
"xdm:browserDetails": {
"xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30"
},
"xdm:ipV4": "97.27.143.5"
},
"xdm:media": {
"xdm:mediaTimed": {
"xdm:primaryAssetReference": {
"@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430",
"xdm:name": "Floki Begs Helga for Freedom",
"xdm:duration": 87,
"xdm:showName": "nba_highlights",
"xdm:assetID": "2613953",
"xdm:showType": "episode",
"xdm:season": "N/A",
"xdm:episode": "one",
"xdm:genre": "sports",
"xdm:airDate": "2018-03-01",
"xdm:digitalDate": "2018-05-01",
"xdm:rating": "TV14",
"xdm:originator": "ESPN"
},
"xdm:primaryAssetViewDetails": {
"@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230",
"xdm:playerName": "watchespn",
"xdm:broadcastChannel": "WatchESPN",
"xdm:broadcastContentType": "VOD",
"xdm:streamFormat": "short",
"xdm:sdkVersion": {
"xdm:version": "1.0.8"
},
"xdm:vhlVersion": {
"xdm:version": "tvos-1.5.3.109-5c3dd2"
},
"xdm:broadcastNetwork": "nbcu",
"xdm:adLoadType": "2",
"xdm:dayPart": "DAY",
"xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8",
"xdm:sessionTimeout": 1800,
"xdm:QOE": {
"xdm:errors": {
"xdm:value": 0
},
"xdm:buffers": {
"xdm:value": 4
},
"xdm:bufferTime": {
"xdm:value": 5
},
"xdm:stalls": {
"xdm:value": 0
},
"xdm:stallTime": {
"xdm:value": 0
},
"xdm:bitrateChanges": {
"xdm:value": 0
},
"xdm:bitrateAverage": {
"xdm:value": 320
},
"xdm:bitrateAverageBucket": "300-399",
"xdm:droppedFrames": {
"xdm:value": 2
},
"xdm:timeToStart": {
"xdm:value": 3
},
"xdm:mediaSdkErrors": "300,500.300.200",
"xdm:playerSdkErrors": "custom.error.code",
"xdm:externalSdkErrors": "100-5,11.12"
}
},
"xdm:impressions": {
"xdm:value": 1
},
"xdm:completes": {
"xdm:value": 0
},
"xdm:timePlayed": {
"xdm:value": 80
},
"xdm:federated": {
"xdm:value": 0
},
"xdm:starts": {
"xdm:value": 1
},
"xdm:mediaSegment": "[10-70]",
"xdm:mediaSegmentView": {
"xdm:value": 1
},
"xdm:dropBeforeStart": {
"xdm:value": 0
},
"xdm:totalTimePlayed": {
"xdm:value": 190
},
"xdm:progress10": {
"xdm:value": 1
},
"xdm:firstQuartiles": {
"xdm:value": 1
},
"xdm:midpoints": {
"xdm:value": 1
},
"xdm:thirdQuartiles": {
"xdm:value": 1
},
"xdm:progress95": {
"xdm:value": 0
},
"xdm:resumes": {
"xdm:value": 0
},
"xdm:pauses": {
"xdm:value": 0
},
"xdm:pauseTime": {
"xdm:value": 0
}
}
}
}
89 changes: 89 additions & 0 deletions schemas/context/experienceevent.example.5.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
{
"@id": "https://data.adobe.io/experienceid-123458",
"xdm:timestamp": "2017-09-26T15:52:25+00:00",
"xdm:endUserIDs": {
"https://ns.adobe.com/experience/mcid": {
"@id": "https://data.adobe.io/entities/identity/92312748749128",
"xdm:namespace": {
"xdm:code": "ECID"
}
},
"https://ns.adobe.com/experience/aaid": {
"@id": "https://data.adobe.io/entities/identity/2394509340-30453470347",
"xdm:namespace": {
"xdm:code": "AVID"
}
}
},
"xdm:environment": {
"xdm:browserDetails": {
"xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30"
},
"xdm:ipV4": "97.27.143.5"
},
"xdm:media": {
"xdm:mediaTimed": {
"xdm:primaryAssetReference": {
"@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430",
"xdm:name": "Floki Begs Helga for Freedom",
"xdm:duration": 87,
"xdm:showName": "nba_highlights",
"xdm:assetID": "2613953",
"xdm:showType": "episode",
"xdm:season": "N/A",
"xdm:episode": "one",
"xdm:genre": "sports",
"xdm:airDate": "2018-03-01",
"xdm:digitalDate": "2018-05-01",
"xdm:rating": "TV14",
"xdm:originator": "ESPN"
},
"xdm:primaryAssetViewDetails": {
"@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230",
"xdm:playerName": "watchespn",
"xdm:broadcastChannel": "WatchESPN",
"xdm:broadcastContentType": "VOD",
"xdm:streamFormat": "short",
"xdm:sdkVersion": {
"xdm:version": "1.0.8"
},
"xdm:vhlVersion": {
"xdm:version": "tvos-1.5.3.109-5c3dd2"
},
"xdm:broadcastNetwork": "nbcu",
"xdm:adLoadType": "2",
"xdm:dayPart": "DAY",
"xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8",
"xdm:sessionTimeout": 1800
}
}
},
"xdm:advertising": {
"xdm:adAssetReference": {
"@id": "AD1",
"xdm:name": "adNumber1",
"xdm:duration": 10
},
"xdm:adAssetViewDetails": {
"xdm:playerName": "miniTestApp",
"xdm:podPosition": 0,
"xdm:adBreak": {
"@id": "f40353618c5c11311f584e53c78654b9_0",
"xdm:podName": "Mid-Roll",
"xdm:podOffset": 44
}
},
"xdm:impressions": {
"xdm:value": 1
},
"xdm:completes": {
"xdm:value": 1
},
"xdm:timePlayed": {
"xdm:value": 10
},
"xdm:federated": {
"xdm:value": 0
}
}
}
Loading

0 comments on commit 914f0b7

Please sign in to comment.