open_rtb

Class OpenRtbProtobuf.User

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

open_rtb.OpenRtbProtobuf.User

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, OpenRtbProtobuf.UserOrBuilder

Enclosing class:

OpenRtbProtobuf

public static final class OpenRtbProtobuf.User
extends com.google.protobuf.GeneratedMessageV3
implements OpenRtbProtobuf.UserOrBuilder

 3.3.12 User Object
The “user” object 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.
The user object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown.
If device ID is used as a proxy for unique user ID, use the device object. 
 

Protobuf type open_rtb.User

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenRtbProtobuf.User.Builder 3.3.12 User Object The “user” object contains information known or derived about the human user of the device.

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

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

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	GENDER_FIELD_NUMBER
static int	GEO_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	KEYWORDS_FIELD_NUMBER
static com.google.protobuf.Parser<OpenRtbProtobuf.User>	PARSER Deprecated.
static int	YOB_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBuyeruid() Buyer’s user ID for this user as mapped by exchange for the buyer.
com.google.protobuf.ByteString	getBuyeruidBytes() Buyer’s user ID for this user as mapped by exchange for the buyer.
String	getCustomdata() If supported by the exchange, this is custom data that the bidder had stored in the exchange’s cookie.
com.google.protobuf.ByteString	getCustomdataBytes() If supported by the exchange, this is custom data that the bidder had stored in the exchange’s cookie.
OpenRtbProtobuf.Data	getData(int index) See Data Object.
int	getDataCount() See Data Object.
List<OpenRtbProtobuf.Data>	getDataList() See Data Object.
OpenRtbProtobuf.DataOrBuilder	getDataOrBuilder(int index) See Data Object.
List<? extends OpenRtbProtobuf.DataOrBuilder>	getDataOrBuilderList() See Data Object.
static OpenRtbProtobuf.User	getDefaultInstance()
OpenRtbProtobuf.User	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getGender() Gender as “M” male, “F” female, “O” Other.
com.google.protobuf.ByteString	getGenderBytes() Gender as “M” male, “F” female, “O” Other.
OpenRtbProtobuf.Geo	getGeo() 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); see Geo Object.
OpenRtbProtobuf.GeoOrBuilder	getGeoOrBuilder() 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); see Geo Object.
String	getId() Unique consumer ID of this user on the exchange.
com.google.protobuf.ByteString	getIdBytes() Unique consumer ID of this user on the exchange.
String	getKeywords() Comma separated list of keywords of consumer interests or intent.
com.google.protobuf.ByteString	getKeywordsBytes() Comma separated list of keywords of consumer interests or intent.
com.google.protobuf.Parser<OpenRtbProtobuf.User>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getYob() Year of birth as a 4-digit integer.
boolean	hasBuyeruid() Buyer’s user ID for this user as mapped by exchange for the buyer.
boolean	hasCustomdata() If supported by the exchange, this is custom data that the bidder had stored in the exchange’s cookie.
boolean	hasGender() Gender as “M” male, “F” female, “O” Other.
boolean	hasGeo() 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); see Geo Object.
int	hashCode()
boolean	hasId() Unique consumer ID of this user on the exchange.
boolean	hasKeywords() Comma separated list of keywords of consumer interests or intent.
boolean	hasYob() Year of birth as a 4-digit integer.
boolean	isInitialized()
static OpenRtbProtobuf.User.Builder	newBuilder()
static OpenRtbProtobuf.User.Builder	newBuilder(OpenRtbProtobuf.User prototype)
OpenRtbProtobuf.User.Builder	newBuilderForType()
static OpenRtbProtobuf.User	parseDelimitedFrom(InputStream input)
static OpenRtbProtobuf.User	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.User	parseFrom(byte[] data)
static OpenRtbProtobuf.User	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.User	parseFrom(com.google.protobuf.ByteString data)
static OpenRtbProtobuf.User	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.User	parseFrom(com.google.protobuf.CodedInputStream input)
static OpenRtbProtobuf.User	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.User	parseFrom(InputStream input)
static OpenRtbProtobuf.User	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OpenRtbProtobuf.User>	parser()
OpenRtbProtobuf.User.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

PARSER

@Deprecated
public static final com.google.protobuf.Parser<OpenRtbProtobuf.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.GeneratedMessageV3

getDescriptor

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

hasId

public boolean hasId()

 Unique consumer ID of this user on the exchange. 
 

optional string id = 1;

Specified by:

hasId in interface OpenRtbProtobuf.UserOrBuilder

getId

public String getId()

 Unique consumer ID of this user on the exchange. 
 

optional string id = 1;

Specified by:

getId in interface OpenRtbProtobuf.UserOrBuilder

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 Unique consumer ID of this user on the exchange. 
 

optional string id = 1;

Specified by:

getIdBytes in interface OpenRtbProtobuf.UserOrBuilder

hasBuyeruid

public boolean hasBuyeruid()

 Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie) 
 

optional string buyeruid = 2;

Specified by:

hasBuyeruid in interface OpenRtbProtobuf.UserOrBuilder

getBuyeruid

public String getBuyeruid()

 Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie) 
 

optional string buyeruid = 2;

Specified by:

getBuyeruid in interface OpenRtbProtobuf.UserOrBuilder

getBuyeruidBytes

public com.google.protobuf.ByteString getBuyeruidBytes()

 Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie) 
 

optional string buyeruid = 2;

Specified by:

getBuyeruidBytes in interface OpenRtbProtobuf.UserOrBuilder

hasYob

public boolean hasYob()

 Year of birth as a 4-digit integer. 
 

optional uint32 yob = 3;

Specified by:

hasYob in interface OpenRtbProtobuf.UserOrBuilder

getYob

public int getYob()

 Year of birth as a 4-digit integer. 
 

optional uint32 yob = 3;

Specified by:

getYob in interface OpenRtbProtobuf.UserOrBuilder

hasGender

public boolean hasGender()

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

optional string gender = 4;

Specified by:

hasGender in interface OpenRtbProtobuf.UserOrBuilder

getGender

public String getGender()

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

optional string gender = 4;

Specified by:

getGender in interface OpenRtbProtobuf.UserOrBuilder

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 OpenRtbProtobuf.UserOrBuilder

hasKeywords

public boolean hasKeywords()

 Comma separated list of keywords of consumer interests or intent. 
 

optional string keywords = 5;

Specified by:

hasKeywords in interface OpenRtbProtobuf.UserOrBuilder

getKeywords

public String getKeywords()

 Comma separated list of keywords of consumer interests or intent. 
 

optional string keywords = 5;

Specified by:

getKeywords in interface OpenRtbProtobuf.UserOrBuilder

getKeywordsBytes

public com.google.protobuf.ByteString getKeywordsBytes()

 Comma separated list of keywords of consumer interests or intent. 
 

optional string keywords = 5;

Specified by:

getKeywordsBytes in interface OpenRtbProtobuf.UserOrBuilder

hasCustomdata

public boolean hasCustomdata()

 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. 
 

optional string customdata = 6;

Specified by:

hasCustomdata in interface OpenRtbProtobuf.UserOrBuilder

getCustomdata

public String getCustomdata()

 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. 
 

optional string customdata = 6;

Specified by:

getCustomdata in interface OpenRtbProtobuf.UserOrBuilder

getCustomdataBytes

public com.google.protobuf.ByteString getCustomdataBytes()

 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. 
 

optional string customdata = 6;

Specified by:

getCustomdataBytes in interface OpenRtbProtobuf.UserOrBuilder

hasGeo

public boolean hasGeo()

 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); see Geo Object. 
 

optional .open_rtb.Geo geo = 7;

Specified by:

hasGeo in interface OpenRtbProtobuf.UserOrBuilder

getGeo

public OpenRtbProtobuf.Geo getGeo()

 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); see Geo Object. 
 

optional .open_rtb.Geo geo = 7;

Specified by:

getGeo in interface OpenRtbProtobuf.UserOrBuilder

getGeoOrBuilder

public OpenRtbProtobuf.GeoOrBuilder getGeoOrBuilder()

 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); see Geo Object. 
 

optional .open_rtb.Geo geo = 7;

Specified by:

getGeoOrBuilder in interface OpenRtbProtobuf.UserOrBuilder

getDataList

public List<OpenRtbProtobuf.Data> getDataList()

 See Data Object. 
 

repeated .open_rtb.Data data = 8;

Specified by:

getDataList in interface OpenRtbProtobuf.UserOrBuilder

getDataOrBuilderList

public List<? extends OpenRtbProtobuf.DataOrBuilder> getDataOrBuilderList()

 See Data Object. 
 

repeated .open_rtb.Data data = 8;

Specified by:

getDataOrBuilderList in interface OpenRtbProtobuf.UserOrBuilder

getDataCount

public int getDataCount()

 See Data Object. 
 

repeated .open_rtb.Data data = 8;

Specified by:

getDataCount in interface OpenRtbProtobuf.UserOrBuilder

getData

public OpenRtbProtobuf.Data getData(int index)

 See Data Object. 
 

repeated .open_rtb.Data data = 8;

Specified by:

getData in interface OpenRtbProtobuf.UserOrBuilder

getDataOrBuilder

public OpenRtbProtobuf.DataOrBuilder getDataOrBuilder(int index)

 See Data Object. 
 

repeated .open_rtb.Data data = 8;

Specified by:

getDataOrBuilder in interface OpenRtbProtobuf.UserOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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 OpenRtbProtobuf.User parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OpenRtbProtobuf.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 OpenRtbProtobuf.User parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OpenRtbProtobuf.User parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OpenRtbProtobuf.User parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static OpenRtbProtobuf.User parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public OpenRtbProtobuf.User.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OpenRtbProtobuf.User.Builder newBuilder()

newBuilder

public static OpenRtbProtobuf.User.Builder newBuilder(OpenRtbProtobuf.User prototype)

toBuilder

public OpenRtbProtobuf.User.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

getDefaultInstance

public static OpenRtbProtobuf.User getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<OpenRtbProtobuf.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 OpenRtbProtobuf.User getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder