Bug 1688698 - Add 'source' to TopSites schemas in Contextual Services (mozilla-services#657)

Author: ncloudioj

schemas/contextual-services/topsites-click/topsites-click.1.schema.json

@@ -46,6 +46,14 @@
       "description": "The reporting URL of the ad, normally pointing to the ad partner's reporting endpoint. It's URL encoded",
       "type": "string"
     },
+    "source": {
+      "description": "The browser location where the click was triggered",
+      "enum": [
+        "newtab",
+        "urlbar"
+      ],
+      "type": "string"
+    },
     "tile_id": {
       "description": "A unique identifier for the sponsored tile",
       "type": "integer"

schemas/contextual-services/topsites-impression/topsites-impression.1.schema.json

@@ -46,6 +46,14 @@
       "description": "The reporting URL of the ad, normally pointing to the ad partner's reporting endpoint. It's URL encoded",
       "type": "string"
     },
+    "source": {
+      "description": "The browser location where the impression was displayed",
+      "enum": [
+        "newtab",
+        "urlbar"
+      ],
+      "type": "string"
+    },
     "tile_id": {
       "description": "A unique identifier for the sponsored tile",
       "type": "integer"

templates/contextual-services/topsites-click/topsites-click.1.schema.json

@@ -13,6 +13,11 @@
       "description": "A unique identifier for the sponsored tile",
       "type": "integer"
     },
+    "source": {
+      "type": "string",
+      "enum": [ "newtab", "urlbar" ],
+      "description": "The browser location where the click was triggered"
+    },
     "position": {
       "description": "The placement of the tile (1-based)",
       "type": "integer"

templates/contextual-services/topsites-impression/topsites-impression.1.schema.json

@@ -13,6 +13,11 @@
       "description": "A unique identifier for the sponsored tile",
       "type": "integer"
     },
+    "source": {
+      "type": "string",
+      "enum": [ "newtab", "urlbar" ],
+      "description": "The browser location where the impression was displayed"
+    },
     "position": {
       "description": "The placement of the tile (1-based)",
       "type": "integer"

validation/contextual-services/topsites-click.1.event.pass.json

@@ -1,6 +1,8 @@
 {
   "context_id": "{94642acb-4996-034b-916c-147da723cc41}",
   "tile_id": 42,
+  "source": "urlbar",
+  "position": 1,
   "advertiser": "test-advertiser",
   "reporting_url": "https://test.reporting.net/ctp?version=16.0.0&key=1598991514900100001.1&ci=15 98991514792.12747&ctag=1598291839300100006&aespFlag=altinst",
   "locale": "en-US",

validation/contextual-services/topsites-impression.1.event.pass.json

@@ -2,6 +2,7 @@
   "context_id": "{94642acb-4996-034b-916c-147da723cc41}",
   "advertiser": "test-advertiser",
   "tile_id": 42,
+  "source": "newtab",
   "position": 1,
   "reporting_url": "https://test.reporting.net/static?id=7RHzfOIWHG7kJnEYgGeuJm7vJ%3DEkiFXwxYIZjF8XgClWfC 8%2B7R4dHQ8zjmENj%3DNwxwz%2FJmdw7R4dHQfz4Z2ZfplnHG3Z5FwqgCfX4ZLafC2mfBINI9HuiF2 z4Z2ZfplnHmcux%3DcvImauiF2zfQlWfpDX7R3%2Bx%3DDuiF2zfLyy",
   "locale": "en-US",