File: offers_metrics.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 6,122,156 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (125 lines) | stat: -rw-r--r-- 5,536 bytes parent folder | download | duplicates (6)
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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_PAYMENTS_OFFERS_METRICS_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_PAYMENTS_OFFERS_METRICS_H_

#include <memory>
#include <vector>

#include "components/autofill/core/browser/data_model/payments/autofill_offer_data.h"
#include "services/metrics/public/cpp/ukm_source_id.h"

namespace autofill::autofill_metrics {

// Metrics to track event when the offer notification bubble is closed.
enum class OfferNotificationBubbleResultMetric {
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.

  // The user explicitly acknowledged the bubble by clicking the ok button.
  OFFER_NOTIFICATION_BUBBLE_ACKNOWLEDGED = 0,
  // The user explicitly closed the prompt with the close button or ESC.
  OFFER_NOTIFICATION_BUBBLE_CLOSED = 1,
  // The user did not interact with the prompt.
  OFFER_NOTIFICATION_BUBBLE_NOT_INTERACTED = 2,
  // The prompt lost focus and was deactivated.
  OFFER_NOTIFICATION_BUBBLE_LOST_FOCUS = 3,
  kMaxValue = OFFER_NOTIFICATION_BUBBLE_LOST_FOCUS,
};

// Metrics to track events related to the offers suggestions popup.
enum class OffersSuggestionsPopupEvent {
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.

  // Default value, should never be used.
  kUndefined = 0,
  // The offer suggestions popup was shown. One event is logged in this metric
  // bucket per time that the overall popup is shown.
  kOffersSuggestionsPopupShown = 1,
  // The offers suggestions popup was shown. Logged once if the user repeatedly
  // displays suggestions for the same field.
  kOffersSuggestionsPopupShownOnce = 2,
  kMaxValue = kOffersSuggestionsPopupShownOnce,
};

// Metrics to track events related to individual offer suggestions in the
// offers suggestions popup.
enum class OffersSuggestionsEvent {
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.

  // Default value, should never be used.
  kUndefined = 0,
  // An individual offer suggestion was shown. One event is logged in this
  // metric bucket for each individual offer suggestion in the suggestions
  // popup. For instance, if there are three offers suggested, this bucket would
  // log three times.
  kOfferSuggestionShown = 1,
  // An individual offer suggestion was shown. Logged once if the user
  // repeatedly displays suggestions for the same field.
  kOfferSuggestionShownOnce = 2,
  // An individual offer suggestion was selected.
  kOfferSuggestionSelected = 3,
  // An individual offer suggestion was selected. Logged once if the user
  // repeatedly selects suggestions for the same field.
  kOfferSuggestionSelectedOnce = 4,
  // The user selected to see the offer details page in the footer.
  kOfferSuggestionSeeOfferDetailsSelected = 5,
  // The user selected to see the offer details page in the footer. Logged once
  // if the user repeatedly selects to see the offer details page in the footer
  // for the same field.
  kOfferSuggestionSeeOfferDetailsSelectedOnce = 6,
  kMaxValue = kOfferSuggestionSeeOfferDetailsSelectedOnce,
};

// Logs when the offer notification bubble shows. Records histogram of
// what type of offer is showing in the bubble and whether the bubble is opened
// by reshow.
void LogOfferNotificationBubbleOfferMetric(
    AutofillOfferData::OfferType offer_type,
    bool is_reshow);

// Logs when the promo code button is clicked in the offer notification bubble.
// Records histogram of what type of offer is showing in the bubble that
// is being clicked.
void LogOfferNotificationBubblePromoCodeButtonClicked(
    AutofillOfferData::OfferType offer_type);

// Logs when the offer notification bubble closes. Records histogram of
// what type of offer is in the bubble that is being closed, and whether the
// bubble is from reshowing.
void LogOfferNotificationBubbleResultMetric(
    AutofillOfferData::OfferType offer_type,
    OfferNotificationBubbleResultMetric metric,
    bool is_reshow);

// Logs when the offer notification bubble is suppressed. Records histogram
// of what type of offer is showing in the bubble that is being
// suppressed.
void LogOfferNotificationBubbleSuppressed(
    AutofillOfferData::OfferType offer_type);

// Log that the offers suggestions popup was shown. If `first_time_being_logged`
// is true, it represents that it has not been logged yet for the promo code
// offer field that the user is on, so additional logging is needed for the
// histogram that denotes showing the offers suggestions popup once for a field.
void LogOffersSuggestionsPopupShown(bool first_time_being_logged);

// Log the offers suggestions popup `event` for the corresponding `offer_type`.
void LogIndividualOfferSuggestionEvent(OffersSuggestionsEvent event,
                                       AutofillOfferData::OfferType offer_type);

// Logs the offer data associated with a profile. This should be called each
// time a Chrome profile is launched.
void LogStoredOfferMetrics(
    const std::vector<std::unique_ptr<AutofillOfferData>>& offers);

// Logs whether the synced autofill offer data is valid.
void LogSyncedOfferDataBeingValid(bool invalid);

}  // namespace autofill::autofill_metrics

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_PAYMENTS_OFFERS_METRICS_H_