blob: aa31b7fd479f56d0eac315937aff4fce1d18ed75 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- 'Firefox :: Search'
newtab.search:
issued:
type: event
description: >
When Firefox was asked to issue a search from a Search Access Point (SAP)
on a newtab page.
Doesn't record searches in Private Browsing Mode unless
`browser.engagement.search_counts.pbm` is set to `true`.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
- https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
- https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
data_sensitivity:
- interaction
notification_emails:
- anicholson@mozilla.com
- chutten@mozilla.com
- mmccorquodale@mozilla.com
- najiang@mozilla.com
expires: 113
extra_keys:
newtab_visit_id: &newtab_visit_id
description: >
The id of the newtab visit that originated the search.
Should always be present for handoff searches.
TODO(bug 1774597): for searches done without handoff (e.g. with
`browser.newtabpage.activity-stream.improvesearch.handoffToAwesomebar`
set to `false`), the active newtab visit id is unknown.
type: string
search_access_point: &search_access_point
description: >
One of the search access points available on the new tab like
* `urlbar_handoff`
* `about_home`
* `about_newtab`
type: string
telemetry_id: &telemetry_id
description: >
The search engine's `telemetryId`, like `google-b-d`.
This is set to be a telemetry-specific id for app-provided engines,
and is `other-<name>` for others (where `<name>` is the engine's
WebExtension name).
type: string
send_in_pings:
- newtab
newtab.search.ad:
impression:
type: event
description: >
Recorded when a newtab visit resulted in a search that
loaded a Search Engine Result Page (SERP) that contains an ad link.
And the SERP is visible.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
- https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
- https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
data_sensitivity:
- interaction
notification_emails:
- anicholson@mozilla.com
- chutten@mozilla.com
- mmccorquodale@mozilla.com
- najiang@mozilla.com
expires: 113
extra_keys:
newtab_visit_id: *newtab_visit_id
search_access_point: *search_access_point
is_follow_on: &is_follow_on
description: >
Whether the preceding search happened on a search results page.
type: boolean
is_tagged: &is_tagged
description: >
Whether the preceding search was tagged with a partner code.
type: boolean
telemetry_id: *telemetry_id
send_in_pings:
- newtab
click:
type: event
description: >
Recorded when an ad link is clicked on a Search Engine Result Page (SERP)
which was loaded by a seach that began on a newtab page.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
- https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
- https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
data_sensitivity:
- interaction
notification_emails:
- anicholson@mozilla.com
- chutten@mozilla.com
- mmccorquodale@mozilla.com
- najiang@mozilla.com
expires: 113
extra_keys:
newtab_visit_id: *newtab_visit_id
search_access_point: *search_access_point
is_follow_on: *is_follow_on
is_tagged: *is_tagged
telemetry_id: *telemetry_id
send_in_pings:
- newtab
|