com.beeswax.openrtb

Class Openrtb.BidRequest.User

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.beeswax.openrtb.Openrtb.BidRequest.User

All Implemented Interfaces:

Openrtb.BidRequest.UserOrBuilder, 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.GeneratedMessage
implements Openrtb.BidRequest.UserOrBuilder

Protobuf type openrtb.BidRequest.User

 OpenRTB 3.3.12: contains information known or derived about the human user of the device.
 Note that the user ID is an exchange artifact (refer to the “device” object for hardware or
 platform derived IDs) and may be subject to rotation policies. However, this user ID must be
 stable long enough to serve reasonably as the basis for frequency capping.
 If device ID is used as a proxy for unique user ID, use the device object.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Openrtb.BidRequest.User.Builder Protobuf type openrtb.BidRequest.User

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUYERUID_FIELD_NUMBER
static int	CUSTOMDATA_FIELD_NUMBER
static int	DATA_FIELD_NUMBER
static int	EXT_FIELD_NUMBER
static int	GENDER_FIELD_NUMBER
static int	GEO_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	KEYWORDS_FIELD_NUMBER
static com.google.protobuf.Parser<Openrtb.BidRequest.User>	PARSER Deprecated.
static int	YOB_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
String	getBuyeruid() optional string buyeruid = 2;
com.google.protobuf.ByteString	getBuyeruidBytes() optional string buyeruid = 2;
String	getCustomdata() optional string customdata = 6;
com.google.protobuf.ByteString	getCustomdataBytes() optional string customdata = 6;
Openrtb.BidRequest.Data	getData(int index) repeated .openrtb.BidRequest.Data data = 8;
int	getDataCount() repeated .openrtb.BidRequest.Data data = 8;
List<Openrtb.BidRequest.Data>	getDataList() repeated .openrtb.BidRequest.Data data = 8;
Openrtb.BidRequest.DataOrBuilder	getDataOrBuilder(int index) repeated .openrtb.BidRequest.Data data = 8;
List<? extends Openrtb.BidRequest.DataOrBuilder>	getDataOrBuilderList() repeated .openrtb.BidRequest.Data data = 8;
static Openrtb.BidRequest.User	getDefaultInstance()
Openrtb.BidRequest.User	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Extension.UserExtensions	getExt() optional .openrtb.UserExtensions ext = 1000;
Extension.UserExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.UserExtensions ext = 1000;
String	getGender() optional string gender = 4;
com.google.protobuf.ByteString	getGenderBytes() optional string gender = 4;
Openrtb.BidRequest.Geo	getGeo() optional .openrtb.BidRequest.Geo geo = 7;
Openrtb.BidRequest.GeoOrBuilder	getGeoOrBuilder() optional .openrtb.BidRequest.Geo geo = 7;
String	getId() optional string id = 1;
com.google.protobuf.ByteString	getIdBytes() optional string id = 1;
String	getKeywords() optional string keywords = 5;
com.google.protobuf.ByteString	getKeywordsBytes() optional string keywords = 5;
com.google.protobuf.Parser<Openrtb.BidRequest.User>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getYob() optional int32 yob = 3;
boolean	hasBuyeruid() optional string buyeruid = 2;
boolean	hasCustomdata() optional string customdata = 6;
boolean	hasExt() optional .openrtb.UserExtensions ext = 1000;
boolean	hasGender() optional string gender = 4;
boolean	hasGeo() optional .openrtb.BidRequest.Geo geo = 7;
boolean	hasId() optional string id = 1;
boolean	hasKeywords() optional string keywords = 5;
boolean	hasYob() optional int32 yob = 3;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Openrtb.BidRequest.User.Builder	newBuilder()
static Openrtb.BidRequest.User.Builder	newBuilder(Openrtb.BidRequest.User prototype)
Openrtb.BidRequest.User.Builder	newBuilderForType()
protected Openrtb.BidRequest.User.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static Openrtb.BidRequest.User	parseDelimitedFrom(InputStream input)
static Openrtb.BidRequest.User	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.User	parseFrom(byte[] data)
static Openrtb.BidRequest.User	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.User	parseFrom(com.google.protobuf.ByteString data)
static Openrtb.BidRequest.User	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.User	parseFrom(com.google.protobuf.CodedInputStream input)
static Openrtb.BidRequest.User	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.User	parseFrom(InputStream input)
static Openrtb.BidRequest.User	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Openrtb.BidRequest.User>	parser()
Openrtb.BidRequest.User.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

BUYERUID_FIELD_NUMBER

