diff --git a/schemas/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json b/schemas/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json index 7a2625594..ba7535b50 100644 --- a/schemas/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json +++ b/schemas/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json @@ -90,6 +90,14 @@ "description": "The source of the suggestion, either “remote-settings” or “merino”. See bug 1839487", "type": "string" }, + "suggested_index": { + "description": "The intended index of the QuickSuggest suggestion. If `suggested_index_relative_to_group` is true, the index is relative to the Firefox Suggest group; otherwise the index is relative to the entire list of suggestions. Non-negative values (starting at 0) are relative to the start/top of the group/list; negative values are relative to the end/bottom of the group/list.", + "type": "integer" + }, + "suggested_index_relative_to_group": { + "description": "Whether `suggested_index` is relative to the Firefox Suggest group. If false, it is relative to the entire list of suggestions.", + "type": "boolean" + }, "version": { "description": "Firefox version", "type": "string" diff --git a/schemas/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json b/schemas/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json index c62d972aa..4e76acef4 100644 --- a/schemas/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json +++ b/schemas/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json @@ -86,6 +86,14 @@ "description": "The source of the suggestion, either “remote-settings” or “merino”. See bug 1779049", "type": "string" }, + "suggested_index": { + "description": "The intended index of the QuickSuggest suggestion. If `suggested_index_relative_to_group` is true, the index is relative to the Firefox Suggest group; otherwise the index is relative to the entire list of suggestions. Non-negative values (starting at 0) are relative to the start/top of the group/list; negative values are relative to the end/bottom of the group/list.", + "type": "integer" + }, + "suggested_index_relative_to_group": { + "description": "Whether `suggested_index` is relative to the Firefox Suggest group. If false, it is relative to the entire list of suggestions.", + "type": "boolean" + }, "version": { "description": "Firefox version", "type": "string" diff --git a/schemas/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json b/schemas/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json index 8e6176b19..2cb0899ce 100644 --- a/schemas/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json +++ b/schemas/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json @@ -98,6 +98,14 @@ "description": "The source of the suggestion, either “remote-settings” or “merino”. See bug 1779049", "type": "string" }, + "suggested_index": { + "description": "The intended index of the QuickSuggest suggestion. If `suggested_index_relative_to_group` is true, the index is relative to the Firefox Suggest group; otherwise the index is relative to the entire list of suggestions. Non-negative values (starting at 0) are relative to the start/top of the group/list; negative values are relative to the end/bottom of the group/list.", + "type": "integer" + }, + "suggested_index_relative_to_group": { + "description": "Whether `suggested_index` is relative to the Firefox Suggest group. If false, it is relative to the entire list of suggestions.", + "type": "boolean" + }, "version": { "description": "Firefox version", "type": "string" diff --git a/templates/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json b/templates/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json index 76a7ffa65..78f8172a8 100644 --- a/templates/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json +++ b/templates/contextual-services/quicksuggest-block/quicksuggest-block.1.schema.json @@ -35,6 +35,14 @@ "description": "The placement of the QuickSuggest link (1-based)", "type": "integer" }, + "suggested_index": { + "description": "The intended index of the QuickSuggest suggestion. If `suggested_index_relative_to_group` is true, the index is relative to the Firefox Suggest group; otherwise the index is relative to the entire list of suggestions. Non-negative values (starting at 0) are relative to the start/top of the group/list; negative values are relative to the end/bottom of the group/list.", + "type": "integer" + }, + "suggested_index_relative_to_group": { + "description": "Whether `suggested_index` is relative to the Firefox Suggest group. If false, it is relative to the entire list of suggestions.", + "type": "boolean" + }, "release_channel": { "description": "Firefox release channel", "type": "string" diff --git a/templates/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json b/templates/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json index 711e6a793..308077f31 100644 --- a/templates/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json +++ b/templates/contextual-services/quicksuggest-click/quicksuggest-click.1.schema.json @@ -21,6 +21,14 @@ "description": "The placement of the QuickSuggest link (1-based)", "type": "integer" }, + "suggested_index": { + "description": "The intended index of the QuickSuggest suggestion. If `suggested_index_relative_to_group` is true, the index is relative to the Firefox Suggest group; otherwise the index is relative to the entire list of suggestions. Non-negative values (starting at 0) are relative to the start/top of the group/list; negative values are relative to the end/bottom of the group/list.", + "type": "integer" + }, + "suggested_index_relative_to_group": { + "description": "Whether `suggested_index` is relative to the Firefox Suggest group. If false, it is relative to the entire list of suggestions.", + "type": "boolean" + }, "reporting_url": { "description": "The reporting URL of the ad, normally pointing to the ad partner's reporting endpoint. It's URL encoded", "type": "string" diff --git a/templates/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json b/templates/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json index 8bc0af93a..517901b75 100644 --- a/templates/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json +++ b/templates/contextual-services/quicksuggest-impression/quicksuggest-impression.1.schema.json @@ -29,6 +29,14 @@ "description": "The placement of the QuickSuggest link (1-based)", "type": "integer" }, + "suggested_index": { + "description": "The intended index of the QuickSuggest suggestion. If `suggested_index_relative_to_group` is true, the index is relative to the Firefox Suggest group; otherwise the index is relative to the entire list of suggestions. Non-negative values (starting at 0) are relative to the start/top of the group/list; negative values are relative to the end/bottom of the group/list.", + "type": "integer" + }, + "suggested_index_relative_to_group": { + "description": "Whether `suggested_index` is relative to the Firefox Suggest group. If false, it is relative to the entire list of suggestions.", + "type": "boolean" + }, "block_id": { "description": "A unique identifier for the QuickSuggest link", "type": "integer" diff --git a/validation/contextual-services/quicksuggest-block.1.event.pass.json b/validation/contextual-services/quicksuggest-block.1.event.pass.json index e62da00e1..c79993a4c 100644 --- a/validation/contextual-services/quicksuggest-block.1.event.pass.json +++ b/validation/contextual-services/quicksuggest-block.1.event.pass.json @@ -3,6 +3,8 @@ "advertiser": "test-advertiser", "block_id": 42, "position": 9, + "suggested_index": -1, + "suggested_index_relative_to_group": true, "iab_category": "22 - Shopping", "locale": "en-US", "version": "87.0", diff --git a/validation/contextual-services/quicksuggest-click.1.event.pass.json b/validation/contextual-services/quicksuggest-click.1.event.pass.json index 4f359a9dc..e9ba55312 100644 --- a/validation/contextual-services/quicksuggest-click.1.event.pass.json +++ b/validation/contextual-services/quicksuggest-click.1.event.pass.json @@ -3,6 +3,8 @@ "advertiser": "test-advertiser", "block_id": 42, "position": 9, + "suggested_index": -1, + "suggested_index_relative_to_group": true, "reporting_url": "https://test.reporting.net/ctp?version=16.0.0&key=1598991514900100001.1&ci=15 98991514792.12747&ctag=1598291839300100006&aespFlag=altinst&ip=%IP%&ua=%UA%", "locale": "en-US", "version": "87.0", diff --git a/validation/contextual-services/quicksuggest-impression.1.event.pass.json b/validation/contextual-services/quicksuggest-impression.1.event.pass.json index 6db6d83af..72af90c51 100644 --- a/validation/contextual-services/quicksuggest-impression.1.event.pass.json +++ b/validation/contextual-services/quicksuggest-impression.1.event.pass.json @@ -5,6 +5,8 @@ "is_clicked": false, "advertiser": "test-advertiser", "position": 9, + "suggested_index": -1, + "suggested_index_relative_to_group": true, "block_id": 42, "reporting_url": "https://test.reporting.net/static?id=7RHzfOIWHG7kJnEYgGeuJm7vJ%3DEkiFXwxYIZjF8XgClWfC 8%2B7R4dHQ8zjmENj%3DNwxwz%2FJmdw7R4dHQfz4Z2ZfplnHG3Z5FwqgCfX4ZLafC2mfBINI9HuiF2 z4Z2ZfplnHmcux%3DcvImauiF2zfQlWfpDX7R3%2Bx%3DDuiF2zfLyy&ip=%IP%&ua=%UA%", "locale": "en-US",