Issue#364 - Video Analytics additions for ExperienceEvent - June 29th Milestone

CHANGELOG.md

@@ -54,6 +54,7 @@
 
 [Planned for June 29, 2018](https://github.com/adobe/xdm/releases/tag/v0.9.3)
 
+* Added Timed Media schemas to `Experience Event` based schemas #417
 * Change `Identity` Schema `@id` property renamed to `xdm:id` #420
 * Add post office box to align with Microsoft CDM #423
 * Added datasourceID to the ExperienceCloud Extension for Experience Event. #425

meta.schema.json

@@ -41,7 +41,7 @@
       "type": "string",
       "format": "uri",
       "pattern":
-        "(https://ns\\.adobe\\.com/xdm/[a-z0-9-/]*)|(http://schema\\.org/.*)|(http://ns.adobe.com/adobecloud/core/1.0.*)|(https://tools\\.ietf\\.org/html/draft-kelly-json-hal-08/.*)"
+        "(https://ns\\.adobe\\.com/xdm/[a-z0-9-/]*)|(http://schema\\.org/.*)|(http://ns.adobe.com/adobecloud/core/1.0.*)|(https://tools\\.ietf\\.org/html/draft-kelly-json-hal-08/.*)|(http://www.iptc\\.org/.*)"
     },
     "meta:license": {
       "type": "array",

package.json

@@ -7,7 +7,7 @@
     "aem_user": "packageUser",
     "aem_password": "override me securely",
     "markdown-importer-version": "0.0.4",
-    "schemas": 176
+    "schemas": 211
   },
   "scripts": {
     "clean": "rm -rf docs/reference",

schemas/common/context.jsonld

@@ -27,6 +27,7 @@
     "exif": "http://ns.adobe.com/exif/1.0/#",
     "activitystreams": "https://www.w3.org/ns/activitystreams",
     "schema": "http://schema.org",
-    "repo": "http://ns.adobe.com/adobecloud/core/1.0/"
+    "repo": "http://ns.adobe.com/adobecloud/core/1.0/",
+    "iptc4xmpExt": "http://iptc.org/std/Iptc4xmpExt/1.1/"
   }
-}
+}

schemas/common/extensible.schema.json

@@ -46,6 +46,7 @@
             "^activitystreams:.*$": {},
             "^schema:.*$": {},
             "^repo:.*$": {},
+            "^iptc4xmpExt:.*$": {},
             ".+://.+": {},
             "@.*": {}
           },
@@ -196,6 +197,11 @@
                   "type": "string",
                   "format": "url",
                   "const": "http://ns.adobe.com/adobecloud/core/1.0/"
+                },
+                "iptc4xmpExt": {
+                  "type": "string",
+                  "format": "url",
+                  "const": "http://iptc.org/std/Iptc4xmpExt/1.1/"
                 }
               },
               "additionalProperties": false,
@@ -231,6 +237,7 @@
             "^activitystreams:.*$": {},
             "^schema:.*$": {},
             "^repo:.*$": {},
+            "^iptc4xmpExt:.*$": {},
             ".+://.+": {}
           },
           "required": ["@context"],

schemas/context/advertising-break.example.1.json

@@ -0,0 +1,5 @@
+{
+  "@id": "https://data.adobe.io/entities/ad-break/2394509340-30453470347",
+  "dc:title": "My Pod",
+  "xdm:offset": 3
+}

schemas/context/advertising-break.schema.json

@@ -0,0 +1,46 @@
+{
+  "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",
+          "format": "uri",
+          "type": "string",
+          "description": "Identifier of the ad break."
+        },
+        "dc:title": {
+          "title": "Ad Break Name",
+          "type": "string",
+          "description": "The friendly name of the ad break."
+        },
+        "xdm:offset": {
+          "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:offset"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/adBreak"
+    }
+  ],
+  "meta:status": "experimental"
+}

schemas/context/advertising-timed-asset-reference.example.1.json

@@ -0,0 +1,5 @@
+{
+  "@id": "https://data.adobe.io/entities/asser-reference/23423",
+  "dc:title": "Acme offer 21",
+  "xmpDM:duration": 23
+}

schemas/context/advertising-timed-asset-reference.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-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",
+          "format": "uri",
+          "description": "Identifier of the ad asset provided by Media Analytics customers."
+        },
+        "dc:title": {
+          "title": "Ad Name",
+          "type": "string",
+          "description": "The friendly (human-readable) name of the ad asset."
+        },
+        "xmpDM:duration": {
+          "title": "Ad Length/Duration",
+          "type": "integer",
+          "description": "Length of ad asset in seconds."
+        }
+      },
+      "required": [
+        "@id",
+        "xmpDM:duration"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
+    },
+    {
+      "$ref": "#/definitions/adAssetReference"
+    }
+  ],
+  "meta:status": "experimental"
+}

schemas/context/advertising-timed-asset-view-details.example.1.json

@@ -0,0 +1,9 @@
+{
+  "xdm:playerName": "Acme Ad Player",
+  "xdm:index": 1,
+  "xdm:adBreak": {
+    "@id": "https://data.adobe.io/entities/adbreak/2394509340-30453470347",
+    "dc:title": "My Pod",
+    "xdm:offset": 3
+  }
+}

schemas/context/advertising-timed-asset-view-details.schema.json

@@ -0,0 +1,47 @@
+{
+  "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:index": {
+          "title": "Ad Index in Pod",
+          "type": "integer",
+          "description": "The 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": [
+        "xdm:index"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
+    },
+    {
+      "$ref": "#/definitions/adAssetViewDetails"
+    }
+  ],
+  "meta:status": "experimental"
+}

schemas/context/advertising.schema.json

@@ -20,37 +20,58 @@
           "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.",
+          "$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.",
+          "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details"
         },
         "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 customer 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."
         }
       }
     }