public static final int BUYERUID_FIELD_NUMBER

See Also:

Constant Field Values

YOB_FIELD_NUMBER

public static final int YOB_FIELD_NUMBER

See Also:

Constant Field Values

GENDER_FIELD_NUMBER

public static final int GENDER_FIELD_NUMBER

See Also:

Constant Field Values

KEYWORDS_FIELD_NUMBER

public static final int KEYWORDS_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOMDATA_FIELD_NUMBER

public static final int CUSTOMDATA_FIELD_NUMBER

See Also:

Constant Field Values

GEO_FIELD_NUMBER

public static final int GEO_FIELD_NUMBER

See Also:

Constant Field Values

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER

See Also:

Constant Field Values

EXT_FIELD_NUMBER

public static final int EXT_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Openrtb.BidRequest.User> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasId

public boolean hasId()

optional string id = 1;

 Unique consumer ID of this user on the exchange.
 

Specified by:

hasId in interface Openrtb.BidRequest.UserOrBuilder

getId

public String getId()

optional string id = 1;

 Unique consumer ID of this user on the exchange.
 

Specified by:

getId in interface Openrtb.BidRequest.UserOrBuilder

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

optional string id = 1;

 Unique consumer ID of this user on the exchange.
 

Specified by:

getIdBytes in interface Openrtb.BidRequest.UserOrBuilder

hasBuyeruid

public boolean hasBuyeruid()

optional string buyeruid = 2;

 Buyer’s user ID for this user as mapped by exchange for the buyer.
 

Specified by:

hasBuyeruid in interface Openrtb.BidRequest.UserOrBuilder

getBuyeruid

public String getBuyeruid()

optional string buyeruid = 2;

 Buyer’s user ID for this user as mapped by exchange for the buyer.
 

Specified by:

getBuyeruid in interface Openrtb.BidRequest.UserOrBuilder

getBuyeruidBytes

public com.google.protobuf.ByteString getBuyeruidBytes()

optional string buyeruid = 2;

 Buyer’s user ID for this user as mapped by exchange for the buyer.
 

Specified by:

getBuyeruidBytes in interface Openrtb.BidRequest.UserOrBuilder

hasYob

public boolean hasYob()

optional int32 yob = 3;

 Year of birth as a 4-digit integer.
 

Specified by:

hasYob in interface Openrtb.BidRequest.UserOrBuilder

getYob

public int getYob()

optional int32 yob = 3;

 Year of birth as a 4-digit integer.
 

Specified by:

getYob in interface Openrtb.BidRequest.UserOrBuilder

hasGender

public boolean hasGender()

optional string gender = 4;

 Gender as “M” male, “F” female, “O” Other. (Null indicates unknown)
 

Specified by:

hasGender in interface Openrtb.BidRequest.UserOrBuilder

getGender

public String getGender()

optional string gender = 4;

 Gender as “M” male, “F” female, “O” Other. (Null indicates unknown)
 

Specified by:

getGender in interface Openrtb.BidRequest.UserOrBuilder

getGenderBytes

public com.google.protobuf.ByteString getGenderBytes()

optional string gender = 4;

 Gender as “M” male, “F” female, “O” Other. (Null indicates unknown)
 

Specified by:

getGenderBytes in interface Openrtb.BidRequest.UserOrBuilder

hasKeywords

public boolean hasKeywords()

optional string keywords = 5;

 Comma separated list of keywords of consumer interests or intent.
 

Specified by:

hasKeywords in interface Openrtb.BidRequest.UserOrBuilder

getKeywords

public String getKeywords()

optional string keywords = 5;

 Comma separated list of keywords of consumer interests or intent.
 

Specified by:

getKeywords in interface Openrtb.BidRequest.UserOrBuilder

getKeywordsBytes

public com.google.protobuf.ByteString getKeywordsBytes()

optional string keywords = 5;

 Comma separated list of keywords of consumer interests or intent.
 

Specified by:

getKeywordsBytes in interface Openrtb.BidRequest.UserOrBuilder

hasCustomdata

public boolean hasCustomdata()

optional string customdata = 6;

 If supported by the exchange, this is custom data that the bidder had stored in the
 exchange’s cookie. The string may be in base85 cookie safe characters, and be in any
 format. This may useful for storing user features. Note: Proper JSON encoding must
 be used to include “escaped” quotation marks.
 

Specified by:

hasCustomdata in interface Openrtb.BidRequest.UserOrBuilder

getCustomdata

public String getCustomdata()

