chrome/browser/privacy_sandbox/privacy_sandbox_service.h - chromium/src.git - Git at Google

 // Copyright 2021 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_PRIVACY_SANDBOX_PRIVACY_SANDBOX_SERVICE_H_
 #define CHROME_BROWSER_PRIVACY_SANDBOX_PRIVACY_SANDBOX_SERVICE_H_

 #include "base/functional/callback_forward.h"
 #include "chrome/browser/privacy_sandbox/notice/notice_definitions.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "components/privacy_sandbox/canonical_topic.h"
 #include "components/privacy_sandbox/privacy_sandbox_prefs.h"
 #include "net/base/schemeful_site.h"

 class BrowserWindowInterface;

 namespace views {
 class Widget;
 }

 namespace privacy_sandbox {
 class PrivacySandboxQueueManager;
 }

 // Service which encapsulates logic related to displaying and controlling the
 // users Privacy Sandbox settings. This service contains the chrome/ specific
 // logic used by the UI, including decision making around what the users'
 // Privacy Sandbox settings should be based on their existing settings.
 // Ultimately the decisions made by this service are consumed (through
 // preferences and content settings) by the PrivacySandboxSettings located in
 // components/privacy_sandbox/, which in turn makes them available to Privacy
 // Sandbox APIs.
 class PrivacySandboxService : public KeyedService {
  public:
   // Possible types of Privacy Sandbox prompts that may be shown to the user.
   // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.privacy_sandbox
   enum class PromptType {
     kNone = 0,
     kM1Consent = 1,
     kM1NoticeROW = 2,
     kM1NoticeEEA = 3,
     kM1NoticeRestricted = 4,
     kMaxValue = kM1NoticeRestricted,
   };

   // Combination of `PromptType` from the Privacy Sandbox Service (PS) and the
   // Notice Service (NS). Used for UMA logging. The value is calculated as:
   // `ps_prompt_type | (notice_service_prompt_type << 3)`.
   // These values are persisted to logs. Entries should not be renumbered and
   // numeric values should never be reused.
   // LINT.IfChange(PrivacySandboxPromptTypeCombination)
   enum class PromptTypeCombination {
     // PS = 0 (kNone), NS = 0 (kNone)
     kPSNone_NSNone = 0,
     // PS = 1 (kM1Consent), NS = 0 (kNone)
     kPSConsent_NSNone = 1,
     // PS = 2 (kM1NoticeROW), NS = 0 (kNone)
     kPSNoticeROW_NSNone = 2,
     // PS = 3 (kM1NoticeEEA), NS = 0 (kNone)
     kPSNoticeEEA_NSNone = 3,
     // PS = 4 (kM1NoticeRestricted), NS = 0 (kNone)
     kPSNoticeRestricted_NSNone = 4,
     // PS = 0 (kNone), NS = 1 (kM1Consent)
     kPSNone_NSConsent = 8,
     // PS = 1 (kM1Consent), NS = 1 (kM1Consent)
     kPSConsent_NSConsent = 9,
     // PS = 2 (kM1NoticeROW), NS = 1 (kM1Consent)
     kPSNoticeROW_NSConsent = 10,
     // PS = 3 (kM1NoticeEEA), NS = 1 (kM1Consent)
     kPSNoticeEEA_NSConsent = 11,
     // PS = 4 (kM1NoticeRestricted), NS = 1 (kM1Consent)
     kPSNoticeRestricted_NSConsent = 12,
     // PS = 0 (kNone), NS = 2 (kM1NoticeROW)
     kPSNone_NSNoticeROW = 16,
     // PS = 1 (kM1Consent), NS = 2 (kM1NoticeROW)
     kPSConsent_NSNoticeROW = 17,
     // PS = 2 (kM1NoticeROW), NS = 2 (kM1NoticeROW)
     kPSNoticeROW_NSNoticeROW = 18,
     // PS = 3 (kM1NoticeEEA), NS = 2 (kM1NoticeROW)
     kPSNoticeEEA_NSNoticeROW = 19,
     // PS = 4 (kM1NoticeRestricted), NS = 2 (kM1NoticeROW)
     kPSNoticeRestricted_NSNoticeROW = 20,
     // PS = 0 (kNone), NS = 3 (kM1NoticeEEA)
     kPSNone_NSNoticeEEA = 24,
     // PS = 1 (kM1Consent), NS = 3 (kM1NoticeEEA)
     kPSConsent_NSNoticeEEA = 25,
     // PS = 2 (kM1NoticeROW), NS = 3 (kM1NoticeEEA)
     kPSNoticeROW_NSNoticeEEA = 26,
     // PS = 3 (kM1NoticeEEA), NS = 3 (kM1NoticeEEA)
     kPSNoticeEEA_NSNoticeEEA = 27,
     // PS = 4 (kM1NoticeRestricted), NS = 3 (kM1NoticeEEA)
     kPSNoticeRestricted_NSNoticeEEA = 28,
     // PS = 0 (kNone), NS = 4 (kM1NoticeRestricted)
     kPSNone_NSNoticeRestricted = 32,
     // PS = 1 (kM1Consent), NS = 4 (kM1NoticeRestricted)
     kPSConsent_NSNoticeRestricted = 33,
     // PS = 2 (kM1NoticeROW), NS = 4 (kM1NoticeRestricted)
     kPSNoticeROW_NSNoticeRestricted = 34,
     // PS = 3 (kM1NoticeEEA), NS = 4 (kM1NoticeRestricted)
     kPSNoticeEEA_NSNoticeRestricted = 35,
     // PS = 4 (kM1NoticeRestricted), NS = 4 (kM1NoticeRestricted)
     kPSNoticeRestricted_NSNoticeRestricted = 36,
     kMaxValue = kPSNoticeRestricted_NSNoticeRestricted,
   };
   // LINT.ThenChange(//tools/metrics/histograms/metadata/privacy/enums.xml:PrivacySandboxPromptTypeCombination)

   // A list of the client surfaces we show consents / notices on.
   // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.privacy_sandbox
   enum class SurfaceType {
     kDesktop = 0,
     kBrApp = 1,
     kAGACCT = 2,
     kMaxValue = kAGACCT,
   };

   // An exhaustive list of actions related to showing & interacting with the
   // prompt. Includes actions which do not impact consent / notice state.
   // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.privacy_sandbox
   enum class PromptAction {
     // Notice Interactions:
     kNoticeShown = 0,
     kNoticeOpenSettings = 1,
     kNoticeAcknowledge = 2,
     kNoticeDismiss = 3,

     // Implies that the browser, or browser window, was shut before the user
     // interacted with the notice.
     kNoticeClosedNoInteraction = 4,

     // Consent Interactions:
     kConsentShown = 5,
     kConsentAccepted = 6,
     kConsentDeclined = 7,
     kConsentMoreInfoOpened = 8,
     kConsentMoreInfoClosed = 9,

     // Implies that the browser, or browser window, was shut before the user
     // has made the decision (accepted or declined the consent).
     kConsentClosedNoDecision = 10,

     // TODO(crbug.com/386240885): Clean up old learn more, as it is not used for
     // any of the Privacy Sandbox Dialogs anymore.
     // Interaction with notice bubble: click on the link to open interests
     // settings.
     kNoticeLearnMore = 11,

     // Interactions with M1 Notice ROW prompt and M1 Notice EEA prompt.
     kNoticeMoreInfoOpened = 12,
     kNoticeMoreInfoClosed = 13,

     // The button is shown only when the prompt content isn't fully visible.
     kConsentMoreButtonClicked = 14,
     kNoticeMoreButtonClicked = 15,

     // Restricted notice interactions
     kRestrictedNoticeAcknowledge = 16,
     kRestrictedNoticeOpenSettings = 17,
     kRestrictedNoticeShown = 18,
     kRestrictedNoticeClosedNoInteraction = 19,
     kRestrictedNoticeMoreButtonClicked = 20,

     // Privacy policy interactions
     kPrivacyPolicyLinkClicked = 21,

     // Interactions with M1 Notice EEA Prompt. This is in relation to Ads API UX
     // Enhancement splitting the more info into two different sections.
     kNoticeSiteSuggestedAdsMoreInfoOpened = 22,
     kNoticeSiteSuggestedAdsMoreInfoClosed = 23,
     kNoticeAdsMeasurementMoreInfoOpened = 24,
     kNoticeAdsMeasurementMoreInfoClosed = 25,

     kMaxValue = kNoticeAdsMeasurementMoreInfoClosed,
   };

   // If during the trials a previous consent decision was made, or the notice
   // was already acknowledged, and the privacy sandbox is disabled,
   // `prefs::kPrivacySandboxM1PromptSuppressed` was set to either
   // `kTrialsConsentDeclined` or `kTrialsDisabledAfterNotice` accordingly and
   // the prompt is suppressed. This logic is now deprecated after launching GA.
   enum class PromptSuppressedReason {
     // Prompt has never been suppressed
     kNone = 0,
     // User had the Privacy Sandbox restricted at confirmation
     kRestricted = 1,
     // User was blocking 3PC when we attempted consent
     kThirdPartyCookiesBlocked = 2,
     // User declined the trials consent
     kTrialsConsentDeclined = 3,
     // User saw trials notice, and then disabled trials
     kTrialsDisabledAfterNotice = 4,
     // A policy is suppressing any prompt
     kPolicy = 5,
     // User migrated from EEA to ROW, and had already previously finished the
     // EEA consent flow.
     kEEAFlowCompletedBeforeRowMigration = 6,
     // User migrated from ROW to EEA, but had already disabled Topics from
     // settings.
     kROWFlowCompletedAndTopicsDisabledBeforeEEAMigration = 7,
     // The user is restricted with a guardian, so a direct notice is shown.
     kNoticeShownToGuardian = 8,
     kMaxValue = kNoticeShownToGuardian,
   };

   // Contains the possible states of the prompt start up states for m1.
   // LINT.IfChange(SettingsPrivacySandboxPromptStartupState)
   enum class PromptStartupState {
     kEEAConsentPromptWaiting = 0,
     kEEANoticePromptWaiting = 1,
     kROWNoticePromptWaiting = 2,
     kEEAFlowCompletedWithTopicsAccepted = 3,
     kEEAFlowCompletedWithTopicsDeclined = 4,
     kROWNoticeFlowCompleted = 5,
     kPromptNotShownDueToPrivacySandboxRestricted = 6,
     kPromptNotShownDueTo3PCBlocked = 7,
     kPromptNotShownDueToTrialConsentDeclined = 8,
     kPromptNotShownDueToTrialsDisabledAfterNoticeShown = 9,
     kPromptNotShownDueToManagedState = 10,
     kRestrictedNoticeNotShownDueToNoticeShownToGuardian = 11,
     kRestrictedNoticePromptWaiting = 12,
     kRestrictedNoticeFlowCompleted = 13,
     kRestrictedNoticeNotShownDueToFullNoticeAcknowledged = 14,
     kWaitingForGraduationRestrictedNoticeFlowNotCompleted = 15,
     kWaitingForGraduationRestrictedNoticeFlowCompleted = 16,
     kMaxValue = kWaitingForGraduationRestrictedNoticeFlowCompleted,
   };
   // LINT.ThenChange(//tools/metrics/histograms/metadata/settings/enums.xml:SettingsPrivacySandboxPromptStartupState)

   // Enum for the different events that can be triggered from the
   // PrivacySandboxApis Dialog. It used to bubble up some Dialog events to other
   // components.
   enum class AdsDialogCallbackNoArgsEvents {
     kShowDialog,
     kCloseDialog,
     kOpenAdsPrivacySettings,
     kOpenMeasurementSettings,
   };

   // Returns the prompt type that should be shown to the user. This consults
   // previous consent / notice information stored in preferences, the
   // current state of the Privacy Sandbox settings, and the current location
   // of the user, to determine the appropriate type. This is expected to be
   // called by UI code locations determining whether a prompt should be
   // shown on startup.
   virtual PromptType GetRequiredPromptType(SurfaceType surface_type) = 0;

   // Informs the service that |action| occurred with the prompt. This allows
   // the service to record this information in preferences such that future
   // calls to GetRequiredPromptType() are correct. This is expected to be
   // called appropriately by all locations showing the prompt. Metrics
   // shared between platforms will also be recorded.
   virtual void PromptActionOccurred(PromptAction action,
                                     SurfaceType surface_type) = 0;

   // Functions for coordinating the display of the Privacy Sandbox prompts
   // across multiple browser windows. Only relevant for Desktop.

 #if !BUILDFLAG(IS_ANDROID)
   // Informs the service that a Privacy Sandbox prompt has been opened
   // or closed for |browser|.
   virtual void PromptOpenedForBrowser(BrowserWindowInterface* browser,
                                       views::Widget* widget) = 0;
   virtual void PromptClosedForBrowser(BrowserWindowInterface* browser) = 0;

   // Returns whether a Privacy Sandbox prompt is currently open for |browser|.
   virtual bool IsPromptOpenForBrowser(BrowserWindowInterface* browser) = 0;

   virtual privacy_sandbox::PrivacySandboxQueueManager&
   GetPrivacySandboxNoticeQueueManager() = 0;
 #endif  // !BUILDFLAG(IS_ANDROID)

   // If set to true, this treats the testing environment as that of a branded
   // Chrome build.
   virtual void ForceChromeBuildForTests(bool force_chrome_build) = 0;

   // Returns whether the Privacy Sandbox is currently restricted for the
   // profile. UI code should consult this to ensure that when restricted,
   // Privacy Sandbox related UI is updated appropriately.
   virtual bool IsPrivacySandboxRestricted() = 0;

   // Returns whether the Privacy Sandbox is configured to show a restricted
   // notice.
   virtual bool IsRestrictedNoticeEnabled() = 0;

   // Toggles the RelatedWebsiteSets preference.
   virtual void SetRelatedWebsiteSetsDataAccessEnabled(bool enabled) = 0;

   // Returns whether the RelatedWebsiteSets preference is enabled.
   virtual bool IsRelatedWebsiteSetsDataAccessEnabled() const = 0;

   // Returns whether the RelatedWebsiteSets preference is managed.
   virtual bool IsRelatedWebsiteSetsDataAccessManaged() const = 0;

   // Returns the owner domain of the related website set that `site_url` is a
   // member of, or std::nullopt if `site_url` is not recognised as a member of
   // an RWS. Encapsulates logic about whether RWS information should be shown,
   // if it should not, std::nullopt is always returned. Virtual for mocking in
   // tests.
   virtual std::optional<net::SchemefulSite> GetRelatedWebsiteSetOwner(
       const GURL& site_url) const = 0;

   // Same as GetRelatedWebsiteSetOwner but returns a formatted string.
   virtual std::optional<std::u16string> GetRelatedWebsiteSetOwnerForDisplay(
       const GURL& site_url) const = 0;

   // Returns true if `site`'s membership in an RWS is being managed by policy or
   // if RelatedWebsiteSets preference is managed. Virtual for mocking in tests.
   //
   // Note: Enterprises can use the Related Website Set Overrides policy to
   // either add or remove a site from a Related Website Set. This method returns
   // true only if `site` is being added into a Related Website Set since there's
   // no UI use for whether `site` is being removed by an enterprise yet.
   virtual bool IsPartOfManagedRelatedWebsiteSet(
       const net::SchemefulSite& site) const = 0;

   // Returns the set of eTLD + 1's on which the user was joined to a FLEDGE
   // interest group. Consults with the InterestGroupManager associated with
   // |profile_| and formats the returned data for direct display to the user.
   virtual void GetFledgeJoiningEtldPlusOneForDisplay(
       base::OnceCallback<void(std::vector<std::string>)> callback) = 0;

   // Returns the set of top frames which are blocked from joining the profile to
   // an interest group.
   virtual std::vector<std::string> GetBlockedFledgeJoiningTopFramesForDisplay()
       const = 0;

   // Sets Fledge interest group joining to |allowed| for |top_frame_etld_plus1|.
   // Forwards the setting to the PrivacySandboxSettings service, but also
   // removes any Fledge data for the |top_frame_etld_plus1| if |allowed| is
   // false.
   virtual void SetFledgeJoiningAllowed(const std::string& top_frame_etld_plus1,
                                        bool allowed) const = 0;

   // Returns the top topics for the previous N epochs.
   // Virtual for mocking in tests.
   virtual std::vector<privacy_sandbox::CanonicalTopic> GetCurrentTopTopics()
       const = 0;

   // Returns the set of topics which have been blocked by the user.
   // Virtual for mocking in tests.
   virtual std::vector<privacy_sandbox::CanonicalTopic> GetBlockedTopics()
       const = 0;

   // Returns the first level topic: they are the root topics, meaning that they
   // have no parent.
   virtual std::vector<privacy_sandbox::CanonicalTopic> GetFirstLevelTopics()
       const = 0;

   // Returns the list of assigned children topics (direct or indirect) of the
   // passed-in topic.
   virtual std::vector<privacy_sandbox::CanonicalTopic>
   GetChildTopicsCurrentlyAssigned(
       const privacy_sandbox::CanonicalTopic& topic) const = 0;

   // Sets a |topic_id|, as both a top topic and topic provided to the web, to be
   // allowed/blocked based on the value of |allowed|. This is stored to
   // preferences and made available to the Topics API via the
   // PrivacySandboxSettings class. This function expects that |topic| will have
   // previously been provided by one of the above functions. Virtual for mocking
   // in tests.
   virtual void SetTopicAllowed(privacy_sandbox::CanonicalTopic topic,
                                bool allowed) = 0;

   // Determines whether the Topics API step should be shown in the Privacy
   // Guide.
   virtual bool PrivacySandboxPrivacyGuideShouldShowAdTopicsCard() = 0;

   // Determines whether the China domain should be used for the Privacy Policy
   // page.
   virtual bool ShouldUsePrivacyPolicyChinaDomain() = 0;

   // Inform the service that the user changed the Topics toggle in settings,
   // so that the current topics consent information can be updated.
   // This is not fired for changes to the preference for policy or extensions,
   // and so consent information only represents direct user actions. Note that
   // extensions and policy can only _disable_ topics, and so cannot bypass the
   // need for user consent where required.
   // Virtual for mocking in tests.
   virtual void TopicsToggleChanged(bool new_value) const = 0;

   // Whether the current profile requires consent for Topics to operate.
   virtual bool TopicsConsentRequired() = 0;

   // Whether there is an active consent for Topics currently recorded.
   virtual bool TopicsHasActiveConsent() const = 0;

   // Functions which returns the details of the currently recorded Topics
   // consent.
   virtual privacy_sandbox::TopicsConsentUpdateSource
   TopicsConsentLastUpdateSource() const = 0;
   virtual base::Time TopicsConsentLastUpdateTime() const = 0;
   virtual std::string TopicsConsentLastUpdateText() const = 0;

   // Notice Framework Result Callbacks.
   virtual void UpdateTopicsApiResult(bool value) = 0;
   virtual void UpdateProtectedAudienceApiResult(bool value) = 0;
   virtual void UpdateMeasurementApiResult(bool value) = 0;
   // Notice Framework Eligibility Callbacks.
   virtual privacy_sandbox::EligibilityLevel GetTopicsApiEligibility() = 0;
   virtual privacy_sandbox::EligibilityLevel
   GetProtectedAudienceApiEligibility() = 0;
   virtual privacy_sandbox::EligibilityLevel
   GetAdMeasurementApiEligibility() = 0;
 };

 #endif  // CHROME_BROWSER_PRIVACY_SANDBOX_PRIVACY_SANDBOX_SERVICE_H_
	// Copyright 2021 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_PRIVACY_SANDBOX_PRIVACY_SANDBOX_SERVICE_H_
	#define CHROME_BROWSER_PRIVACY_SANDBOX_PRIVACY_SANDBOX_SERVICE_H_

	#include "base/functional/callback_forward.h"
	#include "chrome/browser/privacy_sandbox/notice/notice_definitions.h"
	#include "components/keyed_service/core/keyed_service.h"
	#include "components/privacy_sandbox/canonical_topic.h"
	#include "components/privacy_sandbox/privacy_sandbox_prefs.h"
	#include "net/base/schemeful_site.h"

	class BrowserWindowInterface;

	namespace views {
	class Widget;
	}

	namespace privacy_sandbox {
	class PrivacySandboxQueueManager;
	}

	// Service which encapsulates logic related to displaying and controlling the
	// users Privacy Sandbox settings. This service contains the chrome/ specific
	// logic used by the UI, including decision making around what the users'
	// Privacy Sandbox settings should be based on their existing settings.
	// Ultimately the decisions made by this service are consumed (through
	// preferences and content settings) by the PrivacySandboxSettings located in
	// components/privacy_sandbox/, which in turn makes them available to Privacy
	// Sandbox APIs.
	class PrivacySandboxService : public KeyedService {
	public:
	// Possible types of Privacy Sandbox prompts that may be shown to the user.
	// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.privacy_sandbox
	enum class PromptType {
	kNone = 0,
	kM1Consent = 1,
	kM1NoticeROW = 2,
	kM1NoticeEEA = 3,
	kM1NoticeRestricted = 4,
	kMaxValue = kM1NoticeRestricted,
	};

	// Combination of `PromptType` from the Privacy Sandbox Service (PS) and the
	// Notice Service (NS). Used for UMA logging. The value is calculated as:
	// `ps_prompt_type \| (notice_service_prompt_type << 3)`.
	// These values are persisted to logs. Entries should not be renumbered and
	// numeric values should never be reused.
	// LINT.IfChange(PrivacySandboxPromptTypeCombination)
	enum class PromptTypeCombination {
	// PS = 0 (kNone), NS = 0 (kNone)
	kPSNone_NSNone = 0,
	// PS = 1 (kM1Consent), NS = 0 (kNone)
	kPSConsent_NSNone = 1,
	// PS = 2 (kM1NoticeROW), NS = 0 (kNone)
	kPSNoticeROW_NSNone = 2,
	// PS = 3 (kM1NoticeEEA), NS = 0 (kNone)
	kPSNoticeEEA_NSNone = 3,
	// PS = 4 (kM1NoticeRestricted), NS = 0 (kNone)
	kPSNoticeRestricted_NSNone = 4,
	// PS = 0 (kNone), NS = 1 (kM1Consent)
	kPSNone_NSConsent = 8,
	// PS = 1 (kM1Consent), NS = 1 (kM1Consent)
	kPSConsent_NSConsent = 9,
	// PS = 2 (kM1NoticeROW), NS = 1 (kM1Consent)
	kPSNoticeROW_NSConsent = 10,
	// PS = 3 (kM1NoticeEEA), NS = 1 (kM1Consent)
	kPSNoticeEEA_NSConsent = 11,
	// PS = 4 (kM1NoticeRestricted), NS = 1 (kM1Consent)
	kPSNoticeRestricted_NSConsent = 12,
	// PS = 0 (kNone), NS = 2 (kM1NoticeROW)
	kPSNone_NSNoticeROW = 16,
	// PS = 1 (kM1Consent), NS = 2 (kM1NoticeROW)
	kPSConsent_NSNoticeROW = 17,
	// PS = 2 (kM1NoticeROW), NS = 2 (kM1NoticeROW)
	kPSNoticeROW_NSNoticeROW = 18,
	// PS = 3 (kM1NoticeEEA), NS = 2 (kM1NoticeROW)
	kPSNoticeEEA_NSNoticeROW = 19,
	// PS = 4 (kM1NoticeRestricted), NS = 2 (kM1NoticeROW)
	kPSNoticeRestricted_NSNoticeROW = 20,
	// PS = 0 (kNone), NS = 3 (kM1NoticeEEA)
	kPSNone_NSNoticeEEA = 24,
	// PS = 1 (kM1Consent), NS = 3 (kM1NoticeEEA)
	kPSConsent_NSNoticeEEA = 25,
	// PS = 2 (kM1NoticeROW), NS = 3 (kM1NoticeEEA)
	kPSNoticeROW_NSNoticeEEA = 26,
	// PS = 3 (kM1NoticeEEA), NS = 3 (kM1NoticeEEA)
	kPSNoticeEEA_NSNoticeEEA = 27,
	// PS = 4 (kM1NoticeRestricted), NS = 3 (kM1NoticeEEA)
	kPSNoticeRestricted_NSNoticeEEA = 28,
	// PS = 0 (kNone), NS = 4 (kM1NoticeRestricted)
	kPSNone_NSNoticeRestricted = 32,
	// PS = 1 (kM1Consent), NS = 4 (kM1NoticeRestricted)
	kPSConsent_NSNoticeRestricted = 33,
	// PS = 2 (kM1NoticeROW), NS = 4 (kM1NoticeRestricted)
	kPSNoticeROW_NSNoticeRestricted = 34,
	// PS = 3 (kM1NoticeEEA), NS = 4 (kM1NoticeRestricted)
	kPSNoticeEEA_NSNoticeRestricted = 35,
	// PS = 4 (kM1NoticeRestricted), NS = 4 (kM1NoticeRestricted)
	kPSNoticeRestricted_NSNoticeRestricted = 36,
	kMaxValue = kPSNoticeRestricted_NSNoticeRestricted,
	};
	// LINT.ThenChange(//tools/metrics/histograms/metadata/privacy/enums.xml:PrivacySandboxPromptTypeCombination)

	// A list of the client surfaces we show consents / notices on.
	// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.privacy_sandbox
	enum class SurfaceType {
	kDesktop = 0,
	kBrApp = 1,
	kAGACCT = 2,
	kMaxValue = kAGACCT,
	};

	// An exhaustive list of actions related to showing & interacting with the
	// prompt. Includes actions which do not impact consent / notice state.
	// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.privacy_sandbox
	enum class PromptAction {
	// Notice Interactions:
	kNoticeShown = 0,
	kNoticeOpenSettings = 1,
	kNoticeAcknowledge = 2,
	kNoticeDismiss = 3,

	// Implies that the browser, or browser window, was shut before the user
	// interacted with the notice.
	kNoticeClosedNoInteraction = 4,

	// Consent Interactions:
	kConsentShown = 5,
	kConsentAccepted = 6,
	kConsentDeclined = 7,
	kConsentMoreInfoOpened = 8,
	kConsentMoreInfoClosed = 9,

	// Implies that the browser, or browser window, was shut before the user
	// has made the decision (accepted or declined the consent).
	kConsentClosedNoDecision = 10,

	// TODO(crbug.com/386240885): Clean up old learn more, as it is not used for
	// any of the Privacy Sandbox Dialogs anymore.
	// Interaction with notice bubble: click on the link to open interests
	// settings.
	kNoticeLearnMore = 11,

	// Interactions with M1 Notice ROW prompt and M1 Notice EEA prompt.
	kNoticeMoreInfoOpened = 12,
	kNoticeMoreInfoClosed = 13,

	// The button is shown only when the prompt content isn't fully visible.
	kConsentMoreButtonClicked = 14,
	kNoticeMoreButtonClicked = 15,

	// Restricted notice interactions
	kRestrictedNoticeAcknowledge = 16,
	kRestrictedNoticeOpenSettings = 17,
	kRestrictedNoticeShown = 18,
	kRestrictedNoticeClosedNoInteraction = 19,
	kRestrictedNoticeMoreButtonClicked = 20,

	// Privacy policy interactions
	kPrivacyPolicyLinkClicked = 21,

	// Interactions with M1 Notice EEA Prompt. This is in relation to Ads API UX
	// Enhancement splitting the more info into two different sections.
	kNoticeSiteSuggestedAdsMoreInfoOpened = 22,
	kNoticeSiteSuggestedAdsMoreInfoClosed = 23,
	kNoticeAdsMeasurementMoreInfoOpened = 24,
	kNoticeAdsMeasurementMoreInfoClosed = 25,

	kMaxValue = kNoticeAdsMeasurementMoreInfoClosed,
	};

	// If during the trials a previous consent decision was made, or the notice
	// was already acknowledged, and the privacy sandbox is disabled,
	// `prefs::kPrivacySandboxM1PromptSuppressed` was set to either
	// `kTrialsConsentDeclined` or `kTrialsDisabledAfterNotice` accordingly and
	// the prompt is suppressed. This logic is now deprecated after launching GA.
	enum class PromptSuppressedReason {
	// Prompt has never been suppressed
	kNone = 0,
	// User had the Privacy Sandbox restricted at confirmation
	kRestricted = 1,
	// User was blocking 3PC when we attempted consent
	kThirdPartyCookiesBlocked = 2,
	// User declined the trials consent
	kTrialsConsentDeclined = 3,
	// User saw trials notice, and then disabled trials
	kTrialsDisabledAfterNotice = 4,
	// A policy is suppressing any prompt
	kPolicy = 5,
	// User migrated from EEA to ROW, and had already previously finished the
	// EEA consent flow.
	kEEAFlowCompletedBeforeRowMigration = 6,
	// User migrated from ROW to EEA, but had already disabled Topics from
	// settings.
	kROWFlowCompletedAndTopicsDisabledBeforeEEAMigration = 7,
	// The user is restricted with a guardian, so a direct notice is shown.
	kNoticeShownToGuardian = 8,
	kMaxValue = kNoticeShownToGuardian,
	};

	// Contains the possible states of the prompt start up states for m1.
	// LINT.IfChange(SettingsPrivacySandboxPromptStartupState)
	enum class PromptStartupState {
	kEEAConsentPromptWaiting = 0,
	kEEANoticePromptWaiting = 1,
	kROWNoticePromptWaiting = 2,
	kEEAFlowCompletedWithTopicsAccepted = 3,
	kEEAFlowCompletedWithTopicsDeclined = 4,
	kROWNoticeFlowCompleted = 5,
	kPromptNotShownDueToPrivacySandboxRestricted = 6,
	kPromptNotShownDueTo3PCBlocked = 7,
	kPromptNotShownDueToTrialConsentDeclined = 8,
	kPromptNotShownDueToTrialsDisabledAfterNoticeShown = 9,
	kPromptNotShownDueToManagedState = 10,
	kRestrictedNoticeNotShownDueToNoticeShownToGuardian = 11,
	kRestrictedNoticePromptWaiting = 12,
	kRestrictedNoticeFlowCompleted = 13,
	kRestrictedNoticeNotShownDueToFullNoticeAcknowledged = 14,
	kWaitingForGraduationRestrictedNoticeFlowNotCompleted = 15,
	kWaitingForGraduationRestrictedNoticeFlowCompleted = 16,
	kMaxValue = kWaitingForGraduationRestrictedNoticeFlowCompleted,
	};
	// LINT.ThenChange(//tools/metrics/histograms/metadata/settings/enums.xml:SettingsPrivacySandboxPromptStartupState)

	// Enum for the different events that can be triggered from the
	// PrivacySandboxApis Dialog. It used to bubble up some Dialog events to other
	// components.
	enum class AdsDialogCallbackNoArgsEvents {
	kShowDialog,
	kCloseDialog,
	kOpenAdsPrivacySettings,
	kOpenMeasurementSettings,
	};

	// Returns the prompt type that should be shown to the user. This consults
	// previous consent / notice information stored in preferences, the
	// current state of the Privacy Sandbox settings, and the current location
	// of the user, to determine the appropriate type. This is expected to be
	// called by UI code locations determining whether a prompt should be
	// shown on startup.
	virtual PromptType GetRequiredPromptType(SurfaceType surface_type) = 0;

	// Informs the service that \|action\| occurred with the prompt. This allows
	// the service to record this information in preferences such that future
	// calls to GetRequiredPromptType() are correct. This is expected to be
	// called appropriately by all locations showing the prompt. Metrics
	// shared between platforms will also be recorded.
	virtual void PromptActionOccurred(PromptAction action,
	SurfaceType surface_type) = 0;

	// Functions for coordinating the display of the Privacy Sandbox prompts
	// across multiple browser windows. Only relevant for Desktop.

	#if !BUILDFLAG(IS_ANDROID)
	// Informs the service that a Privacy Sandbox prompt has been opened
	// or closed for \|browser\|.
	virtual void PromptOpenedForBrowser(BrowserWindowInterface* browser,
	views::Widget* widget) = 0;
	virtual void PromptClosedForBrowser(BrowserWindowInterface* browser) = 0;

	// Returns whether a Privacy Sandbox prompt is currently open for \|browser\|.
	virtual bool IsPromptOpenForBrowser(BrowserWindowInterface* browser) = 0;

	virtual privacy_sandbox::PrivacySandboxQueueManager&
	GetPrivacySandboxNoticeQueueManager() = 0;
	#endif // !BUILDFLAG(IS_ANDROID)

	// If set to true, this treats the testing environment as that of a branded
	// Chrome build.
	virtual void ForceChromeBuildForTests(bool force_chrome_build) = 0;

	// Returns whether the Privacy Sandbox is currently restricted for the
	// profile. UI code should consult this to ensure that when restricted,
	// Privacy Sandbox related UI is updated appropriately.
	virtual bool IsPrivacySandboxRestricted() = 0;

	// Returns whether the Privacy Sandbox is configured to show a restricted
	// notice.
	virtual bool IsRestrictedNoticeEnabled() = 0;

	// Toggles the RelatedWebsiteSets preference.
	virtual void SetRelatedWebsiteSetsDataAccessEnabled(bool enabled) = 0;

	// Returns whether the RelatedWebsiteSets preference is enabled.
	virtual bool IsRelatedWebsiteSetsDataAccessEnabled() const = 0;

	// Returns whether the RelatedWebsiteSets preference is managed.
	virtual bool IsRelatedWebsiteSetsDataAccessManaged() const = 0;

	// Returns the owner domain of the related website set that `site_url` is a
	// member of, or std::nullopt if `site_url` is not recognised as a member of
	// an RWS. Encapsulates logic about whether RWS information should be shown,
	// if it should not, std::nullopt is always returned. Virtual for mocking in
	// tests.
	virtual std::optional<net::SchemefulSite> GetRelatedWebsiteSetOwner(
	const GURL& site_url) const = 0;

	// Same as GetRelatedWebsiteSetOwner but returns a formatted string.
	virtual std::optional<std::u16string> GetRelatedWebsiteSetOwnerForDisplay(
	const GURL& site_url) const = 0;

	// Returns true if `site`'s membership in an RWS is being managed by policy or
	// if RelatedWebsiteSets preference is managed. Virtual for mocking in tests.
	//
	// Note: Enterprises can use the Related Website Set Overrides policy to
	// either add or remove a site from a Related Website Set. This method returns
	// true only if `site` is being added into a Related Website Set since there's
	// no UI use for whether `site` is being removed by an enterprise yet.
	virtual bool IsPartOfManagedRelatedWebsiteSet(
	const net::SchemefulSite& site) const = 0;

	// Returns the set of eTLD + 1's on which the user was joined to a FLEDGE
	// interest group. Consults with the InterestGroupManager associated with
	// \|profile_\| and formats the returned data for direct display to the user.
	virtual void GetFledgeJoiningEtldPlusOneForDisplay(
	base::OnceCallback<void(std::vector<std::string>)> callback) = 0;

	// Returns the set of top frames which are blocked from joining the profile to
	// an interest group.
	virtual std::vector<std::string> GetBlockedFledgeJoiningTopFramesForDisplay()
	const = 0;

	// Sets Fledge interest group joining to \|allowed\| for \|top_frame_etld_plus1\|.
	// Forwards the setting to the PrivacySandboxSettings service, but also
	// removes any Fledge data for the \|top_frame_etld_plus1\| if \|allowed\| is
	// false.
	virtual void SetFledgeJoiningAllowed(const std::string& top_frame_etld_plus1,
	bool allowed) const = 0;

	// Returns the top topics for the previous N epochs.
	// Virtual for mocking in tests.
	virtual std::vector<privacy_sandbox::CanonicalTopic> GetCurrentTopTopics()
	const = 0;

	// Returns the set of topics which have been blocked by the user.
	// Virtual for mocking in tests.
	virtual std::vector<privacy_sandbox::CanonicalTopic> GetBlockedTopics()
	const = 0;

	// Returns the first level topic: they are the root topics, meaning that they
	// have no parent.
	virtual std::vector<privacy_sandbox::CanonicalTopic> GetFirstLevelTopics()
	const = 0;

	// Returns the list of assigned children topics (direct or indirect) of the
	// passed-in topic.
	virtual std::vector<privacy_sandbox::CanonicalTopic>
	GetChildTopicsCurrentlyAssigned(
	const privacy_sandbox::CanonicalTopic& topic) const = 0;

	// Sets a \|topic_id\|, as both a top topic and topic provided to the web, to be
	// allowed/blocked based on the value of \|allowed\|. This is stored to
	// preferences and made available to the Topics API via the
	// PrivacySandboxSettings class. This function expects that \|topic\| will have
	// previously been provided by one of the above functions. Virtual for mocking
	// in tests.
	virtual void SetTopicAllowed(privacy_sandbox::CanonicalTopic topic,
	bool allowed) = 0;

	// Determines whether the Topics API step should be shown in the Privacy
	// Guide.
	virtual bool PrivacySandboxPrivacyGuideShouldShowAdTopicsCard() = 0;

	// Determines whether the China domain should be used for the Privacy Policy
	// page.
	virtual bool ShouldUsePrivacyPolicyChinaDomain() = 0;

	// Inform the service that the user changed the Topics toggle in settings,
	// so that the current topics consent information can be updated.
	// This is not fired for changes to the preference for policy or extensions,
	// and so consent information only represents direct user actions. Note that
	// extensions and policy can only _disable_ topics, and so cannot bypass the
	// need for user consent where required.
	// Virtual for mocking in tests.
	virtual void TopicsToggleChanged(bool new_value) const = 0;

	// Whether the current profile requires consent for Topics to operate.
	virtual bool TopicsConsentRequired() = 0;

	// Whether there is an active consent for Topics currently recorded.
	virtual bool TopicsHasActiveConsent() const = 0;

	// Functions which returns the details of the currently recorded Topics
	// consent.
	virtual privacy_sandbox::TopicsConsentUpdateSource
	TopicsConsentLastUpdateSource() const = 0;
	virtual base::Time TopicsConsentLastUpdateTime() const = 0;
	virtual std::string TopicsConsentLastUpdateText() const = 0;

	// Notice Framework Result Callbacks.
	virtual void UpdateTopicsApiResult(bool value) = 0;
	virtual void UpdateProtectedAudienceApiResult(bool value) = 0;
	virtual void UpdateMeasurementApiResult(bool value) = 0;
	// Notice Framework Eligibility Callbacks.
	virtual privacy_sandbox::EligibilityLevel GetTopicsApiEligibility() = 0;
	virtual privacy_sandbox::EligibilityLevel
	GetProtectedAudienceApiEligibility() = 0;
	virtual privacy_sandbox::EligibilityLevel
	GetAdMeasurementApiEligibility() = 0;
	};

	#endif // CHROME_BROWSER_PRIVACY_SANDBOX_PRIVACY_SANDBOX_SERVICE_H_