Class AdxExt.UserExt.ConsentedProvidersSettings.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.UserExt.ConsentedProvidersSettings.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.UserExt.ConsentedProvidersSettings.Builder>
      • getDefaultInstanceForType

        public AdxExt.UserExt.ConsentedProvidersSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public AdxExt.UserExt.ConsentedProvidersSettings build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public AdxExt.UserExt.ConsentedProvidersSettings buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.UserExt.ConsentedProvidersSettings.Builder>
      • getConsentedProvidersList

        public List<Long> getConsentedProvidersList()
         Set of IDs corresponding to ad tech providers (ATPs) for whom the
         publisher has specified to Google that its EEA users have given legally
         valid consent to: 1) the use of cookies or other local storage where
         legally required; and 2) the collection, sharing, and use of personal
         data for personalization of ads by an ATP in accordance with Google's EU
         User Consent Policy.
         If a publisher is using the IAB Transparency and Consent Framework (TCF)
         v2 to manage user consent, this is the set of ATPs consented via the
         Additional Consent string (see
         https://support.google.com/admanager/answer/9681920 for details about
         Google's Additional Consent mode). ATPs consented via the TCF v2 consent
         string are represented in the UserExt.consent field.
         A mapping of ATP ID to ATP name is posted at providers.csv.
         
        repeated int64 consented_providers = 2 [packed = true];
        Specified by:
        getConsentedProvidersList in interface AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder
        Returns:
        A list containing the consentedProviders.
      • getConsentedProvidersCount

        public int getConsentedProvidersCount()
         Set of IDs corresponding to ad tech providers (ATPs) for whom the
         publisher has specified to Google that its EEA users have given legally
         valid consent to: 1) the use of cookies or other local storage where
         legally required; and 2) the collection, sharing, and use of personal
         data for personalization of ads by an ATP in accordance with Google's EU
         User Consent Policy.
         If a publisher is using the IAB Transparency and Consent Framework (TCF)
         v2 to manage user consent, this is the set of ATPs consented via the
         Additional Consent string (see
         https://support.google.com/admanager/answer/9681920 for details about
         Google's Additional Consent mode). ATPs consented via the TCF v2 consent
         string are represented in the UserExt.consent field.
         A mapping of ATP ID to ATP name is posted at providers.csv.
         
        repeated int64 consented_providers = 2 [packed = true];
        Specified by:
        getConsentedProvidersCount in interface AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder
        Returns:
        The count of consentedProviders.
      • getConsentedProviders

        public long getConsentedProviders​(int index)
         Set of IDs corresponding to ad tech providers (ATPs) for whom the
         publisher has specified to Google that its EEA users have given legally
         valid consent to: 1) the use of cookies or other local storage where
         legally required; and 2) the collection, sharing, and use of personal
         data for personalization of ads by an ATP in accordance with Google's EU
         User Consent Policy.
         If a publisher is using the IAB Transparency and Consent Framework (TCF)
         v2 to manage user consent, this is the set of ATPs consented via the
         Additional Consent string (see
         https://support.google.com/admanager/answer/9681920 for details about
         Google's Additional Consent mode). ATPs consented via the TCF v2 consent
         string are represented in the UserExt.consent field.
         A mapping of ATP ID to ATP name is posted at providers.csv.
         
        repeated int64 consented_providers = 2 [packed = true];
        Specified by:
        getConsentedProviders in interface AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The consentedProviders at the given index.
      • setConsentedProviders

        public AdxExt.UserExt.ConsentedProvidersSettings.Builder setConsentedProviders​(int index,
                                                                                       long value)
         Set of IDs corresponding to ad tech providers (ATPs) for whom the
         publisher has specified to Google that its EEA users have given legally
         valid consent to: 1) the use of cookies or other local storage where
         legally required; and 2) the collection, sharing, and use of personal
         data for personalization of ads by an ATP in accordance with Google's EU
         User Consent Policy.
         If a publisher is using the IAB Transparency and Consent Framework (TCF)
         v2 to manage user consent, this is the set of ATPs consented via the
         Additional Consent string (see
         https://support.google.com/admanager/answer/9681920 for details about
         Google's Additional Consent mode). ATPs consented via the TCF v2 consent
         string are represented in the UserExt.consent field.
         A mapping of ATP ID to ATP name is posted at providers.csv.
         
        repeated int64 consented_providers = 2 [packed = true];
        Parameters:
        index - The index to set the value at.
        value - The consentedProviders to set.
        Returns:
        This builder for chaining.
      • addConsentedProviders

        public AdxExt.UserExt.ConsentedProvidersSettings.Builder addConsentedProviders​(long value)
         Set of IDs corresponding to ad tech providers (ATPs) for whom the
         publisher has specified to Google that its EEA users have given legally
         valid consent to: 1) the use of cookies or other local storage where
         legally required; and 2) the collection, sharing, and use of personal
         data for personalization of ads by an ATP in accordance with Google's EU
         User Consent Policy.
         If a publisher is using the IAB Transparency and Consent Framework (TCF)
         v2 to manage user consent, this is the set of ATPs consented via the
         Additional Consent string (see
         https://support.google.com/admanager/answer/9681920 for details about
         Google's Additional Consent mode). ATPs consented via the TCF v2 consent
         string are represented in the UserExt.consent field.
         A mapping of ATP ID to ATP name is posted at providers.csv.
         
        repeated int64 consented_providers = 2 [packed = true];
        Parameters:
        value - The consentedProviders to add.
        Returns:
        This builder for chaining.
      • addAllConsentedProviders

        public AdxExt.UserExt.ConsentedProvidersSettings.Builder addAllConsentedProviders​(Iterable<? extends Long> values)
         Set of IDs corresponding to ad tech providers (ATPs) for whom the
         publisher has specified to Google that its EEA users have given legally
         valid consent to: 1) the use of cookies or other local storage where
         legally required; and 2) the collection, sharing, and use of personal
         data for personalization of ads by an ATP in accordance with Google's EU
         User Consent Policy.
         If a publisher is using the IAB Transparency and Consent Framework (TCF)
         v2 to manage user consent, this is the set of ATPs consented via the
         Additional Consent string (see
         https://support.google.com/admanager/answer/9681920 for details about
         Google's Additional Consent mode). ATPs consented via the TCF v2 consent
         string are represented in the UserExt.consent field.
         A mapping of ATP ID to ATP name is posted at providers.csv.
         
        repeated int64 consented_providers = 2 [packed = true];
        Parameters:
        values - The consentedProviders to add.
        Returns:
        This builder for chaining.
      • clearConsentedProviders

        public AdxExt.UserExt.ConsentedProvidersSettings.Builder clearConsentedProviders()
         Set of IDs corresponding to ad tech providers (ATPs) for whom the
         publisher has specified to Google that its EEA users have given legally
         valid consent to: 1) the use of cookies or other local storage where
         legally required; and 2) the collection, sharing, and use of personal
         data for personalization of ads by an ATP in accordance with Google's EU
         User Consent Policy.
         If a publisher is using the IAB Transparency and Consent Framework (TCF)
         v2 to manage user consent, this is the set of ATPs consented via the
         Additional Consent string (see
         https://support.google.com/admanager/answer/9681920 for details about
         Google's Additional Consent mode). ATPs consented via the TCF v2 consent
         string are represented in the UserExt.consent field.
         A mapping of ATP ID to ATP name is posted at providers.csv.
         
        repeated int64 consented_providers = 2 [packed = true];
        Returns:
        This builder for chaining.
      • hasAdditionalConsent

        public boolean hasAdditionalConsent()
         The raw Additional Consent string, which contains a list of certain
         Google Ad Tech Providers (ATPs). These ATPs are not registered with IAB
         TCF v2, but publishers or their Consent Management Providers (CMPs) have
         ensured that certain disclosures are given to, and consents are obtained
         from, end users, as required by Google's EU User Consent Policy. This
         field is only populated with the use of CMPs that are integrated with IAB
         TCF v2. Such CMPs use the raw Additional Consent string to indicate
         vendors that are not registered with IAB, and communicate end users' CMP
         choices to those vendors. The consented_providers field contains the set
         of vendors that mirrors the one represented by the additional_consent
         field, which is in the raw form. Vendors or any other third-party service
         providers must not create AC strings themselves.
         See https://support.google.com/admanager/answer/9681920 for more details
         about this field.
         
        optional string additional_consent = 3;
        Specified by:
        hasAdditionalConsent in interface AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder
        Returns:
        Whether the additionalConsent field is set.
      • getAdditionalConsent

        public String getAdditionalConsent()
         The raw Additional Consent string, which contains a list of certain
         Google Ad Tech Providers (ATPs). These ATPs are not registered with IAB
         TCF v2, but publishers or their Consent Management Providers (CMPs) have
         ensured that certain disclosures are given to, and consents are obtained
         from, end users, as required by Google's EU User Consent Policy. This
         field is only populated with the use of CMPs that are integrated with IAB
         TCF v2. Such CMPs use the raw Additional Consent string to indicate
         vendors that are not registered with IAB, and communicate end users' CMP
         choices to those vendors. The consented_providers field contains the set
         of vendors that mirrors the one represented by the additional_consent
         field, which is in the raw form. Vendors or any other third-party service
         providers must not create AC strings themselves.
         See https://support.google.com/admanager/answer/9681920 for more details
         about this field.
         
        optional string additional_consent = 3;
        Specified by:
        getAdditionalConsent in interface AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder
        Returns:
        The additionalConsent.
      • getAdditionalConsentBytes

        public com.google.protobuf.ByteString getAdditionalConsentBytes()
         The raw Additional Consent string, which contains a list of certain
         Google Ad Tech Providers (ATPs). These ATPs are not registered with IAB
         TCF v2, but publishers or their Consent Management Providers (CMPs) have
         ensured that certain disclosures are given to, and consents are obtained
         from, end users, as required by Google's EU User Consent Policy. This
         field is only populated with the use of CMPs that are integrated with IAB
         TCF v2. Such CMPs use the raw Additional Consent string to indicate
         vendors that are not registered with IAB, and communicate end users' CMP
         choices to those vendors. The consented_providers field contains the set
         of vendors that mirrors the one represented by the additional_consent
         field, which is in the raw form. Vendors or any other third-party service
         providers must not create AC strings themselves.
         See https://support.google.com/admanager/answer/9681920 for more details
         about this field.
         
        optional string additional_consent = 3;
        Specified by:
        getAdditionalConsentBytes in interface AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder
        Returns:
        The bytes for additionalConsent.
      • setAdditionalConsent

        public AdxExt.UserExt.ConsentedProvidersSettings.Builder setAdditionalConsent​(String value)
         The raw Additional Consent string, which contains a list of certain
         Google Ad Tech Providers (ATPs). These ATPs are not registered with IAB
         TCF v2, but publishers or their Consent Management Providers (CMPs) have
         ensured that certain disclosures are given to, and consents are obtained
         from, end users, as required by Google's EU User Consent Policy. This
         field is only populated with the use of CMPs that are integrated with IAB
         TCF v2. Such CMPs use the raw Additional Consent string to indicate
         vendors that are not registered with IAB, and communicate end users' CMP
         choices to those vendors. The consented_providers field contains the set
         of vendors that mirrors the one represented by the additional_consent
         field, which is in the raw form. Vendors or any other third-party service
         providers must not create AC strings themselves.
         See https://support.google.com/admanager/answer/9681920 for more details
         about this field.
         
        optional string additional_consent = 3;
        Parameters:
        value - The additionalConsent to set.
        Returns:
        This builder for chaining.
      • clearAdditionalConsent

        public AdxExt.UserExt.ConsentedProvidersSettings.Builder clearAdditionalConsent()
         The raw Additional Consent string, which contains a list of certain
         Google Ad Tech Providers (ATPs). These ATPs are not registered with IAB
         TCF v2, but publishers or their Consent Management Providers (CMPs) have
         ensured that certain disclosures are given to, and consents are obtained
         from, end users, as required by Google's EU User Consent Policy. This
         field is only populated with the use of CMPs that are integrated with IAB
         TCF v2. Such CMPs use the raw Additional Consent string to indicate
         vendors that are not registered with IAB, and communicate end users' CMP
         choices to those vendors. The consented_providers field contains the set
         of vendors that mirrors the one represented by the additional_consent
         field, which is in the raw form. Vendors or any other third-party service
         providers must not create AC strings themselves.
         See https://support.google.com/admanager/answer/9681920 for more details
         about this field.
         
        optional string additional_consent = 3;
        Returns:
        This builder for chaining.
      • setAdditionalConsentBytes

        public AdxExt.UserExt.ConsentedProvidersSettings.Builder setAdditionalConsentBytes​(com.google.protobuf.ByteString value)
         The raw Additional Consent string, which contains a list of certain
         Google Ad Tech Providers (ATPs). These ATPs are not registered with IAB
         TCF v2, but publishers or their Consent Management Providers (CMPs) have
         ensured that certain disclosures are given to, and consents are obtained
         from, end users, as required by Google's EU User Consent Policy. This
         field is only populated with the use of CMPs that are integrated with IAB
         TCF v2. Such CMPs use the raw Additional Consent string to indicate
         vendors that are not registered with IAB, and communicate end users' CMP
         choices to those vendors. The consented_providers field contains the set
         of vendors that mirrors the one represented by the additional_consent
         field, which is in the raw form. Vendors or any other third-party service
         providers must not create AC strings themselves.
         See https://support.google.com/admanager/answer/9681920 for more details
         about this field.
         
        optional string additional_consent = 3;
        Parameters:
        value - The bytes for additionalConsent to set.
        Returns:
        This builder for chaining.