com.beeswax.openrtb

Class Openrtb.BidRequest.Geo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.beeswax.openrtb.Openrtb.BidRequest.Geo

All Implemented Interfaces:

Openrtb.BidRequest.GeoOrBuilder, 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.Geo
extends com.google.protobuf.GeneratedMessageV3
implements Openrtb.BidRequest.GeoOrBuilder

 OpenRTB 3.3.11: describes the current geographic location of the Device (e.g., based on IP
 address or GPS), or the home geo of the User (e.g., based on registration data).
 If both the Device and User objects contain Geo objects with different information,
 it’s up to the bidder to determine which Geo information to use.
 

Protobuf type openrtb.BidRequest.Geo

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Openrtb.BidRequest.Geo.Builder OpenRTB 3.3.11: describes the current geographic location of the Device (e.g., based on IP address or GPS), or the home geo of the User (e.g., based on registration data).

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CITY_FIELD_NUMBER
static int	COUNTRY_FIELD_NUMBER
static int	EXT_FIELD_NUMBER
static int	LAT_FIELD_NUMBER
static int	LON_FIELD_NUMBER
static int	METRO_FIELD_NUMBER
static com.google.protobuf.Parser<Openrtb.BidRequest.Geo>	PARSER Deprecated.
static int	REGION_FIELD_NUMBER
static int	REGIONFIPS104_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	UTCOFFSET_FIELD_NUMBER
static int	ZIP_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

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
boolean	equals(Object obj)
String	getCity() City using United Nations Code for Trade and Transport Locations (http://www.unece.org/cefact/locode/service/location.htm).
com.google.protobuf.ByteString	getCityBytes() City using United Nations Code for Trade and Transport Locations (http://www.unece.org/cefact/locode/service/location.htm).
String	getCountry() Country using ISO-3166-1 Alpha-3.
com.google.protobuf.ByteString	getCountryBytes() Country using ISO-3166-1 Alpha-3.
static Openrtb.BidRequest.Geo	getDefaultInstance()
Openrtb.BidRequest.Geo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Extension.GeoExtensions	getExt() optional .openrtb.GeoExtensions ext = 1000;
Extension.GeoExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.GeoExtensions ext = 1000;
double	getLat() Latitude from -90 to 90.
double	getLon() Longitude from -180 to 180.
String	getMetro() Pass the metro code (see http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
com.google.protobuf.ByteString	getMetroBytes() Pass the metro code (see http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
com.google.protobuf.Parser<Openrtb.BidRequest.Geo>	getParserForType()
String	getRegion() Region using ISO 3166-2
com.google.protobuf.ByteString	getRegionBytes() Region using ISO 3166-2
String	getRegionfips104() Region of a country using fips 10-4 notation (alternative to ISO 3166-2).
com.google.protobuf.ByteString	getRegionfips104Bytes() Region of a country using fips 10-4 notation (alternative to ISO 3166-2).
int	getSerializedSize()
OpenrtbCommon.Enums.BidRequest.Geo.LocationType	getType() Indicate the source of the geo data (GPS, IP address, user provided).
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getUtcoffset() Local time as the number +/- of minutes from UTC.
String	getZip() Zip/postal code.
com.google.protobuf.ByteString	getZipBytes() Zip/postal code.
boolean	hasCity() City using United Nations Code for Trade and Transport Locations (http://www.unece.org/cefact/locode/service/location.htm).
boolean	hasCountry() Country using ISO-3166-1 Alpha-3.
boolean	hasExt() optional .openrtb.GeoExtensions ext = 1000;
int	hashCode()
boolean	hasLat() Latitude from -90 to 90.
boolean	hasLon() Longitude from -180 to 180.
boolean	hasMetro() Pass the metro code (see http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
boolean	hasRegion() Region using ISO 3166-2
boolean	hasRegionfips104() Region of a country using fips 10-4 notation (alternative to ISO 3166-2).
boolean	hasType() Indicate the source of the geo data (GPS, IP address, user provided).
boolean	hasUtcoffset() Local time as the number +/- of minutes from UTC.
boolean	hasZip() Zip/postal code.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Openrtb.BidRequest.Geo.Builder	newBuilder()
static Openrtb.BidRequest.Geo.Builder	newBuilder(Openrtb.BidRequest.Geo prototype)
Openrtb.BidRequest.Geo.Builder	newBuilderForType()
protected Openrtb.BidRequest.Geo.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Openrtb.BidRequest.Geo	parseDelimitedFrom(InputStream input)
static Openrtb.BidRequest.Geo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.Geo	parseFrom(byte[] data)
static Openrtb.BidRequest.Geo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.Geo	parseFrom(com.google.protobuf.ByteString data)
static Openrtb.BidRequest.Geo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.Geo	parseFrom(com.google.protobuf.CodedInputStream input)
static Openrtb.BidRequest.Geo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openrtb.BidRequest.Geo	parseFrom(InputStream input)
static Openrtb.BidRequest.Geo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Openrtb.BidRequest.Geo>	parser()
Openrtb.BidRequest.Geo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, 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

LAT_FIELD_NUMBER

public static final int LAT_FIELD_NUMBER

See Also:

Constant Field Values

LON_FIELD_NUMBER

public static final int LON_FIELD_NUMBER

See Also:

Constant Field Values

COUNTRY_FIELD_NUMBER

public static final int COUNTRY_FIELD_NUMBER

See Also:

Constant Field Values

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER

See Also:

Constant Field Values

REGIONFIPS104_FIELD_NUMBER

public static final int REGIONFIPS104_FIELD_NUMBER

See Also:

Constant Field Values

METRO_FIELD_NUMBER

public static final int METRO_FIELD_NUMBER

See Also:

Constant Field Values

CITY_FIELD_NUMBER

public static final int CITY_FIELD_NUMBER

See Also:

Constant Field Values

ZIP_FIELD_NUMBER

public static final int ZIP_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

UTCOFFSET_FIELD_NUMBER

public static final int UTCOFFSET_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.Geo> 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()

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasLat

public boolean hasLat()

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

optional double lat = 1;

Specified by:

hasLat in interface Openrtb.BidRequest.GeoOrBuilder

getLat

public double getLat()

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

optional double lat = 1;

Specified by:

getLat in interface Openrtb.BidRequest.GeoOrBuilder

hasLon

public boolean hasLon()

 Longitude from -180 to 180. West is negative. This should only be passed if known
 to be accurate (For example, not the centroid of a postal code).
 

optional double lon = 2;

Specified by:

hasLon in interface Openrtb.BidRequest.GeoOrBuilder

getLon

public double getLon()

 Longitude from -180 to 180. West is negative. This should only be passed if known
 to be accurate (For example, not the centroid of a postal code).
 

optional double lon = 2;

Specified by:

getLon in interface Openrtb.BidRequest.GeoOrBuilder

hasCountry

public boolean hasCountry()

 Country using ISO-3166-1 Alpha-3.
 

optional string country = 3;

Specified by:

hasCountry in interface Openrtb.BidRequest.GeoOrBuilder

getCountry

public String getCountry()

 Country using ISO-3166-1 Alpha-3.
 

optional string country = 3;

Specified by:

getCountry in interface Openrtb.BidRequest.GeoOrBuilder

getCountryBytes

public com.google.protobuf.ByteString getCountryBytes()

 Country using ISO-3166-1 Alpha-3.
 

optional string country = 3;

Specified by:

getCountryBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasRegion

public boolean hasRegion()

 Region using ISO 3166-2
 

optional string region = 4;

Specified by:

hasRegion in interface Openrtb.BidRequest.GeoOrBuilder

getRegion

public String getRegion()

 Region using ISO 3166-2
 

optional string region = 4;

Specified by:

getRegion in interface Openrtb.BidRequest.GeoOrBuilder

getRegionBytes

public com.google.protobuf.ByteString getRegionBytes()

 Region using ISO 3166-2
 

optional string region = 4;

Specified by:

getRegionBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasRegionfips104

public boolean hasRegionfips104()

 Region of a country using fips 10-4 notation (alternative to ISO 3166-2).
 

optional string regionfips104 = 5;

Specified by:

hasRegionfips104 in interface Openrtb.BidRequest.GeoOrBuilder

getRegionfips104

public String getRegionfips104()

 Region of a country using fips 10-4 notation (alternative to ISO 3166-2).
 

optional string regionfips104 = 5;

Specified by:

getRegionfips104 in interface Openrtb.BidRequest.GeoOrBuilder

getRegionfips104Bytes

public com.google.protobuf.ByteString getRegionfips104Bytes()

 Region of a country using fips 10-4 notation (alternative to ISO 3166-2).
 

optional string regionfips104 = 5;

Specified by:

getRegionfips104Bytes in interface Openrtb.BidRequest.GeoOrBuilder

hasMetro

public boolean hasMetro()

 Pass the metro code (see http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
 Metro codes are similar to but not exactly the same as Nielsen DMAs.
 

optional string metro = 6;

Specified by:

hasMetro in interface Openrtb.BidRequest.GeoOrBuilder

getMetro

public String getMetro()

 Pass the metro code (see http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
 Metro codes are similar to but not exactly the same as Nielsen DMAs.
 

optional string metro = 6;

Specified by:

getMetro in interface Openrtb.BidRequest.GeoOrBuilder

getMetroBytes

public com.google.protobuf.ByteString getMetroBytes()

 Pass the metro code (see http://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
 Metro codes are similar to but not exactly the same as Nielsen DMAs.
 

optional string metro = 6;

Specified by:

getMetroBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasCity

public boolean hasCity()

 City using United Nations Code for Trade and Transport Locations
 (http://www.unece.org/cefact/locode/service/location.htm).
 

optional string city = 7;

Specified by:

hasCity in interface Openrtb.BidRequest.GeoOrBuilder

getCity

public String getCity()

 City using United Nations Code for Trade and Transport Locations
 (http://www.unece.org/cefact/locode/service/location.htm).
 

optional string city = 7;

Specified by:

getCity in interface Openrtb.BidRequest.GeoOrBuilder

getCityBytes

public com.google.protobuf.ByteString getCityBytes()

 City using United Nations Code for Trade and Transport Locations
 (http://www.unece.org/cefact/locode/service/location.htm).
 

optional string city = 7;

Specified by:

getCityBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasZip

public boolean hasZip()

 Zip/postal code.
 

optional string zip = 8;

Specified by:

hasZip in interface Openrtb.BidRequest.GeoOrBuilder

getZip

public String getZip()

 Zip/postal code.
 

optional string zip = 8;

Specified by:

getZip in interface Openrtb.BidRequest.GeoOrBuilder

getZipBytes

public com.google.protobuf.ByteString getZipBytes()

 Zip/postal code.
 

optional string zip = 8;

Specified by:

getZipBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasType

public boolean hasType()

 Indicate the source of the geo data (GPS, IP address, user provided).
 Type should be provided when lat/lon is provided.
 

optional .openrtb.Enums.BidRequest.Geo.LocationType type = 9;

Specified by:

hasType in interface Openrtb.BidRequest.GeoOrBuilder

getType

public OpenrtbCommon.Enums.BidRequest.Geo.LocationType getType()

 Indicate the source of the geo data (GPS, IP address, user provided).
 Type should be provided when lat/lon is provided.
 

optional .openrtb.Enums.BidRequest.Geo.LocationType type = 9;

Specified by:

getType in interface Openrtb.BidRequest.GeoOrBuilder

hasUtcoffset

public boolean hasUtcoffset()

 Local time as the number +/- of minutes from UTC.
 

optional int32 utcoffset = 10;

Specified by:

hasUtcoffset in interface Openrtb.BidRequest.GeoOrBuilder

getUtcoffset

public int getUtcoffset()

 Local time as the number +/- of minutes from UTC.
 

optional int32 utcoffset = 10;

Specified by:

getUtcoffset in interface Openrtb.BidRequest.GeoOrBuilder

hasExt

public boolean hasExt()

optional .openrtb.GeoExtensions ext = 1000;

Specified by:

hasExt in interface Openrtb.BidRequest.GeoOrBuilder

getExt

public Extension.GeoExtensions getExt()

optional .openrtb.GeoExtensions ext = 1000;

Specified by:

getExt in interface Openrtb.BidRequest.GeoOrBuilder

getExtOrBuilder

public Extension.GeoExtensionsOrBuilder getExtOrBuilder()

optional .openrtb.GeoExtensions ext = 1000;

Specified by:

getExtOrBuilder in interface Openrtb.BidRequest.GeoOrBuilder

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 Openrtb.BidRequest.Geo parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openrtb.BidRequest.Geo parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Openrtb.BidRequest.Geo.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.Geo.Builder newBuilder()

newBuilder

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

toBuilder

public Openrtb.BidRequest.Geo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Openrtb.BidRequest.Geo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Openrtb.BidRequest.Geo getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Openrtb.BidRequest.Geo> 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.Geo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder