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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_PROMOS_PROMOS_UTILS_H_
#define CHROME_BROWSER_PROMOS_PROMOS_UTILS_H_
#include <string>
#include "base/feature_list.h"
#include "base/memory/raw_ptr.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/segmentation_platform/public/result.h"
enum class IOSPromoType;
class PrefService;
class Profile;
namespace syncer {
class SyncService;
} // namespace syncer
namespace promos_utils {
// IOSPromoPrefsConfig is the structure to configure the promo prefs,
// including the feature, the impressions counter and opt out.
struct IOSPromoPrefsConfig {
IOSPromoPrefsConfig();
explicit IOSPromoPrefsConfig(IOSPromoType promo_type);
IOSPromoPrefsConfig(const IOSPromoPrefsConfig& promo_config);
~IOSPromoPrefsConfig();
raw_ptr<const base::Feature> promo_feature;
std::string promo_impressions_counter_pref_name;
std::string promo_opt_out_pref_name;
std::string promo_last_impression_timestamp_pref_name;
};
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
// Enum for different action values possible used in the
// IOS.Desktop.{PromoType}.{Impression}.Action histogram.
// LINT.IfChange
enum class DesktopIOSPromoAction {
kDismissed = 0,
kNoThanksClicked = 1,
kMaxValue = kNoThanksClicked
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/ios/enums.xml)
// Enum for different impression values possible used in the
// IOS.Desktop.{PromoType}.Shown histogram. This must match enums.xml.
// LINT.IfChange
enum class DesktopIOSPromoImpression {
kFirstImpression = 0,
kSecondImpression = 1,
kThirdImpression = 2,
kMaxValue = kThirdImpression
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/ios/enums.xml)
// Amount of days of data to look back on for the segmentation platform model's
// input data for the iOS Desktop promos.
inline constexpr int kiOSDesktopPromoLookbackWindow = 60;
// GetIOSDesktopPromoFeatureEngagement gets the correct "Feature Engagement
// Tracker" feature for the given promo type.
const base::Feature& GetIOSDesktopPromoFeatureEngagement(
IOSPromoType promo_type);
// RegisterProfilePrefs is a helper to register the synced profile prefs.
void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
// RecordIOSDesktopPromoUserInteractionHistogram records the action taken
// by the user on the iOS promo depending on the promo type and which
// impression being shown.
void RecordIOSDesktopPromoUserInteractionHistogram(
IOSPromoType promo_type,
int impression_count,
DesktopIOSPromoAction action);
// ShouldShowIOSDesktopPromo checks if the user should be shown the iOS desktop
// promo (all criteria are met) depending on the given promo type, and returns
// true if so.
bool ShouldShowIOSDesktopPromo(Profile* profile,
const syncer::SyncService* sync_service,
IOSPromoType promo_type);
// Checks if the user should be shown the Desktop NTP promo based on the current
// criteria.
bool ShouldShowIOSDesktopNtpPromo(Profile* profile,
const syncer::SyncService* sync_service);
// Processes the results of the user classification to make sure there were
// no errors and the user is not classified as a switcher from a mobile
// device by the segmentation platform (i.e. return true if the promo should
// be shown).
bool UserNotClassifiedAsMobileDeviceSwitcher(
const segmentation_platform::ClassificationResult& result);
// IOSDesktopPromoShown sets the updated last impression timestamp,
// increments the impression counter for the given iOS promo type and records
// the necessary histogram.
void IOSDesktopPromoShown(Profile* profile, IOSPromoType promo_type);
// Updates any necessary prefs for when the promo is shown.
void IOSDesktopNtpPromoShown(PrefService* pref_service);
} // namespace promos_utils
#endif // CHROME_BROWSER_PROMOS_PROMOS_UTILS_H_
|
