Package com.google.openrtb

Class OpenRtb.BidRequest.User.Builder

  • All Implemented Interfaces:
    OpenRtb.BidRequest.UserOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.User>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    OpenRtb.BidRequest.User
    public static final class OpenRtb.BidRequest.User.Builder
extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<OpenRtb.BidRequest.User,​OpenRtb.BidRequest.User.Builder>
implements OpenRtb.BidRequest.UserOrBuilder
     OpenRTB 2.0: This object contains information known or derived about
 the human user of the device (i.e., the audience for advertising).
 The user id is an exchange artifact and may be subject to rotation or other
 privacy policies. However, this user ID must be stable long enough to serve
 reasonably as the basis for frequency capping and retargeting.
    Protobuf type com.google.openrtb.BidRequest.User

    • 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<OpenRtb.BidRequest.User.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<OpenRtb.BidRequest.User.Builder>

      • getDefaultInstanceForType

        public OpenRtb.BidRequest.User getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.User>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public OpenRtb.BidRequest.User build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public OpenRtb.BidRequest.User buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public OpenRtb.BidRequest.User.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<OpenRtb.BidRequest.User.Builder>

      • clearOneof

        public OpenRtb.BidRequest.User.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<OpenRtb.BidRequest.User.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<OpenRtb.BidRequest.User,​OpenRtb.BidRequest.User.Builder>

      • mergeFrom

        public OpenRtb.BidRequest.User.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OpenRtb.BidRequest.User.Builder>
        Throws:
        IOException

      • hasId

        public boolean hasId()
         Exchange-specific ID for the user. At least one of id or buyeruid
 is recommended.
        optional string id = 1;
        Specified by:
        hasId in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public String getId()
         Exchange-specific ID for the user. At least one of id or buyeruid
 is recommended.
        optional string id = 1;
        Specified by:
        getId in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Exchange-specific ID for the user. At least one of id or buyeruid
 is recommended.
        optional string id = 1;
        Specified by:
        getIdBytes in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The bytes for id.

      • setId

        public OpenRtb.BidRequest.User.Builder setId​(String value)
         Exchange-specific ID for the user. At least one of id or buyeruid
 is recommended.
        optional string id = 1;
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public OpenRtb.BidRequest.User.Builder clearId()
         Exchange-specific ID for the user. At least one of id or buyeruid
 is recommended.
        optional string id = 1;
        Returns:
        This builder for chaining.

      • setIdBytes

        public OpenRtb.BidRequest.User.Builder setIdBytes​(com.google.protobuf.ByteString value)
         Exchange-specific ID for the user. At least one of id or buyeruid
 is recommended.
        optional string id = 1;
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.

      • hasBuyeruid

        public boolean hasBuyeruid()
         Buyer-specific ID for the user as mapped by the exchange for the buyer.
 At least one of buyeruid or id is recommended.
        optional string buyeruid = 2;
        Specified by:
        hasBuyeruid in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        Whether the buyeruid field is set.

      • getBuyeruid

        public String getBuyeruid()
         Buyer-specific ID for the user as mapped by the exchange for the buyer.
 At least one of buyeruid or id is recommended.
        optional string buyeruid = 2;
        Specified by:
        getBuyeruid in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The buyeruid.

      • getBuyeruidBytes

        public com.google.protobuf.ByteString getBuyeruidBytes()
         Buyer-specific ID for the user as mapped by the exchange for the buyer.
 At least one of buyeruid or id is recommended.
        optional string buyeruid = 2;
        Specified by:
        getBuyeruidBytes in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The bytes for buyeruid.

      • setBuyeruid

        public OpenRtb.BidRequest.User.Builder setBuyeruid​(String value)
         Buyer-specific ID for the user as mapped by the exchange for the buyer.
 At least one of buyeruid or id is recommended.
        optional string buyeruid = 2;
        Parameters:
        value - The buyeruid to set.
        Returns:
        This builder for chaining.

      • clearBuyeruid

        public OpenRtb.BidRequest.User.Builder clearBuyeruid()
         Buyer-specific ID for the user as mapped by the exchange for the buyer.
 At least one of buyeruid or id is recommended.
        optional string buyeruid = 2;
        Returns:
        This builder for chaining.

      • setBuyeruidBytes

        public OpenRtb.BidRequest.User.Builder setBuyeruidBytes​(com.google.protobuf.ByteString value)
         Buyer-specific ID for the user as mapped by the exchange for the buyer.
 At least one of buyeruid or id is recommended.
        optional string buyeruid = 2;
        Parameters:
        value - The bytes for buyeruid to set.
        Returns:
        This builder for chaining.

      • hasYob

        public boolean hasYob()
         Year of birth as a 4-digit integer.
        optional int32 yob = 3;
        Specified by:
        hasYob in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        Whether the yob field is set.

      • setYob

        public OpenRtb.BidRequest.User.Builder setYob​(int value)
         Year of birth as a 4-digit integer.
        optional int32 yob = 3;
        Parameters:
        value - The yob to set.
        Returns:
        This builder for chaining.

      • clearYob

        public OpenRtb.BidRequest.User.Builder clearYob()
         Year of birth as a 4-digit integer.
        optional int32 yob = 3;
        Returns:
        This builder for chaining.

      • hasGender

        public boolean hasGender()
         Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
        optional string gender = 4;
        Specified by:
        hasGender in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        Whether the gender field is set.

      • getGenderBytes

        public com.google.protobuf.ByteString getGenderBytes()
         Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
        optional string gender = 4;
        Specified by:
        getGenderBytes in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The bytes for gender.

      • setGender

        public OpenRtb.BidRequest.User.Builder setGender​(String value)
         Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
        optional string gender = 4;
        Parameters:
        value - The gender to set.
        Returns:
        This builder for chaining.

      • clearGender

        public OpenRtb.BidRequest.User.Builder clearGender()
         Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
        optional string gender = 4;
        Returns:
        This builder for chaining.

      • setGenderBytes

        public OpenRtb.BidRequest.User.Builder setGenderBytes​(com.google.protobuf.ByteString value)
         Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
        optional string gender = 4;
        Parameters:
        value - The bytes for gender to set.
        Returns:
        This builder for chaining.

      • hasKeywords

        public boolean hasKeywords()
         Comma separated list of keywords, interests, or intent.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 5;
        Specified by:
        hasKeywords in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        Whether the keywords field is set.

      • getKeywords

        public String getKeywords()
         Comma separated list of keywords, interests, or intent.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 5;
        Specified by:
        getKeywords in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The keywords.

      • getKeywordsBytes

        public com.google.protobuf.ByteString getKeywordsBytes()
         Comma separated list of keywords, interests, or intent.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 5;
        Specified by:
        getKeywordsBytes in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The bytes for keywords.

      • setKeywords

        public OpenRtb.BidRequest.User.Builder setKeywords​(String value)
         Comma separated list of keywords, interests, or intent.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 5;
        Parameters:
        value - The keywords to set.
        Returns:
        This builder for chaining.

      • clearKeywords

        public OpenRtb.BidRequest.User.Builder clearKeywords()
         Comma separated list of keywords, interests, or intent.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 5;
        Returns:
        This builder for chaining.

      • setKeywordsBytes

        public OpenRtb.BidRequest.User.Builder setKeywordsBytes​(com.google.protobuf.ByteString value)
         Comma separated list of keywords, interests, or intent.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 5;
        Parameters:
        value - The bytes for keywords to set.
        Returns:
        This builder for chaining.

      • hasCustomdata

        public boolean hasCustomdata()
         Optional feature to pass bidder data set in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 6;
        Specified by:
        hasCustomdata in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        Whether the customdata field is set.

      • getCustomdata

        public String getCustomdata()
         Optional feature to pass bidder data set in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 6;
        Specified by:
        getCustomdata in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The customdata.

      • getCustomdataBytes

        public com.google.protobuf.ByteString getCustomdataBytes()
         Optional feature to pass bidder data set in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 6;
        Specified by:
        getCustomdataBytes in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The bytes for customdata.

      • setCustomdata

        public OpenRtb.BidRequest.User.Builder setCustomdata​(String value)
         Optional feature to pass bidder data set in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 6;
        Parameters:
        value - The customdata to set.
        Returns:
        This builder for chaining.

      • clearCustomdata

        public OpenRtb.BidRequest.User.Builder clearCustomdata()
         Optional feature to pass bidder data set in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 6;
        Returns:
        This builder for chaining.

      • setCustomdataBytes

        public OpenRtb.BidRequest.User.Builder setCustomdataBytes​(com.google.protobuf.ByteString value)
         Optional feature to pass bidder data set in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 6;
        Parameters:
        value - The bytes for customdata to set.
        Returns:
        This builder for chaining.

      • hasGeo

        public boolean hasGeo()
         Location of the user's home base defined by a Geo object
 (Section 3.2.12). This is not necessarily their current location.
        optional .com.google.openrtb.BidRequest.Geo geo = 7;
        Specified by:
        hasGeo in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        Whether the geo field is set.

      • getGeo

        public OpenRtb.BidRequest.Geo getGeo()
         Location of the user's home base defined by a Geo object
 (Section 3.2.12). This is not necessarily their current location.
        optional .com.google.openrtb.BidRequest.Geo geo = 7;
        Specified by:
        getGeo in interface OpenRtb.BidRequest.UserOrBuilder
        Returns:
        The geo.

      • setGeo

        public OpenRtb.BidRequest.User.Builder setGeo​(OpenRtb.BidRequest.Geo value)
         Location of the user's home base defined by a Geo object
 (Section 3.2.12). This is not necessarily their current location.
        optional .com.google.openrtb.BidRequest.Geo geo = 7;

      • mergeGeo

        public OpenRtb.BidRequest.User.Builder mergeGeo​(OpenRtb.BidRequest.Geo value)
         Location of the user's home base defined by a Geo object
 (Section 3.2.12). This is not necessarily their current location.
        optional .com.google.openrtb.BidRequest.Geo geo = 7;

      • clearGeo

        public OpenRtb.BidRequest.User.Builder clearGeo()
         Location of the user's home base defined by a Geo object
 (Section 3.2.12). This is not necessarily their current location.
        optional .com.google.openrtb.BidRequest.Geo geo = 7;

      • getGeoBuilder

        public OpenRtb.BidRequest.Geo.Builder getGeoBuilder()
         Location of the user's home base defined by a Geo object
 (Section 3.2.12). This is not necessarily their current location.
        optional .com.google.openrtb.BidRequest.Geo geo = 7;

      • getDataCount

        public int getDataCount()
         Additional user data. Each Data object (Section 3.2.14) represents a
 different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 8;
        Specified by:
        getDataCount in interface OpenRtb.BidRequest.UserOrBuilder

      • clearData

        public OpenRtb.BidRequest.User.Builder clearData()
         Additional user data. Each Data object (Section 3.2.14) represents a
 different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 8;

      • removeData

        public OpenRtb.BidRequest.User.Builder removeData​(int index)
         Additional user data. Each Data object (Section 3.2.14) represents a
 different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 8;

      • getDataBuilder

        public OpenRtb.BidRequest.Data.Builder getDataBuilder​(int index)
         Additional user data. Each Data object (Section 3.2.14) represents a
 different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 8;

      • addDataBuilder

        public OpenRtb.BidRequest.Data.Builder addDataBuilder()
         Additional user data. Each Data object (Section 3.2.14) represents a
 different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 8;

      • addDataBuilder

        public OpenRtb.BidRequest.Data.Builder addDataBuilder​(int index)
         Additional user data. Each Data object (Section 3.2.14) represents a
 different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 8;

      • getDataBuilderList

        public List<OpenRtb.BidRequest.Data.Builder> getDataBuilderList()
         Additional user data. Each Data object (Section 3.2.14) represents a
 different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 8;

      • setUnknownFields

        public final OpenRtb.BidRequest.User.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OpenRtb.BidRequest.User.Builder>

      • mergeUnknownFields

        public final OpenRtb.BidRequest.User.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OpenRtb.BidRequest.User.Builder>