Package com.google.openrtb

Class OpenRtb.BidRequest.User

  • All Implemented Interfaces:
    OpenRtb.BidRequest.UserOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.User>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    OpenRtb.BidRequest
    public static final class OpenRtb.BidRequest.User
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.User>
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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OpenRtb.BidRequest.User.Builder
      OpenRTB 2.0: This object contains information known or derived about the human user of the device (i.e., the audience for advertising).

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableMessage

        com.google.protobuf.GeneratedMessageV3.ExtendableMessage.ExtensionWriter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static OpenRtb.BidRequest.User parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.User parseFrom​(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.User parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.User parseFrom​(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.User parseFrom​(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.User parseFrom​(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected OpenRtb.BidRequest.User.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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

      • 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