Interface AdxExt.UserExtOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AdxExt.UserExt, AdxExt.UserExt.Builder
    Enclosing class:
    AdxExt

    public static interface AdxExt.UserExtOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getConsent()
      The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2 consent string fetched from the publisher's IAB Consent Management Platform (CMP).
      com.google.protobuf.ByteString getConsentBytes()
      The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2 consent string fetched from the publisher's IAB Consent Management Platform (CMP).
      AdxExt.UserExt.ConsentedProvidersSettings getConsentedProvidersSettings()
      Information about the ad tech providers for whom the publisher has specified to Google that its EEA user has consented to the use of their personal data for ads personalization in accordance with Google's EU User Consent Policy.
      AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder getConsentedProvidersSettingsOrBuilder()
      Information about the ad tech providers for whom the publisher has specified to Google that its EEA user has consented to the use of their personal data for ads personalization in accordance with Google's EU User Consent Policy.
      AdxExt.UserExt.ExtendedId getEids​(int index)
      Standard extension that is used for passing encrypted data chosen by the publisher.
      int getEidsCount()
      Standard extension that is used for passing encrypted data chosen by the publisher.
      List<AdxExt.UserExt.ExtendedId> getEidsList()
      Standard extension that is used for passing encrypted data chosen by the publisher.
      AdxExt.UserExt.ExtendedIdOrBuilder getEidsOrBuilder​(int index)
      Standard extension that is used for passing encrypted data chosen by the publisher.
      List<? extends AdxExt.UserExt.ExtendedIdOrBuilder> getEidsOrBuilderList()
      Standard extension that is used for passing encrypted data chosen by the publisher.
      boolean hasConsent()
      The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2 consent string fetched from the publisher's IAB Consent Management Platform (CMP).
      boolean hasConsentedProvidersSettings()
      Information about the ad tech providers for whom the publisher has specified to Google that its EEA user has consented to the use of their personal data for ads personalization in accordance with Google's EU User Consent Policy.
      • 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

      • hasConsentedProvidersSettings

        boolean hasConsentedProvidersSettings()
         Information about the ad tech providers for whom the publisher has
         specified to Google that its EEA user has consented to the use of their
         personal data for ads personalization in accordance with Google's EU User
         Consent Policy. This field will only be populated when RegsExt.gdpr is
         true.
         
        optional .com.google.doubleclick.UserExt.ConsentedProvidersSettings consented_providers_settings = 1;
        Returns:
        Whether the consentedProvidersSettings field is set.
      • getConsentedProvidersSettings

        AdxExt.UserExt.ConsentedProvidersSettings getConsentedProvidersSettings()
         Information about the ad tech providers for whom the publisher has
         specified to Google that its EEA user has consented to the use of their
         personal data for ads personalization in accordance with Google's EU User
         Consent Policy. This field will only be populated when RegsExt.gdpr is
         true.
         
        optional .com.google.doubleclick.UserExt.ConsentedProvidersSettings consented_providers_settings = 1;
        Returns:
        The consentedProvidersSettings.
      • getConsentedProvidersSettingsOrBuilder

        AdxExt.UserExt.ConsentedProvidersSettingsOrBuilder getConsentedProvidersSettingsOrBuilder()
         Information about the ad tech providers for whom the publisher has
         specified to Google that its EEA user has consented to the use of their
         personal data for ads personalization in accordance with Google's EU User
         Consent Policy. This field will only be populated when RegsExt.gdpr is
         true.
         
        optional .com.google.doubleclick.UserExt.ConsentedProvidersSettings consented_providers_settings = 1;
      • hasConsent

        boolean hasConsent()
         The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2
         consent string fetched from the publisher's IAB Consent Management Platform
         (CMP). The structure of the string is defined by the IAB TCF v2. This field
         will be populated if the publisher has integrated with a CMP for TCF v2 and
         that CMP indicates that GDPR applies to this ad request and provides a
         valid consent string.  See
         https://support.google.com/authorizedbuyers/answer/9789378 for additional
         information about the Google TCF v2 integration.
         See the IAB Global Vendor List at
         https://vendor-list.consensu.org/v2/vendor-list.json for details about the
         vendors listed in the consent string.
         
        optional string consent = 2;
        Returns:
        Whether the consent field is set.
      • getConsent

        String getConsent()
         The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2
         consent string fetched from the publisher's IAB Consent Management Platform
         (CMP). The structure of the string is defined by the IAB TCF v2. This field
         will be populated if the publisher has integrated with a CMP for TCF v2 and
         that CMP indicates that GDPR applies to this ad request and provides a
         valid consent string.  See
         https://support.google.com/authorizedbuyers/answer/9789378 for additional
         information about the Google TCF v2 integration.
         See the IAB Global Vendor List at
         https://vendor-list.consensu.org/v2/vendor-list.json for details about the
         vendors listed in the consent string.
         
        optional string consent = 2;
        Returns:
        The consent.
      • getConsentBytes

        com.google.protobuf.ByteString getConsentBytes()
         The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2
         consent string fetched from the publisher's IAB Consent Management Platform
         (CMP). The structure of the string is defined by the IAB TCF v2. This field
         will be populated if the publisher has integrated with a CMP for TCF v2 and
         that CMP indicates that GDPR applies to this ad request and provides a
         valid consent string.  See
         https://support.google.com/authorizedbuyers/answer/9789378 for additional
         information about the Google TCF v2 integration.
         See the IAB Global Vendor List at
         https://vendor-list.consensu.org/v2/vendor-list.json for details about the
         vendors listed in the consent string.
         
        optional string consent = 2;
        Returns:
        The bytes for consent.
      • getEidsList

        List<AdxExt.UserExt.ExtendedId> getEidsList()
         Standard extension that is used for passing encrypted data chosen by the
         publisher.
         https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/2.x_official_extensions/eids.md
         
        repeated .com.google.doubleclick.UserExt.ExtendedId eids = 5;
      • getEids

        AdxExt.UserExt.ExtendedId getEids​(int index)
         Standard extension that is used for passing encrypted data chosen by the
         publisher.
         https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/2.x_official_extensions/eids.md
         
        repeated .com.google.doubleclick.UserExt.ExtendedId eids = 5;
      • getEidsCount

        int getEidsCount()
         Standard extension that is used for passing encrypted data chosen by the
         publisher.
         https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/2.x_official_extensions/eids.md
         
        repeated .com.google.doubleclick.UserExt.ExtendedId eids = 5;
      • getEidsOrBuilderList

        List<? extends AdxExt.UserExt.ExtendedIdOrBuilder> getEidsOrBuilderList()
         Standard extension that is used for passing encrypted data chosen by the
         publisher.
         https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/2.x_official_extensions/eids.md
         
        repeated .com.google.doubleclick.UserExt.ExtendedId eids = 5;
      • getEidsOrBuilder

        AdxExt.UserExt.ExtendedIdOrBuilder getEidsOrBuilder​(int index)
         Standard extension that is used for passing encrypted data chosen by the
         publisher.
         https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/2.x_official_extensions/eids.md
         
        repeated .com.google.doubleclick.UserExt.ExtendedId eids = 5;