Interface AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAdditionalConsent()
      The raw Additional Consent string, which contains a list of certain Google Ad Tech Providers (ATPs).
      com.google.protobuf.ByteString getAdditionalConsentBytes()
      The raw Additional Consent string, which contains a list of certain Google Ad Tech Providers (ATPs).
      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.
      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.
      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.
      boolean hasAdditionalConsent()
      The raw Additional Consent string, which contains a list of certain Google Ad Tech Providers (ATPs).
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getConsentedProvidersList

        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];
        Returns:
        A list containing the consentedProviders.
      • getConsentedProvidersCount

        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];
        Returns:
        The count of consentedProviders.
      • getConsentedProviders

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The consentedProviders at the given index.
      • hasAdditionalConsent

        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;
        Returns:
        Whether the additionalConsent field is set.
      • getAdditionalConsent

        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;
        Returns:
        The additionalConsent.
      • getAdditionalConsentBytes

        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;
        Returns:
        The bytes for additionalConsent.