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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
|
# 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 :: Shopping"
shopping.settings:
nimbus_disabled_shopping:
type: boolean
lifetime: application
description: |
Indicates if Nimbus has disabled the use the shopping component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1845822
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1845822
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- metrics
telemetry_mirror: SHOPPING_NIMBUS_DISABLED
component_opted_out:
type: boolean
lifetime: application
description: |
Indicates if the user has opted out of using the shopping component.
Set during shopping component init and updated when changed in browser.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1845822
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1845822
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- metrics
telemetry_mirror: SHOPPING_COMPONENT_OPTED_OUT
has_onboarded:
type: boolean
lifetime: application
description: |
Indicates if the user has completed the Shopping product Onboarding
experience. Set during shopping component init and updated when changed
in browser.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1845822
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1845822
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- metrics
telemetry_mirror: SHOPPING_HAS_ONBOARDED
disabled_ads:
type: boolean
lifetime: application
description: |
Indicates if the user has manually disabled ads. Set during shopping
component init and updated when changed in browser.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1858540
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1858540
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- metrics
telemetry_mirror: SHOPPING_DISABLED_ADS
auto_open_user_disabled:
type: boolean
lifetime: application
description: |
Indicates if the user has manually disabled the auto open sidebar feature.
Set during shopping component init and updated when changed in browser.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879119
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879119
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- metrics
telemetry_mirror: SHOPPING_AUTO_OPEN_USER_DISABLED
shopping:
surface_displayed:
type: event
description: |
The Shopping product Sidebar was displayed.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849236
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848870#c2
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
side_bar_state:
type: string
description: |
Which of the possible configurations of the sidebar was displayed.
surface_reanalyze_clicked:
type: event
description: |
The user clicked to REanalyze reviews in the shopping side bar. This
metric does not contain any information about the product the user is
viewing or any displayed trusted deals.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848870
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848870
data_sensitivity:
- interaction
expires: 134
send_in_pings:
- events
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
surface_show_quality_explainer_clicked:
type: event
description: |
The user clicked to see the explanation of Review Quality in the
shopping component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849382
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849382
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
action:
description: >
Whether the button was used to expand or collapse the quality
explainer card.
Possible values are `expanded` and `collapsed`.
type: string
surface_settings_expand_clicked:
type: event
description: |
The user opened the settings menu of the shopping component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849382
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849382
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
action:
description: >
Whether the button was used to expand or collapse the settings card.
Possible values are `expanded` and `collapsed`.
type: string
surface_closed:
type: event
description: |
The user opened the settings menu of the shopping component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849240
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
source:
description: >
The source of the close event. For example, whether the shopping
sidebar was closed with the close button or the icon in the
address bar.
type: string
address_bar_icon_clicked:
type: event
description: |
The Shopping product Address Bar Icon was clicked by the user.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849239
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
action:
description: >
Whether the icon was used to open or close the Shopping sidebar.
type: string
surface_show_more_reviews_button_clicked:
type: event
description: |
The user clicked to expand the recent reviews to see more.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849241
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849241
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
send_in_pings:
- events
extra_keys:
action:
description: >
Whether the button was used to expand or collapse the more reviews
card.
type: string
surface_show_terms_clicked:
type: event
description: |
The user clicked to view the Terms of Service.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849899
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_show_privacy_policy_clicked:
type: event
description: |
The user clicked to view the Privacy Policy.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849899
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_not_now_clicked:
type: event
description: |
The user clicked 'Not Now' to dismiss the dialog.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849899
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_opt_in_clicked:
type: event
description: |
The user clicked the "Yes, try it" element to use the Shopping product's
functionality.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849899
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_onboarding_displayed:
type: event
description: |
The Shopping Side bar displayed the onboarding experience.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849899
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
configuration:
description: >
Which version of the onboarding experience the user was shown.
type: string
surface_no_review_reliability_available:
type: event
description: |
Review reliability was not available for display in the shopping side
bar. This metric does not contain any information about the product
the user is viewing.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849243
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892#c6
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_analyze_reviews_none_available_clicked:
type: event
description: |
The user clicked to analyze reviews in the case the reliability rating
was not available for display in the shopping side bar. This metric
does not contain any information about the product the user is viewing.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849244
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_learn_more_clicked:
type: event
description: |
The user clicked the 'Learn More' link in the Shopping onboarding
experience.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1851820
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1851820#c2
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_show_quality_explainer_url_clicked:
type: event
description: |
The user clicked to see the explanation of Review Quality in the
shopping component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849382
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848870
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
address_bar_icon_displayed:
type: event
description: |
The Shopping product Address Bar Icon was displayed to the user.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1851036
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1841892
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_reactivated_button_clicked:
type: event
description: |
The user clicked the reactivated product button.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1851675
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1851675#c4
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_stale_analysis_shown:
type: event
description: |
The user was shown the dialogue box indicating that analysis of a product
was stale. No information about the product is included.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1854223
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1854223
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
product_page_visits:
type: counter
description: |
Counts number of visits to a supported retailer product page
while enrolled in either the control or treatment branches
of the shopping experiment.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848160
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848160
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- metrics
telemetry_mirror: SHOPPING_PRODUCT_PAGE_VISITS
surface_powered_by_fakespot_link_clicked:
type: event
description: |
The user clicked the "Fakespot by Mozilla" link in the shopping side
bar.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1853785
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1853785
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
address_bar_feature_callout_displayed:
type: event
description: |
The user was shown the feature callout for the Shopping component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1854376
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1854376
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
configuration:
description: >
Message id for the version of the feature callout shown.
type: string
surface_ads_clicked:
type: event
description: |
An ad shown in the sidebar was clicked.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1855812
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1855812
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_ads_impression:
type: event
description: |
An ad was shown and visible in the sidebar for 1.5 seconds.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1855810
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1855810
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_ads_placement:
type: event
description: |
An ad unit was fetched successfully.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1872872
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1872872
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_no_ads_available:
type: event
description: |
On a supported product page, the review checker showed analysis, and
review checker ads were enabled, but when we tried to fetch an ad from
the ad server, no ad was available.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1855811
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1855811
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
ads_exposure:
type: event
description: |
On a supported product page, the review checker showed analysis, and
the ads exposure pref was enabled, or review checker ads were enabled,
and when we tried to fetch an ad from the ad server, an ad was available.
Does not indicate whether the ad was actually shown.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1858470
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1858470
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_ads_setting_toggled:
type: event
description: |
The user clicked the settings toggle to enable or disable ads in the
sidebar settings component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1858540
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1858540
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
action:
description: >
Whether the toggle was used to enable or disable ads. Possible values
are `enabled` and `disabled`.
type: string
surface_opt_out_button_clicked:
type: event
description: |
The user clicked the button in the settings panel to turn off the shopping experience.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1869413
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1869413
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_auto_open_setting_toggled:
type: event
description: |
The user clicked the settings toggle to enable or disable auto-open in the
sidebar settings component.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879125
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879125
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
extra_keys:
action:
description: >
Whether the toggle was used to enable or disable auto-open. Possible values
are `enabled` and `disabled`.
type: string
surface_no_thanks_button_clicked:
type: event
description: |
The user clicks the 'No thanks' button when asked if they want to
disable auto-open behavior.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879127
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879127
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
surface_yes_keep_closed_button_clicked:
type: event
description: |
The user clicks the 'Yes, keep closed' button when asked if they want to
disable auto-open behavior.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879127
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1879127
data_sensitivity:
- interaction
expires: 134
notification_emails:
- betling@mozilla.com
- fx-desktop-shopping-eng@mozilla.com
send_in_pings:
- events
|
