Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Video analytics final updates august #433

Merged
Merged
Changes from 1 commit
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
3b01868
proposal #1
Jun 13, 2018
9c65fb2
first set of metric definitions
Jun 14, 2018
0195807
1
Jun 19, 2018
6cd42f4
2
Jun 19, 2018
914f0b7
proposal #1
Jun 13, 2018
198e6bd
first set of metric definitions
Jun 14, 2018
5cfcf71
Run npm run lint
chrisdegroot Jun 20, 2018
8b07ef5
Merge branch 'media-analytics-schemas' of https://git.corp.adobe.com/…
chrisdegroot Jun 20, 2018
102829d
Corrected naming, removed undefined fields in example for errors.
chrisdegroot Jun 20, 2018
b686ffc
Removed files that did were duplicates due to media-timed renaming
chrisdegroot Jun 20, 2018
d614976
Extracted the advertising-timed schemas out of advertising.schema.json
chrisdegroot Jun 20, 2018
e910ee7
typo
chrisdegroot Jun 20, 2018
94a3b87
typo
chrisdegroot Jun 20, 2018
ab9e445
Merge branch 'master' into final-PR-to-Adobe-WG
chrisdegroot Jun 20, 2018
c934240
Update package.json
cdegroot-adobe Jun 20, 2018
7e1cd04
Added uri format to @id in advertising-break schema
chrisdegroot Jun 22, 2018
ff1e440
Updated ad-break examples to be URIs
chrisdegroot Jun 22, 2018
1ab8e76
pr feedback #1
Jun 28, 2018
c5e4091
update several properties to follow ITPC standard
Jul 11, 2018
1271312
fix validation issues
Jul 11, 2018
5804ea2
add stream format to examples
Jul 11, 2018
c4746c1
lowercase ITPC namespace and property names
Jul 11, 2018
d8de4fa
Corrected xmpDM:duration in example
chrisdegroot Jul 11, 2018
116f630
Merge branch 'final-PR-to-Adobe-WG' of https://github.com/cdegroot-ad…
chrisdegroot Jul 11, 2018
87c307d
Added the IPTC context to the common context.
chrisdegroot Jul 11, 2018
a19c952
Used the 1.1 version for IPTC vs the data option for consistency.
chrisdegroot Jul 11, 2018
0708107
added the correct context references.
chrisdegroot Jul 11, 2018
2388ddc
Fixed white spacing
chrisdegroot Jul 11, 2018
b325f4f
testing examples
chrisdegroot Jul 11, 2018
8011732
Improved example
chrisdegroot Jul 11, 2018
11d5522
Added the iptc4xmpExt tot eh other field
chrisdegroot Jul 11, 2018
7903fab
Correcte the iptc4xmpExt adoption as they are mostly complex objects
chrisdegroot Jul 11, 2018
4736e5f
Corrected all examples with the complex itpc schema usage
chrisdegroot Jul 11, 2018
cf08a2d
Corrected number formatting in examples
chrisdegroot Jul 11, 2018
abe8072
Corrected case in examples
chrisdegroot Jul 11, 2018
e8c7907
Corrected types
chrisdegroot Jul 11, 2018
938355b
Corrected example type
chrisdegroot Jul 11, 2018
5ba57bc
Removed "xdm:dayPart" from examples.
chrisdegroot Jul 12, 2018
f65652c
Corrected examples
chrisdegroot Jul 12, 2018
71d1563
Corrected description of
chrisdegroot Jul 12, 2018
d42e603
Changed the title of @id from "Content ID" to "Asset ID"
chrisdegroot Jul 12, 2018
e9ac45a
Moved ShowName and assetID to be an IPTC Series structure.
chrisdegroot Jul 12, 2018
06f01ba
Corrected examples, typo
chrisdegroot Jul 12, 2018
0214f1d
Merge remote-tracking branch 'upstream/master' into final-PR-to-Adobe-WG
chrisdegroot Jul 12, 2018
8464282
Updated change log
chrisdegroot Jul 12, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
1
  • Loading branch information
Cosmin Ciobanu committed Jun 19, 2018
commit 0195807b4a04b2a36c44e37b133b6593611d4df6
15 changes: 5 additions & 10 deletions schemas/context/advertising.schema.json
Original file line number Diff line number Diff line change
@@ -27,12 +27,12 @@
"@id": {
"title": "Ad ID",
"type": "string",
"description": "ID of the ad asset."
"description": "Identifier of the ad asset."
},
"xdm:name": {
"title": "Ad Name",
"type": "string",
"description": "Friendly name of the ad."
"description": "The friendly (human-readable) name of the ad asset."
},
"xdm:duration": {
"title": "Ad Length/Duration",
@@ -64,7 +64,7 @@
"@id": {
"title": "Ad Break ID",
"type": "string",
"description": "ID of the ad break."
"description": "Identifier of the ad break."
},
"xdm:podName": {
"title": "Ad Break Name",
@@ -74,7 +74,7 @@
"xdm:podOffset": {
"title": "Ad Break Offset",
"type": "integer",
"description": "The offset, in seconds, of the ad break inside the main content."
"description": "The offset, in seconds, of the ad break from the start of the primary content."
}
},
"required": [
@@ -87,11 +87,6 @@
"xdm:podPosition"
]
},
"xdm:loads": {
"title": "Loads",
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed."
},
"xdm:completes": {
"title": "Completes",
"$ref": "https://ns.adobe.com/xdm/data/measure",
@@ -105,7 +100,7 @@
"xdm:federated": {
"title": "Federated",
"$ref": "https://ns.adobe.com/xdm/data/measure",
"description": "Indicates if an experience event was created through federation."
"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",
5 changes: 1 addition & 4 deletions schemas/context/experienceevent.example.4.json
Original file line number Diff line number Diff line change
@@ -79,9 +79,6 @@
},
"xdm:bitrateAverageBucket": "300-399",
"xdm:droppedFrames": {
"xdm:value": 1
},
"xdm:droppedFrameCount": {
"xdm:value": 2
},
"xdm:timeToStart": {
@@ -92,7 +89,7 @@
"xdm:externalSdkErrors": "100-5,11.12"
}
},
"xdm:loads": {
"xdm:impressions": {
"xdm:value": 1
},
"xdm:completes": {
2 changes: 1 addition & 1 deletion schemas/context/experienceevent.example.5.json
Original file line number Diff line number Diff line change
@@ -73,7 +73,7 @@
"xdm:podOffset": 44
}
},
"xdm:loads": {
"xdm:impressions": {
"xdm:value": 1
},
"xdm:completes": {
2 changes: 1 addition & 1 deletion schemas/context/experienceevent.example.6.json
Original file line number Diff line number Diff line change
@@ -66,7 +66,7 @@
"xdm:chapterPosition": 0,
"xdm:offset": 0
},
"xdm:loads": {
"xdm:impressions": {
"xdm:value": 1
},
"xdm:completes": {
105 changes: 105 additions & 0 deletions schemas/context/media-asset-reference.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{
"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/media-asset-reference",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Timed Media Primary Asset Reference",
"type": "object",
"meta:status": "experimental",
"meta:extensible": true,
"description": "Asset information about the main content that was played, but present on all ads and chapters that occur during the content's playback as well.",
"definitions": {
"media-asset-reference": {
"properties": {
"@id": {
"title": "Content ID",
"type": "string",
"description": "Content ID of the content, which can be used to tie back to other industry / CMS IDs."
},
"xdm:name": {
"title": "Media Name",
"type": "string",
"description": "The friendly (human-readable) name of the timed media asset."
},
"xdm:duration": {
"title": "Media Length/Runtime",
"type": "integer",
"description": "Length of primary media asset in seconds."
},
"xdm:showName": {
"title": "Show Name",
"type": "string",
"description": "Program/Series Name."
},
"xdm:assetID": {
"title": "Asset ID",
"type": "string",
"description": "This is the unique identifier for the content of the video asset, such as the TV series episode identifier, movie asset identifier, or live event identifier. Typically these IDs are derived from metadata authorities such as EIDR, TMS/Gracenote, or Rovi. These identifiers can also be from other proprietary or in-house systems."
},
"xdm:showType": {
"title": "Show Type",
"type": "string",
"description": "The type of content e.g. Trailer, Full Episode."
},
"xdm:streamFormat": {
"title": "Stream Format",
"type": "string",
"description": "Free-form format of the stream (e.g. short, long)."
},
"xdm:season": {
"title": "Season",
"type": "string",
"description": "The season number the show belongs to."
},
"xdm:episode": {
"title": "Episode",
"type": "string",
"description": "The number of the episode."
},
"xdm:genre": {
"title": "Genre",
"type": "string",
"description": "Type or grouping of content as defined by content producer."
},
"xdm:airDate": {
"title": "First Air Date",
"type": "string",
"format": "date",
"description": "The date when the content first aired on television."
},
"xdm:digitalDate": {
"title": "First Digital Date",
"type": "string",
"format": "date",
"description": "The date when the content first aired on any digital channel or platform."
},
"xdm:rating": {
"title": "Content Rating",
"type": "string",
"description": "The rating as defined by Parental Guidelines."
},
"xdm:originator": {
"title": "Originator",
"type": "string",
"description": "The creator of the content."
}
},
"required": [
"@id",
"xdm:duration"
]
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/media-asset-reference"
}
]
}
98 changes: 98 additions & 0 deletions schemas/context/media-asset-view-details.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
{
"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/media-asset-view-details",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Primary Asset View Details",
"type": "object",
"meta:status": "experimental",
"meta:extensible": true,
"description": "View details for the main content playback, but present on all ads and chapters that occur during the content's playback as well.",
"definitions": {
"media-asset-view-details": {
"properties": {
"@id": {
"title": "Media Session ID",
"type": "string",
"description": "Identifies an instance of a content stream unique to an individual playback."
},
"xdm:playerName": {
"title": "Content Player Name",
"type": "string",
"description": "Name of the player."
},
"xdm:broadcastChannel": {
"title": "Distribution Channel",
"type": "string",
"description": "Distribution channel or where the content was played."
},
"xdm:broadcastContentType": {
"title": "Broadcast Content Type",
"type": "string",
"description": "The type of the stream delivery.",
"meta:enum": {
"VOD": "Video-on-Demand",
"Live": "Live Streaming",
"Linear": "Linear playback of the media asset",
"UGG": "User-generated Content",
"Radio": "Radio Show",
"Podcast": "Audio Postcast",
"Audiobook": "Audiobook"
}
},
"xdm:sdkVersion": {
"title": "Player SDK Version",
"$ref": "https://ns.adobe.com/xdm/context/implementationdetails",
"description": "The SDK version used by the player."
},
"xdm:vhlVersion": {
"title": "Tracking Library Version",
"$ref": "https://ns.adobe.com/xdm/context/implementationdetails",
"description": "The heartbeat SDK version used for the tracking session."
},
"xdm:broadcastNetwork": {
"title": "Broadcast Network",
"type": "string",
"description": "The programmer network name."
},
"xdm:adLoadType": {
"title": "Ad Load Type",
"type": "string",
"description": "The type of ad loaded as defined by each customer's internal representation."
},
"xdm:sourceFeed": {
"title": "Feed Type",
"type": "string",
"description": "The type of feed. Can either represent actual feed-related data (e.g. EAST HD/SD), or the source of the feed (e.g. an URL)."
},
"xdm:sessionTimeout": {
"title": "Media Session Server Timeout",
"type": "integer",
"description": "Indicates the amount of time, in seconds, that passed between the user's last known interaction and the moment the session was closed."
},
"xdm:qoe": {
"title": "Quality of Experience",
"$ref": "https://ns.adobe.com/xdm/context/media-timed-qoe",
"description": "Timed media properties related to the content playback's quality of experience (QoE)."
}
},
"required": [
"@id",
"xdm:playerName",
"xdm:broadcastChannel"
]
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/media-asset-view-details"
}
]
}
48 changes: 48 additions & 0 deletions schemas/context/media-chapter-asset-reference.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"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/media-chapter-asset-reference",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Timed Media Chapter Asset Reference",
"type": "object",
"meta:status": "experimental",
"meta:extensible": true,
"description": "Asset information about the chapter captured by the experience event.",
"definitions": {
"media-chapter-asset-reference": {
"properties": {
"@id": {
"title": "Chapter ID",
"type": "string",
"description": "The auto-generated ID of the chapter."
},
"xdm:name": {
"title": "Chapter Name",
"type": "string",
"description": "The friendly name of the chapter and/or segment."
},
"xdm:duration": {
"title": "Chapter Length/Duration",
"type": "integer",
"description": "The length of the chapter, in seconds."
}
},
"required": [
"@id",
"xdm:duration"
]
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/media-chapter-asset-reference"
}
]
}
43 changes: 43 additions & 0 deletions schemas/context/media-chapter-view-details.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"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/media-chapter-view-details",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Timed Media Chapter View Details",
"type": "object",
"meta:status": "experimental",
"meta:extensible": true,
"description": "View details for the chapter playback captured by the experience event.",
"definitions": {
"media-chapter-view-details": {
"properties": {
"xdm:chapterPosition": {
"title": "Chapter Position",
"type": "integer",
"description": "The position (index) of the chapter inside the content."
},
"xdm:offset": {
"title": "Chapter Offset",
"type": "integer",
"description": "The offset of the chapter, in seconds, inside the content from the start."
}
},
"required": [
"xdm:position",
"xdm:offset"
]
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/media-chapter-view-details"
}
]
}
Loading