Merge branch 'master' into feature-264-dimensions

adobe · May 21, 2018 · cf35e7c · cf35e7c
2 parents f0409de + 8b548e3
commit cf35e7c
Show file tree

Hide file tree

Showing 191 changed files with 6,685 additions and 1,213 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,5 +10,16 @@
 
 [Unreleased](https://github.com/adobe/xdm/releases/tag/v0.9.1)
 
-* Renames all `Metric` schemas to `Metric Definition` #254
+* Renamed all `Metric` schemas to `Metric Definition` #254
+* Moved web metrics used in ExperienceEvent `metrics` to the webinteraction and webpageview contexts #316
+* Renamed web metrics to `xdm:*` compressed type property names #316
+* Moved `commerce` metrics used in ExperienceEvent `metrics` to the `commerce` context #317
+* Renamed `commerce` metrics to `xdm:*` compressed type property names #317
+* `abandons` metric field name change to `cartAbandons` . #317
+* The `commerce` schema is now extensible to allow for additional dimensions and metrics. #317
 * Removed the required constraint from `schemas/external/schema/geo*.schema.json` #315
+* Introduced advertising context to ExperienceEvent #280
+* Introduced advertising and viewability metrics under the advertising context #280
+* Moved impressions and clicks metrics under advertising context #280
+* Added `xdm:primary` flag to `schemas/context/identity.schema.json` #335
+* Corrected naming of EndUserIDs by making them consistent (aaid and acid) `schemas/external/schema/geo*.schema.json` #333
diff --git a/STABILIZING.md b/STABILIZING.md
diff --git a/docs/reference/README.md b/docs/reference/README.md
diff --git a/docs/reference/common/descriptors/itemselector.schema.json b/docs/reference/common/descriptors/itemselector.schema.json
@@ -79,14 +79,14 @@
         {
             "xdm:id": "https://example.com/objects/12345"
         },
-        {
-            "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
-        },
         {
             "xdm:type": "https://ns.adobe.com/experience/mcid"
         },
         {
             "xdm:index": 0
+        },
+        {
+            "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
         }
     ]
 }
diff --git a/docs/reference/common/descriptors/itemselector.schema.md b/docs/reference/common/descriptors/itemselector.schema.md
@@ -24,19 +24,19 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.
 
 ```json
 {
-  "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
+  "xdm:type": "https://ns.adobe.com/experience/mcid"
 }
 ```
 
 ```json
 {
-  "xdm:type": "https://ns.adobe.com/experience/mcid"
+  "xdm:index": 0
 }
 ```
 
 ```json
 {
-  "xdm:index": 0
+  "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
 }
 ```
 
diff --git a/docs/reference/common/page.schema.json b/docs/reference/common/page.schema.json
@@ -64,13 +64,13 @@
             "orderBy": "id",
             "start": "123",
             "next": "789",
+            "type": "image/jpeg",
             "count": 100
         },
         {
             "orderBy": "id",
             "start": "123",
             "next": "789",
-            "type": "image/jpeg",
             "count": 100
         }
     ]

diff --git a/docs/reference/common/page.schema.md b/docs/reference/common/page.schema.md
@@ -19,6 +19,7 @@ Page information for paginated resource list operations.
   "orderBy": "id",
   "start": "123",
   "next": "789",
+  "type": "image/jpeg",
   "count": 100
 }
 ```
@@ -28,7 +29,6 @@ Page information for paginated resource list operations.
   "orderBy": "id",
   "start": "123",
   "next": "789",
-  "type": "image/jpeg",
   "count": 100
 }
 ```

diff --git a/docs/reference/context/advertising.schema.json b/docs/reference/context/advertising.schema.json
@@ -0,0 +1,89 @@
+{
+    "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",
+    "$schema": "http://json-schema.org/draft-06/schema#",
+    "title": "Advertising",
+    "type": "object",
+    "description": "The information related to advertising activity related to the experience event",
+    "meta:extensible": true,
+    "definitions": {
+        "advertising": {
+            "properties": {
+                "xdm:adViewability": {
+                    "title": "MRC Viewability",
+                    "$ref": "https://ns.adobe.com/xdm/context/adviewability",
+                    "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:completes": {
+                    "$ref": "https://ns.adobe.com/xdm/data/measure",
+                    "description": "A digital video ad has played through it's entirety."
+                },
+                "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"
+                },
+                "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."
+                },
+                "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."
+                },
+                "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."
+                }
+            }
+        }
+    },
+    "allOf": [
+        {
+            "$ref": "#/definitions/advertising"
+        }
+    ],
+    "meta:status": "experimental",
+    "examples": [
+        {
+            "xdm:adViewability": {
+                "xdm:adUnitDepth": 0,
+                "xdm:viewportHeight": 1250,
+                "xdm:viewportWidth": 1600,
+                "xdm:adHeight": 250,
+                "xdm:adWidth": 300,
+                "xdm:playerVolume": 85,
+                "xdm:measurementEligible": true,
+                "xdm:implementationDetails": {
+                    "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability",
+                    "xdm:version": "1"
+                },
+                "xdm:viewable": true,
+                "xdm:activeWindow": true,
+                "xdm:percentViewable": 89,
+                "xdm:viewableFirstQuartile": {
+                    "xdm:value": 1
+                }
+            },
+            "xdm:firstQuartiles": {
+                "xdm:value": 1
+            }
+        }
+    ]
+}