Moved the commerce metrics from ExperienceEvent \metrics to the \comm…

…erce context Shortened the URI field name for the web events to https://ns.adobe.com/xdm/metrics/web/* by dropping the 'data'. Updates all examples. Updarted the change log Please link to the issue #265
adobe · May 9, 2018 · 9951a68 · 9951a68
1 parent 749de0b
commit 9951a68
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 61 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,3 +11,4 @@
 [Unreleased](https://github.com/adobe/xdm/releases/tag/v0.9.1)
 
 * Renames all `Metric` schemas to `Metric Definition` #254
+* Moved `Commerce` metrics used in ExperienceEvent `\metrics` to the `\commerce` context #317
diff --git a/schemas/context/commerce.example.1.json b/schemas/context/commerce.example.1.json
@@ -18,5 +18,9 @@
     ],
     "xdm:currencyCode": "USD",
     "xdm:priceTotal": 999.98
+  },
+  "https://ns.adobe.com/xdm/metrics/commerce/purchases": {
+    "xdm:value": 1.0,
+    "xdm:unit": null
   }
 }
diff --git a/schemas/context/commerce.schema.json b/schemas/context/commerce.schema.json
@@ -17,6 +17,54 @@
           "title": "Order",
           "$ref": "https://ns.adobe.com/xdm/data/order",
           "description": "The placed order for one or more products."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/abandons": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "A product-list has been identified as no longer accessible (e.g purchasable) by the user."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/checkouts": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "An action during a checkout process of a product-list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/product-list-adds": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "Addition of a product to the product-list. Example a product is added to a shopping cart."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/product-list-opens": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "Initializations of a new product-list. Example a shopping cart is created."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/product-list-removals": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "Removal(s) of a product entry from a product-list. Example a product is removed from a shopping cart."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/product-list-reopens": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "A product-list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/product-list-views": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description": "View(s) of a product-list has occurred."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/product-views": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description": "View(s) of a product have occurred."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/purchases": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product-list referenced."
+        },
+        "https://ns.adobe.com/xdm/metrics/commerce/save-for-laters": {
+          "$ref": "https://ns.adobe.com/xdm/data/measure",
+          "description":
+            "Product-list is saved for future use. Example a product wish list."
         }
       }
     }

diff --git a/schemas/context/experienceevent.example.1.json b/schemas/context/experienceevent.example.1.json
@@ -48,10 +48,6 @@
     "xdm:connectionType": "cable"
   },
   "xdm:metrics": {
-    "https://ns.adobe.com/xdm/data/metrics/commerce/purchases": {
-      "xdm:value": 1.0,
-      "xdm:unit": null
-    },
     "https://ns.adobe.com/xdm/data/metrics/web/page-views": {
       "@type": "https://ns.adobe.com/xdm/data/metrics/web/page-views",
       "xdm:value": 1.0,
@@ -88,6 +84,10 @@
       ],
       "xdm:currencyCode": "USD",
       "xdm:priceTotal": 159.0
+    },
+    "https://ns.adobe.com/xdm/metrics/commerce/purchases": {
+      "xdm:value": 1.0,
+      "xdm:unit": null
     }
   },
   "xdm:placeContext": {

diff --git a/schemas/data/metrics.example.1.json b/schemas/data/metrics.example.1.json
@@ -1,14 +1,5 @@
 {
   "https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends": {
     "xdm:value": 1000
-  },
-  "https://ns.adobe.com/xdm/data/metrics/commerce/product-views": {
-    "xdm:value": 20,
-    "xdm:unit": null
-  },
-  "https://ns.adobe.com/xdm/data/metrics/web/page-views": {
-    "@type": "https://ns.adobe.com/xdm/data/metrics/web/page-views",
-    "xdm:value": 1625,
-    "xdm:unit": null
   }
 }
diff --git a/schemas/data/metrics.schema.json b/schemas/data/metrics.schema.json
@@ -19,21 +19,11 @@
         }
       },
       "properties": {
-        "https://ns.adobe.com/xdm/data/metrics/commerce/abandons": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "A product-list has been identified as no longer accessible (e.g purchasable) by the user."
-        },
         "https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces": {
           "$ref": "https://ns.adobe.com/xdm/data/measure",
           "description":
             "Asynchronous message(s) that have been returned as temporarily undeliverable the receiving system."
         },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/checkouts": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "An action during a checkout process of a product-list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order."
-        },
         "https://ns.adobe.com/xdm/data/metrics/advertising/clicks": {
           "$ref": "https://ns.adobe.com/xdm/data/measure",
           "description": "Click(s) actions on an advertisement."
@@ -85,44 +75,6 @@
           "$ref": "https://ns.adobe.com/xdm/data/measure",
           "description": "View(s) of a webpage has occurred."
         },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/product-list-adds": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "Addition of a product to the product-list. Example a product is added to a shopping cart."
-        },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/product-list-opens": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "Initializations of a new product-list. Example a shopping cart is created."
-        },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/product-list-removals": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "Removal(s) of a product entry from a product-list. Example a product is removed from a shopping cart."
-        },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/product-list-reopens": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "A product-list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity."
-        },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/product-list-views": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description": "View(s) of a product-list has occurred."
-        },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/product-views": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description": "View(s) of a product have occurred."
-        },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/purchases": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product-list referenced."
-        },
-        "https://ns.adobe.com/xdm/data/metrics/commerce/save-for-laters": {
-          "$ref": "https://ns.adobe.com/xdm/data/measure",
-          "description":
-            "Product-list is saved for future use. Example a product wish list."
-        },
         "https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends": {
           "$ref": "https://ns.adobe.com/xdm/data/measure",
           "description":
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,3 +11,4 @@
		[Unreleased](https://github.com/adobe/xdm/releases/tag/v0.9.1)

		* Renames all `Metric` schemas to `Metric Definition` #254
		* Moved `Commerce` metrics used in ExperienceEvent `\metrics` to the `\commerce` context #317