diff --git a/package.json b/package.json index be024ba34f..abe0422c45 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "aem_user": "packageUser", "aem_password": "override me securely", "markdown-importer-version": "0.0.4", - "schemas": 202 + "schemas": 205 }, "scripts": { "clean": "rm -rf docs/reference", diff --git a/schemas/context/advertising-break.example.1.json b/schemas/context/advertising-break.example.1.json new file mode 100644 index 0000000000..ad596c1615 --- /dev/null +++ b/schemas/context/advertising-break.example.1.json @@ -0,0 +1,5 @@ +{ + "@id": "https://data.adobe.io/entities/adbreak/2394509340-30453470347", + "xdm:podName": "My Pod", + "xdm:podOffset": 3 +} diff --git a/schemas/context/advertising-break.schema.json b/schemas/context/advertising-break.schema.json new file mode 100644 index 0000000000..fa0d5a89ba --- /dev/null +++ b/schemas/context/advertising-break.schema.json @@ -0,0 +1,45 @@ +{ + "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/advertising-break", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad Break", + "type": "object", + "description": "Details about how a timed advertising is being inserted into a timed media.", + "meta:extensible": true, + "definitions": { + "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" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/adBreak" + } + ], + "meta:status": "experimental" +} diff --git a/schemas/context/advertising-timed-asset-reference.example.1.json b/schemas/context/advertising-timed-asset-reference.example.1.json new file mode 100644 index 0000000000..c91c851703 --- /dev/null +++ b/schemas/context/advertising-timed-asset-reference.example.1.json @@ -0,0 +1,5 @@ +{ + "@id": "https://data.adobe.io/entities/asser-reference/23423", + "xdm:name": "Acme offer 21", + "xdm:duration": 23 +} diff --git a/schemas/context/advertising-timed-asset-reference.schema.json b/schemas/context/advertising-timed-asset-reference.schema.json new file mode 100644 index 0000000000..a6449e6ba1 --- /dev/null +++ b/schemas/context/advertising-timed-asset-reference.schema.json @@ -0,0 +1,45 @@ +{ + "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/advertising-timed-asset-reference", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad Asset Reference", + "type": "object", + "description": "Asset information about the ad captured by the experience event.", + "meta:extensible": true, + "definitions": { + "adAssetReference": { + "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" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/adAssetReference" + } + ], + "meta:status": "experimental" +} diff --git a/schemas/context/advertising-timed-asset-view-details.example.1.json b/schemas/context/advertising-timed-asset-view-details.example.1.json new file mode 100644 index 0000000000..88a8e0aeda --- /dev/null +++ b/schemas/context/advertising-timed-asset-view-details.example.1.json @@ -0,0 +1,9 @@ +{ + "xdm:playerName": "Acme Ad Player", + "xdm:podPosition": 12, + "xdm:adBreak": { + "@id": "https://data.adobe.io/entities/adbreak/2394509340-30453470347", + "xdm:podName": "My Pod", + "xdm:podOffset": 3 + } +} diff --git a/schemas/context/advertising-timed-asset-view-details.schema.json b/schemas/context/advertising-timed-asset-view-details.schema.json new file mode 100644 index 0000000000..b25477124f --- /dev/null +++ b/schemas/context/advertising-timed-asset-view-details.schema.json @@ -0,0 +1,49 @@ +{ + "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/advertising-timed-asset-view-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad Asset View Details", + "type": "object", + "description": "View details for the ad playback captured by the experience event.", + "meta:extensible": true, + "definitions": { + "adAssetViewDetails": { + "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": { + "title": "Ad Break", + "description": "Details about how a timed advertising is being inserted into a timed media.", + "$ref": "https://ns.adobe.com/xdm/context/advertising-break" + }, + "required": [ + "@id", + "xdm:podOffset" + ] + } + }, + "required": [ + "xdm:podPosition" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/adAssetViewDetails" + } + ], + "meta:status": "experimental" +} diff --git a/schemas/context/advertising.schema.json b/schemas/context/advertising.schema.json index 46f147ba68..9e0d302c0c 100644 --- a/schemas/context/advertising.schema.json +++ b/schemas/context/advertising.schema.json @@ -23,69 +23,12 @@ "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" - ] + "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference" }, "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" - ] + "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details" }, "xdm:completes": { "title": "Completes",