Package com.google.openrtb
Interface OpenRtb.BidRequest.UserOrBuilder
-
- All Superinterfaces:
com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.User>,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OpenRtb.BidRequest.User,OpenRtb.BidRequest.User.Builder
- Enclosing class:
- OpenRtb.BidRequest
public static interface OpenRtb.BidRequest.UserOrBuilder extends com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.User>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetBuyeruid()Buyer-specific ID for the user as mapped by the exchange for the buyer.com.google.protobuf.ByteStringgetBuyeruidBytes()Buyer-specific ID for the user as mapped by the exchange for the buyer.StringgetCustomdata()Optional feature to pass bidder data set in the exchange's cookie.com.google.protobuf.ByteStringgetCustomdataBytes()Optional feature to pass bidder data set in the exchange's cookie.OpenRtb.BidRequest.DatagetData(int index)Additional user data.intgetDataCount()Additional user data.List<OpenRtb.BidRequest.Data>getDataList()Additional user data.OpenRtb.BidRequest.DataOrBuildergetDataOrBuilder(int index)Additional user data.List<? extends OpenRtb.BidRequest.DataOrBuilder>getDataOrBuilderList()Additional user data.StringgetGender()Gender as "M" male, "F" female, "O" Other.com.google.protobuf.ByteStringgetGenderBytes()Gender as "M" male, "F" female, "O" Other.OpenRtb.BidRequest.GeogetGeo()Location of the user's home base defined by a Geo object (Section 3.2.12).OpenRtb.BidRequest.GeoOrBuildergetGeoOrBuilder()Location of the user's home base defined by a Geo object (Section 3.2.12).StringgetId()Exchange-specific ID for the user.com.google.protobuf.ByteStringgetIdBytes()Exchange-specific ID for the user.StringgetKeywords()Comma separated list of keywords, interests, or intent.com.google.protobuf.ByteStringgetKeywordsBytes()Comma separated list of keywords, interests, or intent.intgetYob()Year of birth as a 4-digit integer.booleanhasBuyeruid()Buyer-specific ID for the user as mapped by the exchange for the buyer.booleanhasCustomdata()Optional feature to pass bidder data set in the exchange's cookie.booleanhasGender()Gender as "M" male, "F" female, "O" Other.booleanhasGeo()Location of the user's home base defined by a Geo object (Section 3.2.12).booleanhasId()Exchange-specific ID for the user.booleanhasKeywords()Comma separated list of keywords, interests, or intent.booleanhasYob()Year of birth as a 4-digit integer.-
Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder
getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
-
-
-
-
Method Detail
-
hasId
boolean hasId()
Exchange-specific ID for the user. At least one of id or buyeruid is recommended.
optional string id = 1;- Returns:
- Whether the id field is set.
-
getId
String getId()
Exchange-specific ID for the user. At least one of id or buyeruid is recommended.
optional string id = 1;- Returns:
- The id.
-
getIdBytes
com.google.protobuf.ByteString getIdBytes()
Exchange-specific ID for the user. At least one of id or buyeruid is recommended.
optional string id = 1;- Returns:
- The bytes for id.
-
hasBuyeruid
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;- Returns:
- Whether the buyeruid field is set.
-
getBuyeruid
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;- Returns:
- The buyeruid.
-
getBuyeruidBytes
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;- Returns:
- The bytes for buyeruid.
-
hasYob
boolean hasYob()
Year of birth as a 4-digit integer.
optional int32 yob = 3;- Returns:
- Whether the yob field is set.
-
getYob
int getYob()
Year of birth as a 4-digit integer.
optional int32 yob = 3;- Returns:
- The yob.
-
hasGender
boolean hasGender()
Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
optional string gender = 4;- Returns:
- Whether the gender field is set.
-
getGender
String getGender()
Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
optional string gender = 4;- Returns:
- The gender.
-
getGenderBytes
com.google.protobuf.ByteString getGenderBytes()
Gender as "M" male, "F" female, "O" Other. (Null indicates unknown)
optional string gender = 4;- Returns:
- The bytes for gender.
-
hasKeywords
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;- Returns:
- Whether the keywords field is set.
-
getKeywords
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;- Returns:
- The keywords.
-
getKeywordsBytes
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;- Returns:
- The bytes for keywords.
-
hasCustomdata
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;- Returns:
- Whether the customdata field is set.
-
getCustomdata
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;- Returns:
- The customdata.
-
getCustomdataBytes
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;- Returns:
- The bytes for customdata.
-
hasGeo
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;- Returns:
- Whether the geo field is set.
-
getGeo
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;- Returns:
- The geo.
-
getGeoOrBuilder
OpenRtb.BidRequest.GeoOrBuilder getGeoOrBuilder()
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;
-
getDataList
List<OpenRtb.BidRequest.Data> getDataList()
Additional user data. Each Data object (Section 3.2.14) represents a different data source.
repeated .com.google.openrtb.BidRequest.Data data = 8;
-
getData
OpenRtb.BidRequest.Data getData(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;
-
getDataCount
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;
-
getDataOrBuilderList
List<? extends OpenRtb.BidRequest.DataOrBuilder> getDataOrBuilderList()
Additional user data. Each Data object (Section 3.2.14) represents a different data source.
repeated .com.google.openrtb.BidRequest.Data data = 8;
-
getDataOrBuilder
OpenRtb.BidRequest.DataOrBuilder getDataOrBuilder(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;
-
-