From 9c65fb2d0e3092edf159fcb03116dfbda9f9179d Mon Sep 17 00:00:00 2001 From: Cosmin Ciobanu Date: Thu, 14 Jun 2018 12:00:59 +0300 Subject: [PATCH] first set of metric definitions --- .../data/bitrate-average-bucket.schema.json | 56 +++++++++++++++++++ schemas/data/bitrate-average.schema.json | 56 +++++++++++++++++++ schemas/data/bitrate-changes.schema.json | 56 +++++++++++++++++++ schemas/data/buffer-time.schema.json | 56 +++++++++++++++++++ schemas/data/buffers.schema.json | 56 +++++++++++++++++++ schemas/data/completes.schema.json | 4 +- schemas/data/drop-before-start.schema.json | 56 +++++++++++++++++++ schemas/data/dropped-frames.schema.json | 56 +++++++++++++++++++ schemas/data/errors.schema.json | 56 +++++++++++++++++++ schemas/data/federated.schema.json | 56 +++++++++++++++++++ schemas/data/loads.schema.json | 56 +++++++++++++++++++ schemas/data/media-segment-view.schema.json | 56 +++++++++++++++++++ schemas/data/media-segment.schema.json | 56 +++++++++++++++++++ schemas/data/pause-time.schema.json | 56 +++++++++++++++++++ schemas/data/pauses.schema.json | 56 +++++++++++++++++++ schemas/data/progress10.schema.json | 56 +++++++++++++++++++ schemas/data/progress95.schema.json | 56 +++++++++++++++++++ schemas/data/resumes.schema.json | 56 +++++++++++++++++++ schemas/data/stall-time.schema.json | 56 +++++++++++++++++++ schemas/data/stalls.schema.json | 56 +++++++++++++++++++ schemas/data/starts.schema.json | 4 +- schemas/data/time-played.schema.json | 56 +++++++++++++++++++ schemas/data/time-to-start.schema.json | 56 +++++++++++++++++++ schemas/data/total-time-played.schema.json | 56 +++++++++++++++++++ 24 files changed, 1236 insertions(+), 4 deletions(-) create mode 100644 schemas/data/bitrate-average-bucket.schema.json create mode 100644 schemas/data/bitrate-average.schema.json create mode 100644 schemas/data/bitrate-changes.schema.json create mode 100644 schemas/data/buffer-time.schema.json create mode 100644 schemas/data/buffers.schema.json create mode 100644 schemas/data/drop-before-start.schema.json create mode 100644 schemas/data/dropped-frames.schema.json create mode 100644 schemas/data/errors.schema.json create mode 100644 schemas/data/federated.schema.json create mode 100644 schemas/data/loads.schema.json create mode 100644 schemas/data/media-segment-view.schema.json create mode 100644 schemas/data/media-segment.schema.json create mode 100644 schemas/data/pause-time.schema.json create mode 100644 schemas/data/pauses.schema.json create mode 100644 schemas/data/progress10.schema.json create mode 100644 schemas/data/progress95.schema.json create mode 100644 schemas/data/resumes.schema.json create mode 100644 schemas/data/stall-time.schema.json create mode 100644 schemas/data/stalls.schema.json create mode 100644 schemas/data/time-played.schema.json create mode 100644 schemas/data/time-to-start.schema.json create mode 100644 schemas/data/total-time-played.schema.json diff --git a/schemas/data/bitrate-average-bucket.schema.json b/schemas/data/bitrate-average-bucket.schema.json new file mode 100644 index 0000000000..017a6b73df --- /dev/null +++ b/schemas/data/bitrate-average-bucket.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/bitrate-average-bucket", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Bitrate Average Bucket", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The average bitrate classified into predefined buckets of 100kbps intervals.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:bitrateAverageBucket", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: bitrateAverageBucket", + "description": "The average bitrate classified into predefined buckets of 100kbps intervals." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "enum" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/bitrate-average.schema.json b/schemas/data/bitrate-average.schema.json new file mode 100644 index 0000000000..a431a0f4c3 --- /dev/null +++ b/schemas/data/bitrate-average.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/bitrate-average", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Bitrate Average", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "A weighted average of all bitrate values related to the play duration that occurred during a playback session.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:bitrateAverage", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: bitrateAverage", + "description": "A weighted average of all bitrate values related to the play duration that occurred during a playback session." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "average" + }, + "xdm:unit": { + "const": "kbps" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/bitrate-changes.schema.json b/schemas/data/bitrate-changes.schema.json new file mode 100644 index 0000000000..56e3496171 --- /dev/null +++ b/schemas/data/bitrate-changes.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/bitrate-changes", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Bitrate Changes", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The number of bitrate change events that occurred during a playback session.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:bitrateChanges", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: bitrateChanges", + "description": "The number of bitrate change events that occurred during a playback session." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/buffer-time.schema.json b/schemas/data/buffer-time.schema.json new file mode 100644 index 0000000000..d644cc55eb --- /dev/null +++ b/schemas/data/buffer-time.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/buffer-time", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Buffer Time", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Describes the total amount of time spent buffering.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:bufferTime", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: bufferTime", + "description": "Describes the total amount of time spent buffering." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "time" + }, + "xdm:unit": { + "const": "second" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/buffers.schema.json b/schemas/data/buffers.schema.json new file mode 100644 index 0000000000..e471ed3f4b --- /dev/null +++ b/schemas/data/buffers.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/buffers", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Buffers", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The number of the different buffer states that occurred during a playback session.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:buffers", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: buffers", + "description": "The number of the different buffer states that occurred during a playback session." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/completes.schema.json b/schemas/data/completes.schema.json index 832c44a5b5..5ebde76988 100644 --- a/schemas/data/completes.schema.json +++ b/schemas/data/completes.schema.json @@ -11,7 +11,7 @@ "type": "object", "meta:extensible": true, "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], - "description": "The metric completes describes digital video assets which played through its entire duration.", + "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.", "definitions": { "metricdefinition": { "properties": { @@ -24,7 +24,7 @@ "type": "string", "const": "metric: completes", "description": - "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "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:measurement": { "type": "string", diff --git a/schemas/data/drop-before-start.schema.json b/schemas/data/drop-before-start.schema.json new file mode 100644 index 0000000000..bf3ae8337a --- /dev/null +++ b/schemas/data/drop-before-start.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/drop-before-start", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Drop before Start", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Indicates the user abandoned the media stream before the first frame (e.g. during the pre-roll ad break, due to an error while loading the content from the CDN).", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:dropBeforeStart", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: dropBeforeStart", + "description": "Indicates the user abandoned the media stream before the first frame (e.g. during the pre-roll ad break, due to an error while loading the content from the CDN)." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/dropped-frames.schema.json b/schemas/data/dropped-frames.schema.json new file mode 100644 index 0000000000..02275e3cf6 --- /dev/null +++ b/schemas/data/dropped-frames.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/dropped-frames", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Dropped Frames", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The number of frames dropped during a playback session.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:droppedFrames", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: droppedFrames", + "description": "The number of frames dropped during a playback session." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/errors.schema.json b/schemas/data/errors.schema.json new file mode 100644 index 0000000000..ceb0918a1d --- /dev/null +++ b/schemas/data/errors.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/errors", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Errors", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The number of errors that were encountered during playback.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:errors", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: errors", + "description": "The number of errors that were encountered during playback." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/federated.schema.json b/schemas/data/federated.schema.json new file mode 100644 index 0000000000..e529bd2cec --- /dev/null +++ b/schemas/data/federated.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/federated", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Federated", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Indicates if the experience event was created through federation.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:federated", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: federated", + "description": "Indicates if the experience event was created through federation." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/loads.schema.json b/schemas/data/loads.schema.json new file mode 100644 index 0000000000..f272f38ac3 --- /dev/null +++ b/schemas/data/loads.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/loads", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Loads", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "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.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:loads", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: starts", + "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:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/media-segment-view.schema.json b/schemas/data/media-segment-view.schema.json new file mode 100644 index 0000000000..a0a2f8e949 --- /dev/null +++ b/schemas/data/media-segment-view.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/media-segment-vie", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Media Segment View", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Indicates whether at least one frame (not necessarily the first) was viewed.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:mediaSegmentView", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: mediaSegmentView", + "description": "Indicates whether at least one frame (not necessarily the first) was viewed." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/media-segment.schema.json b/schemas/data/media-segment.schema.json new file mode 100644 index 0000000000..379d041e4d --- /dev/null +++ b/schemas/data/media-segment.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/media-segment", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Media Segment", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The interval that describes the part of the content that has been viewed (in minutes). The segment is computed as min and max of the playhead values during a playback session.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:mediaSegment", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: mediaSegment", + "description": "The interval that describes the part of the content that has been viewed (in minutes). The segment is computed as min and max of the playhead values during a playback session." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "interval" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/pause-time.schema.json b/schemas/data/pause-time.schema.json new file mode 100644 index 0000000000..5e500bc90c --- /dev/null +++ b/schemas/data/pause-time.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/pause-time", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Pause Time", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Describes the duration in which playback was paused by the user.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:pauseTime", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: pauseTime", + "description": "Describes the duration in which playback was paused by the user." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "time" + }, + "xdm:unit": { + "const": "second" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/pauses.schema.json b/schemas/data/pauses.schema.json new file mode 100644 index 0000000000..d0157249dd --- /dev/null +++ b/schemas/data/pauses.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/pauses", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Pauses", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The number of pause periods that occurred during playback.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:pauses", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: pauses", + "description": "The number of pause periods that occurred during playback." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/progress10.schema.json b/schemas/data/progress10.schema.json new file mode 100644 index 0000000000..412bdf32ed --- /dev/null +++ b/schemas/data/progress10.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/progress10", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "10% Progress Marker", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:progress10", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: progress10", + "description": "Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/progress95.schema.json b/schemas/data/progress95.schema.json new file mode 100644 index 0000000000..96fd41f7f2 --- /dev/null +++ b/schemas/data/progress95.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/progress95", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "95% Progress Marker", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Indicates that the playhead passed the 95% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:progress95", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: progress95", + "description": "Indicates that the playhead passed the 95% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/resumes.schema.json b/schemas/data/resumes.schema.json new file mode 100644 index 0000000000..fb7cfdd929 --- /dev/null +++ b/schemas/data/resumes.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/resumes", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Resumes", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:resumes", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: resumes", + "description": "Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/stall-time.schema.json b/schemas/data/stall-time.schema.json new file mode 100644 index 0000000000..dc4b7bb3ea --- /dev/null +++ b/schemas/data/stall-time.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/stall-time", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Stall Time", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Describes the duration in which the playback was stalled during playback.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:stallTime", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: stallTime", + "description": "Describes the duration in which the playback was stalled during playback." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/stalls.schema.json b/schemas/data/stalls.schema.json new file mode 100644 index 0000000000..844be990cb --- /dev/null +++ b/schemas/data/stalls.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/stalls", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Stalls", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The number of stall states that occurred during a playback session.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:stalls", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: stalls", + "description": "The number of stall states that occurred during a playback session." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/starts.schema.json b/schemas/data/starts.schema.json index e20693ea02..c8f229d122 100644 --- a/schemas/data/starts.schema.json +++ b/schemas/data/starts.schema.json @@ -11,7 +11,7 @@ "type": "object", "meta:extensible": true, "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], - "description": "The metric starts describes a digital video which started playing.", + "description": "Indicates the first frame of the timed media was viewed - i.e. the viewer did not abandon during pre-roll ad, buffering, etc.", "definitions": { "metricdefinition": { "properties": { @@ -24,7 +24,7 @@ "type": "string", "const": "metric: starts", "description": - "The metric starts describes a digital video which started playing." + "Indicates the first frame of the timed media asset was viewed - i.e. the viewer did not abandon during pre-roll ad, buffering, etc." }, "xdm:measurement": { "type": "string", diff --git a/schemas/data/time-played.schema.json b/schemas/data/time-played.schema.json new file mode 100644 index 0000000000..84a008fb7d --- /dev/null +++ b/schemas/data/time-played.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/time-played", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Time Played", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Describes the amount of time spent by a user on a specific timed media asset.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:timePlayed", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: timePlayed", + "description": "Describes the amount of time spent by a user on a specific timed media asset." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "time" + }, + "xdm:unit": { + "const": "second" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/time-to-start.schema.json b/schemas/data/time-to-start.schema.json new file mode 100644 index 0000000000..459924d952 --- /dev/null +++ b/schemas/data/time-to-start.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/time-to-start", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Time to Start", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Describes the duration passed between video load and start.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:timeToStart", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: timeToStart", + "description": "Describes the duration passed between video load and start." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "time" + }, + "xdm:unit": { + "const": "second" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +} diff --git a/schemas/data/total-time-played.schema.json b/schemas/data/total-time-played.schema.json new file mode 100644 index 0000000000..cdc3823a0a --- /dev/null +++ b/schemas/data/total-time-played.schema.json @@ -0,0 +1,56 @@ +{ + "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/data/total-time-played", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Total Time Played", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:totalTimePlayed", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: totalTimePlayed", + "description": "Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "time" + }, + "xdm:unit": { + "const": "second" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stabilizing" +}