com.beeswax.openrtb

Class Openrtb.BidRequest.Geo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

Protobuf type openrtb.BidRequest.Geo

 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.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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	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.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	getCity() optional string city = 7;
com.google.protobuf.ByteString	getCityBytes() optional string city = 7;
String	getCountry() optional string country = 3;
com.google.protobuf.ByteString	getCountryBytes() optional string country = 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() optional double lat = 1;
double	getLon() optional double lon = 2;
String	getMetro() optional string metro = 6;
com.google.protobuf.ByteString	getMetroBytes() optional string metro = 6;
com.google.protobuf.Parser<Openrtb.BidRequest.Geo>	getParserForType()
String	getRegion() optional string region = 4;
com.google.protobuf.ByteString	getRegionBytes() optional string region = 4;
String	getRegionfips104() optional string regionfips104 = 5;
com.google.protobuf.ByteString	getRegionfips104Bytes() optional string regionfips104 = 5;
int	getSerializedSize()
OpenrtbCommon.Enums.BidRequest.Geo.LocationType	getType() optional .openrtb.Enums.BidRequest.Geo.LocationType type = 9;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getUtcoffset() optional int32 utcoffset = 10;
String	getZip() optional string zip = 8;
com.google.protobuf.ByteString	getZipBytes() optional string zip = 8;
boolean	hasCity() optional string city = 7;
boolean	hasCountry() optional string country = 3;
boolean	hasExt() optional .openrtb.GeoExtensions ext = 1000;
boolean	hasLat() optional double lat = 1;
boolean	hasLon() optional double lon = 2;
boolean	hasMetro() optional string metro = 6;
boolean	hasRegion() optional string region = 4;
boolean	hasRegionfips104() optional string regionfips104 = 5;
boolean	hasType() optional .openrtb.Enums.BidRequest.Geo.LocationType type = 9;
boolean	hasUtcoffset() optional int32 utcoffset = 10;
boolean	hasZip() optional string zip = 8;
protected com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.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

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

hasLat

public boolean hasLat()

optional double lat = 1;

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

Specified by:

hasLat in interface Openrtb.BidRequest.GeoOrBuilder

getLat

public double getLat()

optional double lat = 1;

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

Specified by:

getLat in interface Openrtb.BidRequest.GeoOrBuilder

hasLon

public boolean hasLon()

optional double lon = 2;

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

Specified by:

hasLon in interface Openrtb.BidRequest.GeoOrBuilder

getLon

public double getLon()

optional double lon = 2;

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

Specified by:

getLon in interface Openrtb.BidRequest.GeoOrBuilder

hasCountry

public boolean hasCountry()

optional string country = 3;

 Country using ISO-3166-1 Alpha-3.
 

Specified by:

hasCountry in interface Openrtb.BidRequest.GeoOrBuilder

getCountry

public String getCountry()

optional string country = 3;

 Country using ISO-3166-1 Alpha-3.
 

Specified by:

getCountry in interface Openrtb.BidRequest.GeoOrBuilder

getCountryBytes

public com.google.protobuf.ByteString getCountryBytes()

optional string country = 3;

 Country using ISO-3166-1 Alpha-3.
 

Specified by:

getCountryBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasRegion

public boolean hasRegion()

optional string region = 4;

 Region using ISO 3166-2
 

Specified by:

hasRegion in interface Openrtb.BidRequest.GeoOrBuilder

getRegion

public String getRegion()

optional string region = 4;

 Region using ISO 3166-2
 

Specified by:

getRegion in interface Openrtb.BidRequest.GeoOrBuilder

getRegionBytes

public com.google.protobuf.ByteString getRegionBytes()

optional string region = 4;

 Region using ISO 3166-2
 

Specified by:

getRegionBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasRegionfips104

public boolean hasRegionfips104()

optional string regionfips104 = 5;

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

Specified by:

hasRegionfips104 in interface Openrtb.BidRequest.GeoOrBuilder

getRegionfips104

public String getRegionfips104()

optional string regionfips104 = 5;

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

Specified by:

getRegionfips104 in interface Openrtb.BidRequest.GeoOrBuilder

getRegionfips104Bytes

public com.google.protobuf.ByteString getRegionfips104Bytes()

optional string regionfips104 = 5;

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

Specified by:

getRegionfips104Bytes in interface Openrtb.BidRequest.GeoOrBuilder

hasMetro

public boolean hasMetro()

optional string metro = 6;

 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.
 

Specified by:

hasMetro in interface Openrtb.BidRequest.GeoOrBuilder

getMetro

public String getMetro()

optional string metro = 6;

 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.
 

Specified by:

getMetro in interface Openrtb.BidRequest.GeoOrBuilder

getMetroBytes

public com.google.protobuf.ByteString getMetroBytes()

optional string metro = 6;

 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.
 

Specified by:

getMetroBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasCity

public boolean hasCity()

optional string city = 7;

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

Specified by:

hasCity in interface Openrtb.BidRequest.GeoOrBuilder

getCity

public String getCity()

optional string city = 7;

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

Specified by:

getCity in interface Openrtb.BidRequest.GeoOrBuilder

getCityBytes

public com.google.protobuf.ByteString getCityBytes()

optional string city = 7;

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

Specified by:

getCityBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasZip

public boolean hasZip()

optional string zip = 8;

 Zip/postal code.
 

Specified by:

hasZip in interface Openrtb.BidRequest.GeoOrBuilder

getZip

public String getZip()

optional string zip = 8;

 Zip/postal code.
 

Specified by:

getZip in interface Openrtb.BidRequest.GeoOrBuilder

getZipBytes

public com.google.protobuf.ByteString getZipBytes()

optional string zip = 8;

 Zip/postal code.
 

Specified by:

getZipBytes in interface Openrtb.BidRequest.GeoOrBuilder

hasType

public boolean hasType()

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

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

Specified by:

hasType in interface Openrtb.BidRequest.GeoOrBuilder

getType

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

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

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

Specified by:

getType in interface Openrtb.BidRequest.GeoOrBuilder

hasUtcoffset

public boolean hasUtcoffset()

optional int32 utcoffset = 10;

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

Specified by:

hasUtcoffset in interface Openrtb.BidRequest.GeoOrBuilder

getUtcoffset

public int getUtcoffset()

optional int32 utcoffset = 10;

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

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage

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

getDefaultInstanceForType

public Openrtb.BidRequest.Geo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder