com.adgear.avro.openrtb.User Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of anoa-test Show documentation
Show all versions of anoa-test Show documentation
Test module for other Anoa modules, which exposes complex records (OpenRTB bid requests) through
utility classes for use in unit tests within other Anoa modules (anoa-core, for instance).
The newest version!
/**
* Autogenerated by Avro
*
* DO NOT EDIT DIRECTLY
*/
package com.adgear.avro.openrtb;
/** 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.
requires:
com.adgear.avro.openrtb.Geo
com.adgear.avro.openrtb.Data */
@SuppressWarnings("all")
@org.apache.avro.specific.AvroGenerated
public class User extends org.apache.avro.specific.SpecificRecordBase implements org.apache.avro.specific.SpecificRecord {
public static final org.apache.avro.Schema SCHEMA$ = new org.apache.avro.Schema.Parser().parse("{\"type\":\"record\",\"name\":\"User\",\"namespace\":\"com.adgear.avro.openrtb\",\"doc\":\"3.3.12 User Object\\nThe “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.\\nThe 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.\\nIf device ID is used as a proxy for unique user ID, use the device object.\\n\\nrequires:\\n com.adgear.avro.openrtb.Geo\\n com.adgear.avro.openrtb.Data\",\"fields\":[{\"name\":\"id\",\"type\":[\"null\",\"string\"],\"doc\":\"[01] Unique consumer ID of this user on the exchange.\",\"default\":null},{\"name\":\"buyeruid\",\"type\":[\"null\",\"string\"],\"doc\":\"[02] Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie)\",\"default\":null},{\"name\":\"yob\",\"type\":[\"null\",\"int\"],\"doc\":\"[03] Year of birth as a 4-digit integer.\",\"default\":null},{\"name\":\"gender\",\"type\":[\"null\",\"string\"],\"doc\":\"[04] Gender as “M” male, “F” female, “O” Other. (Null indicates unknown).\",\"default\":null},{\"name\":\"keywords\",\"type\":[\"null\",\"string\"],\"doc\":\"[05] Comma separated list of keywords of consumer interests or intent.\",\"default\":null},{\"name\":\"customdata\",\"type\":[\"null\",\"string\"],\"doc\":\"[06] 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.\",\"default\":null},{\"name\":\"geo\",\"type\":[\"null\",{\"type\":\"record\",\"name\":\"Geo\",\"doc\":\"3.3.11 Geo Object\\nThe geo 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.\\nNote that the Geo Object may appear in one or both the Device Object and the User Object. This is intentional, since the information may be derived from either a device-oriented source (such as IP geo lookup), or by user registration information (for example provided to a publisher through a user registration). If the information is in conflict, it’s up to the bidder to determine which information to use.\",\"fields\":[{\"name\":\"lat\",\"type\":[\"null\",\"float\"],\"doc\":\"[01] Latitude from -90 to 90. South is negative. This should only be passed if known to be accurate (For example, not the centroid of a postal code).\",\"default\":null},{\"name\":\"lon\",\"type\":[\"null\",\"float\"],\"doc\":\"[02] Longitude from -180 to 180. West is negative. This should only be passed if known to be accurate.\",\"default\":null},{\"name\":\"country\",\"type\":[\"null\",\"string\"],\"doc\":\"[03] Country using ISO-3166-1 Alpha-3.\",\"default\":null},{\"name\":\"region\",\"type\":[\"null\",\"string\"],\"doc\":\"[04] Region using ISO 3166-2.\",\"default\":null},{\"name\":\"regionfips104\",\"type\":[\"null\",\"string\"],\"doc\":\"[05] Region of a country using FIPS 10-4 notation (alternative to ISO 3166-2).\",\"default\":null},{\"name\":\"metro\",\"type\":[\"null\",\"string\"],\"doc\":\"[06] Pass the metro code (seehttp://code.google.com/apis/adwords/docs/appendix/metrocodes.html). Metro codes are similar to but not exactly the same as Nielsen DMAs.\",\"default\":null},{\"name\":\"city\",\"type\":[\"null\",\"string\"],\"doc\":\"[07] City using United Nations Code for Trade and Transport Locations (http://www.unece.org/cefact/locode/ser vice/location.htm).\",\"default\":null},{\"name\":\"zip\",\"type\":[\"null\",\"string\"],\"doc\":\"[08] Zip/postal code.\",\"default\":null},{\"name\":\"type\",\"type\":[\"null\",\"int\"],\"doc\":\"[09] Indicate the source of the geo data (GPS, IP address, user provided). See Table 6.15 Location Type for a list of potential values. Type should be provided when lat/lon is provided.\",\"default\":null}]}],\"doc\":\"[07] 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.\",\"default\":null},{\"name\":\"data\",\"type\":[\"null\",{\"type\":\"array\",\"items\":{\"type\":\"record\",\"name\":\"Data\",\"doc\":\"3.3.13 Data Object\\nThe data and segment objects together allow data about the user to be passed to bidders in the bid request. This data may be from multiple sources (e.g., the exchange itself, third party providers) as specified by the data object ID field. A bid request can mix data objects from multiple providers.\\nThe data 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.\\n\\nrequires:\\n com.adgear.avro.openrtb.Segment\",\"fields\":[{\"name\":\"id\",\"type\":[\"null\",\"string\"],\"doc\":\"[1] Exchange specific ID for the data provider.\",\"default\":null},{\"name\":\"name\",\"type\":[\"null\",\"string\"],\"doc\":\"[2] Data provider name.\",\"default\":null},{\"name\":\"segment\",\"type\":[\"null\",{\"type\":\"array\",\"items\":{\"type\":\"record\",\"name\":\"Segment\",\"doc\":\"3.3.14 Segment Object\\nThe data and segment objects together allow data about the user to be passed to bidders in the bid request. Segment objects convey specific units of information from the provider identified in the parent data object.\\nThe segment 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.\",\"fields\":[{\"name\":\"id\",\"type\":[\"null\",\"string\"],\"doc\":\"[1] ID of a data provider’s segment applicable to the user.\",\"default\":null},{\"name\":\"name\",\"type\":[\"null\",\"string\"],\"doc\":\"[2] Name of a data provider’s segment applicable to the user.\",\"default\":null},{\"name\":\"value\",\"type\":[\"null\",\"string\"],\"doc\":\"[3] String representing the value of the segment. The method for transmitting this data should be negotiated offline with the data provider. For example for gender, “male”, or “female”, for age, “30-40”).\",\"default\":null}]}}],\"doc\":\"[3] Array of segment objects.\",\"default\":null}]}}],\"doc\":\"[08] See Data Object.\",\"default\":null}]}");
public static org.apache.avro.Schema getClassSchema() { return SCHEMA$; }
/** [01] Unique consumer ID of this user on the exchange. */
@Deprecated public java.lang.CharSequence id;
/** [02] Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie) */
@Deprecated public java.lang.CharSequence buyeruid;
/** [03] Year of birth as a 4-digit integer. */
@Deprecated public java.lang.Integer yob;
/** [04] Gender as “M” male, “F” female, “O” Other. (Null indicates unknown). */
@Deprecated public java.lang.CharSequence gender;
/** [05] Comma separated list of keywords of consumer interests or intent. */
@Deprecated public java.lang.CharSequence keywords;
/** [06] 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. */
@Deprecated public java.lang.CharSequence customdata;
/** [07] 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. */
@Deprecated public com.adgear.avro.openrtb.Geo geo;
/** [08] See Data Object. */
@Deprecated public java.util.List data;
/**
* Default constructor.
*/
public User() {}
/**
* All-args constructor.
*/
public User(java.lang.CharSequence id, java.lang.CharSequence buyeruid, java.lang.Integer yob, java.lang.CharSequence gender, java.lang.CharSequence keywords, java.lang.CharSequence customdata, com.adgear.avro.openrtb.Geo geo, java.util.List data) {
this.id = id;
this.buyeruid = buyeruid;
this.yob = yob;
this.gender = gender;
this.keywords = keywords;
this.customdata = customdata;
this.geo = geo;
this.data = data;
}
public org.apache.avro.Schema getSchema() { return SCHEMA$; }
// Used by DatumWriter. Applications should not call.
public java.lang.Object get(int field$) {
switch (field$) {
case 0: return id;
case 1: return buyeruid;
case 2: return yob;
case 3: return gender;
case 4: return keywords;
case 5: return customdata;
case 6: return geo;
case 7: return data;
default: throw new org.apache.avro.AvroRuntimeException("Bad index");
}
}
// Used by DatumReader. Applications should not call.
@SuppressWarnings(value="unchecked")
public void put(int field$, java.lang.Object value$) {
switch (field$) {
case 0: id = (java.lang.CharSequence)value$; break;
case 1: buyeruid = (java.lang.CharSequence)value$; break;
case 2: yob = (java.lang.Integer)value$; break;
case 3: gender = (java.lang.CharSequence)value$; break;
case 4: keywords = (java.lang.CharSequence)value$; break;
case 5: customdata = (java.lang.CharSequence)value$; break;
case 6: geo = (com.adgear.avro.openrtb.Geo)value$; break;
case 7: data = (java.util.List)value$; break;
default: throw new org.apache.avro.AvroRuntimeException("Bad index");
}
}
/**
* Gets the value of the 'id' field.
* [01] Unique consumer ID of this user on the exchange.
*/
public java.lang.CharSequence getId() {
return id;
}
/**
* Sets the value of the 'id' field.
* [01] Unique consumer ID of this user on the exchange.
* @param value the value to set.
*/
public void setId(java.lang.CharSequence value) {
this.id = value;
}
/**
* Gets the value of the 'buyeruid' field.
* [02] Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie)
*/
public java.lang.CharSequence getBuyeruid() {
return buyeruid;
}
/**
* Sets the value of the 'buyeruid' field.
* [02] Buyer’s user ID for this user as mapped by exchange for the buyer. (AdGear cookie)
* @param value the value to set.
*/
public void setBuyeruid(java.lang.CharSequence value) {
this.buyeruid = value;
}
/**
* Gets the value of the 'yob' field.
* [03] Year of birth as a 4-digit integer.
*/
public java.lang.Integer getYob() {
return yob;
}
/**
* Sets the value of the 'yob' field.
* [03] Year of birth as a 4-digit integer.
* @param value the value to set.
*/
public void setYob(java.lang.Integer value) {
this.yob = value;
}
/**
* Gets the value of the 'gender' field.
* [04] Gender as “M” male, “F” female, “O” Other. (Null indicates unknown).
*/
public java.lang.CharSequence getGender() {
return gender;
}
/**
* Sets the value of the 'gender' field.
* [04] Gender as “M” male, “F” female, “O” Other. (Null indicates unknown).
* @param value the value to set.
*/
public void setGender(java.lang.CharSequence value) {
this.gender = value;
}
/**
* Gets the value of the 'keywords' field.
* [05] Comma separated list of keywords of consumer interests or intent.
*/
public java.lang.CharSequence getKeywords() {
return keywords;
}
/**
* Sets the value of the 'keywords' field.
* [05] Comma separated list of keywords of consumer interests or intent.
* @param value the value to set.
*/
public void setKeywords(java.lang.CharSequence value) {
this.keywords = value;
}
/**
* Gets the value of the 'customdata' field.
* [06] 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.
*/
public java.lang.CharSequence getCustomdata() {
return customdata;
}
/**
* Sets the value of the 'customdata' field.
* [06] 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.
* @param value the value to set.
*/
public void setCustomdata(java.lang.CharSequence value) {
this.customdata = value;
}
/**
* Gets the value of the 'geo' field.
* [07] 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.
*/
public com.adgear.avro.openrtb.Geo getGeo() {
return geo;
}
/**
* Sets the value of the 'geo' field.
* [07] 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.
* @param value the value to set.
*/
public void setGeo(com.adgear.avro.openrtb.Geo value) {
this.geo = value;
}
/**
* Gets the value of the 'data' field.
* [08] See Data Object.
*/
public java.util.List getData() {
return data;
}
/**
* Sets the value of the 'data' field.
* [08] See Data Object.
* @param value the value to set.
*/
public void setData(java.util.List value) {
this.data = value;
}
/** Creates a new User RecordBuilder */
public static com.adgear.avro.openrtb.User.Builder newBuilder() {
return new com.adgear.avro.openrtb.User.Builder();
}
/** Creates a new User RecordBuilder by copying an existing Builder */
public static com.adgear.avro.openrtb.User.Builder newBuilder(com.adgear.avro.openrtb.User.Builder other) {
return new com.adgear.avro.openrtb.User.Builder(other);
}
/** Creates a new User RecordBuilder by copying an existing User instance */
public static com.adgear.avro.openrtb.User.Builder newBuilder(com.adgear.avro.openrtb.User other) {
return new com.adgear.avro.openrtb.User.Builder(other);
}
/**
* RecordBuilder for User instances.
*/
public static class Builder extends org.apache.avro.specific.SpecificRecordBuilderBase
implements org.apache.avro.data.RecordBuilder {
private java.lang.CharSequence id;
private java.lang.CharSequence buyeruid;
private java.lang.Integer yob;
private java.lang.CharSequence gender;
private java.lang.CharSequence keywords;
private java.lang.CharSequence customdata;
private com.adgear.avro.openrtb.Geo geo;
private java.util.List data;
/** Creates a new Builder */
private Builder() {
super(com.adgear.avro.openrtb.User.SCHEMA$);
}
/** Creates a Builder by copying an existing Builder */
private Builder(com.adgear.avro.openrtb.User.Builder other) {
super(other);
}
/** Creates a Builder by copying an existing User instance */
private Builder(com.adgear.avro.openrtb.User other) {
super(com.adgear.avro.openrtb.User.SCHEMA$);
if (isValidValue(fields()[0], other.id)) {
this.id = data().deepCopy(fields()[0].schema(), other.id);
fieldSetFlags()[0] = true;
}
if (isValidValue(fields()[1], other.buyeruid)) {
this.buyeruid = data().deepCopy(fields()[1].schema(), other.buyeruid);
fieldSetFlags()[1] = true;
}
if (isValidValue(fields()[2], other.yob)) {
this.yob = data().deepCopy(fields()[2].schema(), other.yob);
fieldSetFlags()[2] = true;
}
if (isValidValue(fields()[3], other.gender)) {
this.gender = data().deepCopy(fields()[3].schema(), other.gender);
fieldSetFlags()[3] = true;
}
if (isValidValue(fields()[4], other.keywords)) {
this.keywords = data().deepCopy(fields()[4].schema(), other.keywords);
fieldSetFlags()[4] = true;
}
if (isValidValue(fields()[5], other.customdata)) {
this.customdata = data().deepCopy(fields()[5].schema(), other.customdata);
fieldSetFlags()[5] = true;
}
if (isValidValue(fields()[6], other.geo)) {
this.geo = data().deepCopy(fields()[6].schema(), other.geo);
fieldSetFlags()[6] = true;
}
if (isValidValue(fields()[7], other.data)) {
this.data = data().deepCopy(fields()[7].schema(), other.data);
fieldSetFlags()[7] = true;
}
}
/** Gets the value of the 'id' field */
public java.lang.CharSequence getId() {
return id;
}
/** Sets the value of the 'id' field */
public com.adgear.avro.openrtb.User.Builder setId(java.lang.CharSequence value) {
validate(fields()[0], value);
this.id = value;
fieldSetFlags()[0] = true;
return this;
}
/** Checks whether the 'id' field has been set */
public boolean hasId() {
return fieldSetFlags()[0];
}
/** Clears the value of the 'id' field */
public com.adgear.avro.openrtb.User.Builder clearId() {
id = null;
fieldSetFlags()[0] = false;
return this;
}
/** Gets the value of the 'buyeruid' field */
public java.lang.CharSequence getBuyeruid() {
return buyeruid;
}
/** Sets the value of the 'buyeruid' field */
public com.adgear.avro.openrtb.User.Builder setBuyeruid(java.lang.CharSequence value) {
validate(fields()[1], value);
this.buyeruid = value;
fieldSetFlags()[1] = true;
return this;
}
/** Checks whether the 'buyeruid' field has been set */
public boolean hasBuyeruid() {
return fieldSetFlags()[1];
}
/** Clears the value of the 'buyeruid' field */
public com.adgear.avro.openrtb.User.Builder clearBuyeruid() {
buyeruid = null;
fieldSetFlags()[1] = false;
return this;
}
/** Gets the value of the 'yob' field */
public java.lang.Integer getYob() {
return yob;
}
/** Sets the value of the 'yob' field */
public com.adgear.avro.openrtb.User.Builder setYob(java.lang.Integer value) {
validate(fields()[2], value);
this.yob = value;
fieldSetFlags()[2] = true;
return this;
}
/** Checks whether the 'yob' field has been set */
public boolean hasYob() {
return fieldSetFlags()[2];
}
/** Clears the value of the 'yob' field */
public com.adgear.avro.openrtb.User.Builder clearYob() {
yob = null;
fieldSetFlags()[2] = false;
return this;
}
/** Gets the value of the 'gender' field */
public java.lang.CharSequence getGender() {
return gender;
}
/** Sets the value of the 'gender' field */
public com.adgear.avro.openrtb.User.Builder setGender(java.lang.CharSequence value) {
validate(fields()[3], value);
this.gender = value;
fieldSetFlags()[3] = true;
return this;
}
/** Checks whether the 'gender' field has been set */
public boolean hasGender() {
return fieldSetFlags()[3];
}
/** Clears the value of the 'gender' field */
public com.adgear.avro.openrtb.User.Builder clearGender() {
gender = null;
fieldSetFlags()[3] = false;
return this;
}
/** Gets the value of the 'keywords' field */
public java.lang.CharSequence getKeywords() {
return keywords;
}
/** Sets the value of the 'keywords' field */
public com.adgear.avro.openrtb.User.Builder setKeywords(java.lang.CharSequence value) {
validate(fields()[4], value);
this.keywords = value;
fieldSetFlags()[4] = true;
return this;
}
/** Checks whether the 'keywords' field has been set */
public boolean hasKeywords() {
return fieldSetFlags()[4];
}
/** Clears the value of the 'keywords' field */
public com.adgear.avro.openrtb.User.Builder clearKeywords() {
keywords = null;
fieldSetFlags()[4] = false;
return this;
}
/** Gets the value of the 'customdata' field */
public java.lang.CharSequence getCustomdata() {
return customdata;
}
/** Sets the value of the 'customdata' field */
public com.adgear.avro.openrtb.User.Builder setCustomdata(java.lang.CharSequence value) {
validate(fields()[5], value);
this.customdata = value;
fieldSetFlags()[5] = true;
return this;
}
/** Checks whether the 'customdata' field has been set */
public boolean hasCustomdata() {
return fieldSetFlags()[5];
}
/** Clears the value of the 'customdata' field */
public com.adgear.avro.openrtb.User.Builder clearCustomdata() {
customdata = null;
fieldSetFlags()[5] = false;
return this;
}
/** Gets the value of the 'geo' field */
public com.adgear.avro.openrtb.Geo getGeo() {
return geo;
}
/** Sets the value of the 'geo' field */
public com.adgear.avro.openrtb.User.Builder setGeo(com.adgear.avro.openrtb.Geo value) {
validate(fields()[6], value);
this.geo = value;
fieldSetFlags()[6] = true;
return this;
}
/** Checks whether the 'geo' field has been set */
public boolean hasGeo() {
return fieldSetFlags()[6];
}
/** Clears the value of the 'geo' field */
public com.adgear.avro.openrtb.User.Builder clearGeo() {
geo = null;
fieldSetFlags()[6] = false;
return this;
}
/** Gets the value of the 'data' field */
public java.util.List getData() {
return data;
}
/** Sets the value of the 'data' field */
public com.adgear.avro.openrtb.User.Builder setData(java.util.List value) {
validate(fields()[7], value);
this.data = value;
fieldSetFlags()[7] = true;
return this;
}
/** Checks whether the 'data' field has been set */
public boolean hasData() {
return fieldSetFlags()[7];
}
/** Clears the value of the 'data' field */
public com.adgear.avro.openrtb.User.Builder clearData() {
data = null;
fieldSetFlags()[7] = false;
return this;
}
@Override
public User build() {
try {
User record = new User();
record.id = fieldSetFlags()[0] ? this.id : (java.lang.CharSequence) defaultValue(fields()[0]);
record.buyeruid = fieldSetFlags()[1] ? this.buyeruid : (java.lang.CharSequence) defaultValue(fields()[1]);
record.yob = fieldSetFlags()[2] ? this.yob : (java.lang.Integer) defaultValue(fields()[2]);
record.gender = fieldSetFlags()[3] ? this.gender : (java.lang.CharSequence) defaultValue(fields()[3]);
record.keywords = fieldSetFlags()[4] ? this.keywords : (java.lang.CharSequence) defaultValue(fields()[4]);
record.customdata = fieldSetFlags()[5] ? this.customdata : (java.lang.CharSequence) defaultValue(fields()[5]);
record.geo = fieldSetFlags()[6] ? this.geo : (com.adgear.avro.openrtb.Geo) defaultValue(fields()[6]);
record.data = fieldSetFlags()[7] ? this.data : (java.util.List) defaultValue(fields()[7]);
return record;
} catch (Exception e) {
throw new org.apache.avro.AvroRuntimeException(e);
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy