Merge pull request #88 from adobe/metrics

Metrics
adobe · Jan 23, 2018 · 644f673 · 644f673
2 parents 54b5abb + b21ace5
commit 644f673
Show file tree

Hide file tree

Showing 49 changed files with 1,365 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -1,13 +1,13 @@
 {
   "name": "xdm",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "description": "Experience Data Models",
   "main": "",
   "config": {
     "aem_user": "packageUser",
     "aem_password": "override me securely",
     "markdown-importer-version": "0.0.4",
-    "schemas": 79
+    "schemas": 101
   },
   "scripts": {
     "clean": "rm -rf docs/reference",

diff --git a/schemas/channels/channel.example.1.json b/schemas/channels/channel.example.1.json
@@ -1,4 +1,8 @@
 {
   "@id": "https://ns.adobe.com/xdm/channels/facebook-feed",
-  "@type": "https://ns.adobe.com/xdm/channel-types/social"
+  "@type": "https://ns.adobe.com/xdm/channel-types/social",
+  "xdm:metrics": [
+    "https://ns.adobe.com/xdm/data/metrics/web/page-views",
+    "https://ns.adobe.com/xdm/data/metrics/web/link-clicks"
+  ]
 }
diff --git a/schemas/data/abandons.example.1.json b/schemas/data/abandons.example.1.json
@@ -0,0 +1,6 @@
+{
+  "schema:name": "commerce metric: abandons",
+  "@id": "https://ns.adobe.com/xdm/data/metrics/commerce/abandons",
+  "xdm:measurement": "count",
+  "xdm:unit": null
+}
diff --git a/schemas/data/abandons.schema.json b/schemas/data/abandons.schema.json
@@ -0,0 +1,53 @@
+{
+  "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/metrics/commerce/abandons",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "abandons",
+  "type": "object",
+  "meta:extensible": true,
+  "meta:extends": [
+    "https://ns.adobe.com/xdm/data/metric"
+  ],
+  "description": "Number of abandons for which a product list has been identified as no longer purchasable or accessible by the user without the user re-creating the product list from scratch.",
+  "definitions": {
+    "metric": {
+      "properties": {
+        "@id": {
+          "type": "string",
+          "format": "uri",
+          "const": "https://ns.adobe.com/xdm/data/metrics/commerce/abandons",
+          "description": "The unique identifier of this metric."
+        },
+        "schema:name": {
+          "type": "string",
+          "const": "commerce metric: abandons",
+          "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique."
+        },
+        "xdm:measurement": {
+          "type": "string",
+          "description": "How to take measures of this metric.",
+          "const": "count"
+        },
+        "xdm:unit": {
+          "const": null
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/metric"
+    }
+  ],
+  "required": [
+    "@id",
+    "schema:name",
+    "xdm:measurement",
+    "xdm:unit"
+  ]
+}
diff --git a/schemas/data/bounces.example.1.json b/schemas/data/bounces.example.1.json
@@ -0,0 +1,6 @@
+{
+  "schema:name": "direct-marketing metric: bounces",
+  "@id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces",
+  "xdm:measurement": "count",
+  "xdm:unit": null
+}
diff --git a/schemas/data/bounces.schema.json b/schemas/data/bounces.schema.json
@@ -0,0 +1,53 @@
+{
+  "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/metrics/direct-marketing/bounces",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "bounces",
+  "type": "object",
+  "meta:extensible": true,
+  "meta:extends": [
+    "https://ns.adobe.com/xdm/data/metric"
+  ],
+  "description": "The direct-marketing metric bounces describes the number of asynchronous messages that have been rejected by the receiving system.",
+  "definitions": {
+    "metric": {
+      "properties": {
+        "@id": {
+          "type": "string",
+          "format": "uri",
+          "const": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces",
+          "description": "The unique identifier of this metric."
+        },
+        "schema:name": {
+          "type": "string",
+          "const": "direct-marketing metric: bounces",
+          "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique."
+        },
+        "xdm:measurement": {
+          "type": "string",
+          "description": "How to take measures of this metric.",
+          "const": "count"
+        },
+        "xdm:unit": {
+          "const": null
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/metric"
+    }
+  ],
+  "required": [
+    "@id",
+    "schema:name",
+    "xdm:measurement",
+    "xdm:unit"
+  ]
+}
diff --git a/schemas/data/checkouts.example.1.json b/schemas/data/checkouts.example.1.json
@@ -0,0 +1,6 @@
+{
+  "schema:name": "commerce metric: checkouts",
+  "@id": "https://ns.adobe.com/xdm/data/metrics/commerce/checkouts",
+  "xdm:measurement": "count",
+  "xdm:unit": null
+}
diff --git a/schemas/data/checkouts.schema.json b/schemas/data/checkouts.schema.json
@@ -0,0 +1,53 @@
+{
+  "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/metrics/commerce/checkouts",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "checkouts",
+  "type": "object",
+  "meta:extensible": true,
+  "meta:extends": [
+    "https://ns.adobe.com/xdm/data/metric"
+  ],
+  "description": "Number of actions 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.",
+  "definitions": {
+    "metric": {
+      "properties": {
+        "@id": {
+          "type": "string",
+          "format": "uri",
+          "const": "https://ns.adobe.com/xdm/data/metrics/commerce/checkouts",
+          "description": "The unique identifier of this metric."
+        },
+        "schema:name": {
+          "type": "string",
+          "const": "commerce metric: checkouts",
+          "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique."
+        },
+        "xdm:measurement": {
+          "type": "string",
+          "description": "How to take measures of this metric.",
+          "const": "count"
+        },
+        "xdm:unit": {
+          "const": null
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/metric"
+    }
+  ],
+  "required": [
+    "@id",
+    "schema:name",
+    "xdm:measurement",
+    "xdm:unit"
+  ]
+}
diff --git a/schemas/data/clicks.example.1.json b/schemas/data/clicks.example.1.json
@@ -0,0 +1,6 @@
+{
+  "schema:name": "advertising metric: clicks",
+  "@id": "https://ns.adobe.com/xdm/data/metrics/advertising/clicks",
+  "xdm:measurement": "count",
+  "xdm:unit": null
+}
diff --git a/schemas/data/clicks.schema.json b/schemas/data/clicks.schema.json
@@ -0,0 +1,53 @@
+{
+  "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/metrics/advertising/clicks",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "clicks",
+  "type": "object",
+  "meta:extensible": true,
+  "meta:extends": [
+    "https://ns.adobe.com/xdm/data/metric"
+  ],
+  "description": "The advertising metric clicks describes…",
+  "definitions": {
+    "metric": {
+      "properties": {
+        "@id": {
+          "type": "string",
+          "format": "uri",
+          "const": "https://ns.adobe.com/xdm/data/metrics/advertising/clicks",
+          "description": "The unique identifier of this metric."
+        },
+        "schema:name": {
+          "type": "string",
+          "const": "advertising metric: clicks",
+          "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique."
+        },
+        "xdm:measurement": {
+          "type": "string",
+          "description": "How to take measures of this metric.",
+          "const": "count"
+        },
+        "xdm:unit": {
+          "const": null
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/metric"
+    }
+  ],
+  "required": [
+    "@id",
+    "schema:name",
+    "xdm:measurement",
+    "xdm:unit"
+  ]
+}
diff --git a/schemas/data/impressions.example.1.json b/schemas/data/impressions.example.1.json
@@ -0,0 +1,6 @@
+{
+  "schema:name": "advertising metric: impressions",
+  "@id": "https://ns.adobe.com/xdm/data/metrics/advertising/impressions",
+  "xdm:measurement": "count",
+  "xdm:unit": null
+}
diff --git a/schemas/data/impressions.schema.json b/schemas/data/impressions.schema.json
@@ -0,0 +1,53 @@
+{
+  "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/metrics/advertising/impressions",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "impressions",
+  "type": "object",
+  "meta:extensible": true,
+  "meta:extends": [
+    "https://ns.adobe.com/xdm/data/metric"
+  ],
+  "description": "The advertising metric impressions describes…",
+  "definitions": {
+    "metric": {
+      "properties": {
+        "@id": {
+          "type": "string",
+          "format": "uri",
+          "const": "https://ns.adobe.com/xdm/data/metrics/advertising/impressions",
+          "description": "The unique identifier of this metric."
+        },
+        "schema:name": {
+          "type": "string",
+          "const": "advertising metric: impressions",
+          "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique."
+        },
+        "xdm:measurement": {
+          "type": "string",
+          "description": "How to take measures of this metric.",
+          "const": "count"
+        },
+        "xdm:unit": {
+          "const": null
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/metric"
+    }
+  ],
+  "required": [
+    "@id",
+    "schema:name",
+    "xdm:measurement",
+    "xdm:unit"
+  ]
+}
diff --git a/schemas/data/link-clicks.example.1.json b/schemas/data/link-clicks.example.1.json
@@ -0,0 +1,6 @@
+{
+  "schema:name": "web metric: link-clicks",
+  "@id": "https://ns.adobe.com/xdm/data/metrics/web/link-clicks",
+  "xdm:measurement": "count",
+  "xdm:unit": null
+}
diff --git a/schemas/data/link-clicks.schema.json b/schemas/data/link-clicks.schema.json
@@ -0,0 +1,53 @@
+{
+  "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/metrics/web/link-clicks",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "link-clicks",
+  "type": "object",
+  "meta:extensible": true,
+  "meta:extends": [
+    "https://ns.adobe.com/xdm/data/metric"
+  ],
+  "description": "The web metric link-clicks describes the number of clicks on a link on a web page.",
+  "definitions": {
+    "metric": {
+      "properties": {
+        "@id": {
+          "type": "string",
+          "format": "uri",
+          "const": "https://ns.adobe.com/xdm/data/metrics/web/link-clicks",
+          "description": "The unique identifier of this metric."
+        },
+        "schema:name": {
+          "type": "string",
+          "const": "web metric: link-clicks",
+          "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique."
+        },
+        "xdm:measurement": {
+          "type": "string",
+          "description": "How to take measures of this metric.",
+          "const": "count"
+        },
+        "xdm:unit": {
+          "const": null
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/metric"
+    }
+  ],
+  "required": [
+    "@id",
+    "schema:name",
+    "xdm:measurement",
+    "xdm:unit"
+  ]
+}