optional string customdata = 6;

 If supported by the exchange, this is custom data that the bidder had stored in the
 exchange’s cookie. The string may be in base85 cookie safe characters, and be in any
 format. This may useful for storing user features. Note: Proper JSON encoding must
 be used to include “escaped” quotation marks.
 

Specified by:

getCustomdata in interface Openrtb.BidRequest.UserOrBuilder

getCustomdataBytes

public com.google.protobuf.ByteString getCustomdataBytes()

optional string customdata = 6;

 If supported by the exchange, this is custom data that the bidder had stored in the
 exchange’s cookie. The string may be in base85 cookie safe characters, and be in any
 format. This may useful for storing user features. Note: Proper JSON encoding must
 be used to include “escaped” quotation marks.
 

Specified by:

getCustomdataBytes in interface Openrtb.BidRequest.UserOrBuilder

hasGeo

public boolean hasGeo()

optional .openrtb.BidRequest.Geo geo = 7;

 Home geo for the user (e.g., based off of registration data); this is different from the
 current location of the access device (that is defined by the geo object embedded in the
 Device Object).
 

Specified by:

hasGeo in interface Openrtb.BidRequest.UserOrBuilder

getGeo

public Openrtb.BidRequest.Geo getGeo()

optional .openrtb.BidRequest.Geo geo = 7;

 Home geo for the user (e.g., based off of registration data); this is different from the
 current location of the access device (that is defined by the geo object embedded in the
 Device Object).
 

Specified by:

getGeo in interface Openrtb.BidRequest.UserOrBuilder

getGeoOrBuilder

public Openrtb.BidRequest.GeoOrBuilder getGeoOrBuilder()

optional .openrtb.BidRequest.Geo geo = 7;

 Home geo for the user (e.g., based off of registration data); this is different from the
 current location of the access device (that is defined by the geo object embedded in the
 Device Object).
 

Specified by:

getGeoOrBuilder in interface Openrtb.BidRequest.UserOrBuilder

getDataList

public List<Openrtb.BidRequest.Data> getDataList()

repeated .openrtb.BidRequest.Data data = 8;

 User's custom Data.
 

Specified by:

getDataList in interface Openrtb.BidRequest.UserOrBuilder

getDataOrBuilderList

public List<? extends Openrtb.BidRequest.DataOrBuilder> getDataOrBuilderList()

repeated .openrtb.BidRequest.Data data = 8;

 User's custom Data.
 

Specified by:

getDataOrBuilderList in interface Openrtb.BidRequest.UserOrBuilder

getDataCount

public int getDataCount()

repeated .openrtb.BidRequest.Data data = 8;

 User's custom Data.
 

Specified by:

getDataCount in interface Openrtb.BidRequest.UserOrBuilder

getData

public Openrtb.BidRequest.Data getData(int index)

repeated .openrtb.BidRequest.Data data = 8;

 User's custom Data.
 

Specified by:

getData in interface Openrtb.BidRequest.UserOrBuilder

getDataOrBuilder

public Openrtb.BidRequest.DataOrBuilder getDataOrBuilder(int index)

repeated .openrtb.BidRequest.Data data = 8;

 User's custom Data.
 

Specified by:

getDataOrBuilder in interface Openrtb.BidRequest.UserOrBuilder

hasExt

public boolean hasExt()

optional .openrtb.UserExtensions ext = 1000;

Specified by:

hasExt in interface Openrtb.BidRequest.UserOrBuilder

getExt

public Extension.UserExtensions getExt()

optional .openrtb.UserExtensions ext = 1000;

Specified by:

getExt in interface Openrtb.BidRequest.UserOrBuilder

getExtOrBuilder

public Extension.UserExtensionsOrBuilder getExtOrBuilder()

optional .openrtb.UserExtensions ext = 1000;

Specified by:

getExtOrBuilder 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.GeneratedMessage

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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

parseFrom

public static Openrtb.BidRequest.User parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static Openrtb.BidRequest.User parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static Openrtb.BidRequest.User parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Openrtb.BidRequest.User parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static Openrtb.BidRequest.User parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static Openrtb.BidRequest.User parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

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

newBuilder

public static Openrtb.BidRequest.User.Builder newBuilder()

newBuilder

public static Openrtb.BidRequest.User.Builder newBuilder(Openrtb.BidRequest.User prototype)

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.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage

getDefaultInstance

public static Openrtb.BidRequest.User getDefaultInstance()

parser

public static com.google.protobuf.Parser<Openrtb.BidRequest.User> parser()

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

getDefaultInstanceForType

public Openrtb.BidRequest.User getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder