open_rtb

Class Device.Protobuf

java.lang.Object

open_rtb.Device.Protobuf

All Implemented Interfaces:

Serializable, Comparable<Device<?>>, Supplier<OpenRtbProtobuf.Device>, Device<OpenRtbProtobuf.Device>

Enclosing interface:

Device<T>

public static class Device.Protobuf
extends Object
implements Device<OpenRtbProtobuf.Device>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface open_rtb.Device

Device.Avro, Device.AvroBuilder, Device.Builder<T>, Device.Comparator, Device.NativeImpl, Device.Protobuf, Device.ProtobufBuilder, Device.Thrift, Device.ThriftBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Protobuf(byte[] binaryEncoding) Constructs a new Protobuf instance based on a message's binary encoding.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static Device<OpenRtbProtobuf.Device>	from(byte[] binaryEncoding) Decodes a Protobuf message.
OpenRtbProtobuf.Device	get() Returns underlying object.
String	getCarrier() Carrier or ISP derived from the IP address.
int	getConnectiontype() Return the detected data connection type for the device.
int	getDevicetype() Return the device type being used.
String	getDidmd5() MD5 hashed device ID; IMEI when available, else MEID or ESN.
String	getDidsha1() SHA1 hashed device ID; IMEI when available, else MEID or ESN.
int	getDnt() If “0”, then do not track Is set to false, if “1”, then do no track is set to true in browser.
String	getDpidmd5() MD5 hashed platform-specific ID (e.g., Android ID or UDID for iOS).
String	getDpidsha1() SHA1 hashed platform-specific ID (e.g., Android ID or UDID for iOS).
String	getFlashver() Return the Flash version detected.
Geo<?>	getGeo() Geography as derived from the device’s location services (e.g., cell tower triangulation, GPS) or IP address.
String	getIfa() Native identifier for advertisers; an opaque ID assigned by the device or browser for use as an advertising identifier.
String	getIp() IPv4 address closest to device.
String	getIpv6() IP address in IPv6.
int	getJs() “1” if the device supports JavaScript; else “0”.
String	getLanguage() Browser language; use alpha-2/ISO 639-1 codes.
String	getMacmd5() MD5 hashed MAC address of the device.
String	getMacsha1() SHA1 hashed MAC address of the device.
String	getMake() Device make (e.g., “Apple”).
String	getModel() Device model (e.g., “iPhone”).
String	getOs() Device operating system (e.g., “iOS”).
String	getOsv() Device operating system version (e.g., “3.1.2”).
String	getUa() Browser user agent string.
int	hashCode()
boolean	isDefaultCarrier()
boolean	isDefaultConnectiontype()
boolean	isDefaultDevicetype()
boolean	isDefaultDidmd5()
boolean	isDefaultDidsha1()
boolean	isDefaultDnt()
boolean	isDefaultDpidmd5()
boolean	isDefaultDpidsha1()
boolean	isDefaultFlashver()
boolean	isDefaultGeo()
boolean	isDefaultIfa()
boolean	isDefaultIp()
boolean	isDefaultIpv6()
boolean	isDefaultJs()
boolean	isDefaultLanguage()
boolean	isDefaultMacmd5()
boolean	isDefaultMacsha1()
boolean	isDefaultMake()
boolean	isDefaultModel()
boolean	isDefaultOs()
boolean	isDefaultOsv()
boolean	isDefaultUa()
Device.Builder<OpenRtbProtobuf.Device>	newBuilder() Creates a new builder based on this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface open_rtb.Device

avro, avro, compareTo, getAvroClass, getAvroSchema, getComparator, getProtobufClass, getProtobufDescriptor, getProtobufProtocolClass, getProtobufProtocolDescriptor, getThriftClass, getThriftMetadataMap, isDefault, nativeImpl, newAvroBuilder, newAvroBuilder, newAvroBuilder, newAvroBuilder, newNativeImplBuilder, newNativeImplBuilder, newProtobufBuilder, newProtobufBuilder, newProtobufBuilder, newThriftBuilder, newThriftBuilder, newThriftBuilder, protobuf, protobuf, thrift, thrift

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Protobuf

public Protobuf(byte[] binaryEncoding)

Constructs a new Protobuf instance based on a message's binary encoding. Only use this if you know what you're doing.

Method Detail

get

public OpenRtbProtobuf.Device get()

Description copied from interface: Device

Returns underlying object.

Specified by:

get in interface Supplier<OpenRtbProtobuf.Device>

Specified by:

get in interface Device<OpenRtbProtobuf.Device>

newBuilder

public Device.Builder<OpenRtbProtobuf.Device> newBuilder()

Description copied from interface: Device

Creates a new builder based on this object.

Specified by:

newBuilder in interface Device<OpenRtbProtobuf.Device>

getDnt

public int getDnt()

Description copied from interface: Device

If “0”, then do not track Is set to false, if “1”, then do no track is set to true in browser.

Specified by:

getDnt in interface Device<OpenRtbProtobuf.Device>

isDefaultDnt

public boolean isDefaultDnt()

Specified by:

isDefaultDnt in interface Device<OpenRtbProtobuf.Device>

getUa

public String getUa()

Description copied from interface: Device

Browser user agent string.

Specified by:

getUa in interface Device<OpenRtbProtobuf.Device>

isDefaultUa

public boolean isDefaultUa()

Specified by:

isDefaultUa in interface Device<OpenRtbProtobuf.Device>

getIp

public String getIp()

Description copied from interface: Device

IPv4 address closest to device.

Specified by:

getIp in interface Device<OpenRtbProtobuf.Device>

isDefaultIp

public boolean isDefaultIp()

Specified by:

isDefaultIp in interface Device<OpenRtbProtobuf.Device>

getGeo

public Geo<?> getGeo()

Description copied from interface: Device

Geography as derived from the device’s location services (e.g., cell tower triangulation, GPS) or IP address. See Geo Object.

Specified by:

getGeo in interface Device<OpenRtbProtobuf.Device>

isDefaultGeo

public boolean isDefaultGeo()

Specified by:

isDefaultGeo in interface Device<OpenRtbProtobuf.Device>

getDidsha1

public String getDidsha1()

Description copied from interface: Device

SHA1 hashed device ID; IMEI when available, else MEID or ESN. OpenRTB’s preferred method for device ID hashing is SHA1.

Specified by:

getDidsha1 in interface Device<OpenRtbProtobuf.Device>

isDefaultDidsha1

public boolean isDefaultDidsha1()

Specified by:

isDefaultDidsha1 in interface Device<OpenRtbProtobuf.Device>

getDidmd5

public String getDidmd5()

Description copied from interface: Device

MD5 hashed device ID; IMEI when available, else MEID or ESN. Should be interpreted as case insensitive.

Specified by:

getDidmd5 in interface Device<OpenRtbProtobuf.Device>

isDefaultDidmd5

public boolean isDefaultDidmd5()

Specified by:

isDefaultDidmd5 in interface Device<OpenRtbProtobuf.Device>

getDpidsha1

public String getDpidsha1()

Description copied from interface: Device

SHA1 hashed platform-specific ID (e.g., Android ID or UDID for iOS). OpenRTB’s preferred method for device ID hash is SHA1.

Specified by:

getDpidsha1 in interface Device<OpenRtbProtobuf.Device>

isDefaultDpidsha1

public boolean isDefaultDpidsha1()

Specified by:

isDefaultDpidsha1 in interface Device<OpenRtbProtobuf.Device>

getDpidmd5

public String getDpidmd5()

Description copied from interface: Device

MD5 hashed platform-specific ID (e.g., Android ID or UDID for iOS). Should be interpreted as case insensitive.

Specified by:

getDpidmd5 in interface Device<OpenRtbProtobuf.Device>

isDefaultDpidmd5

public boolean isDefaultDpidmd5()

Specified by:

isDefaultDpidmd5 in interface Device<OpenRtbProtobuf.Device>

getMacsha1

public String getMacsha1()

Description copied from interface: Device

SHA1 hashed MAC address of the device.

Specified by:

getMacsha1 in interface Device<OpenRtbProtobuf.Device>

isDefaultMacsha1

public boolean isDefaultMacsha1()

Specified by:

isDefaultMacsha1 in interface Device<OpenRtbProtobuf.Device>

getMacmd5

public String getMacmd5()

Description copied from interface: Device

MD5 hashed MAC address of the device.

Specified by:

getMacmd5 in interface Device<OpenRtbProtobuf.Device>

isDefaultMacmd5

public boolean isDefaultMacmd5()

Specified by:

isDefaultMacmd5 in interface Device<OpenRtbProtobuf.Device>

getIpv6

public String getIpv6()

Description copied from interface: Device

IP address in IPv6.

Specified by:

getIpv6 in interface Device<OpenRtbProtobuf.Device>

isDefaultIpv6

public boolean isDefaultIpv6()

Specified by:

isDefaultIpv6 in interface Device<OpenRtbProtobuf.Device>

getCarrier

public String getCarrier()

Description copied from interface: Device

Carrier or ISP derived from the IP address. Should be specified using Mobile Network Code (MNC) http://en.wikipedia.org/wiki/Mobile_Network_Code

Specified by:

getCarrier in interface Device<OpenRtbProtobuf.Device>

isDefaultCarrier

public boolean isDefaultCarrier()

Specified by:

isDefaultCarrier in interface Device<OpenRtbProtobuf.Device>

getLanguage

public String getLanguage()

Description copied from interface: Device

Browser language; use alpha-2/ISO 639-1 codes.

Specified by:

getLanguage in interface Device<OpenRtbProtobuf.Device>

isDefaultLanguage

public boolean isDefaultLanguage()

Specified by:

isDefaultLanguage in interface Device<OpenRtbProtobuf.Device>

getMake

public String getMake()

Description copied from interface: Device

Device make (e.g., “Apple”).

Specified by:

getMake in interface Device<OpenRtbProtobuf.Device>

isDefaultMake

public boolean isDefaultMake()

Specified by:

isDefaultMake in interface Device<OpenRtbProtobuf.Device>

getModel

public String getModel()

Description copied from interface: Device

Device model (e.g., “iPhone”).

Specified by:

getModel in interface Device<OpenRtbProtobuf.Device>

isDefaultModel

public boolean isDefaultModel()

Specified by:

isDefaultModel in interface Device<OpenRtbProtobuf.Device>

getOs

public String getOs()

Description copied from interface: Device

Device operating system (e.g., “iOS”).

Specified by:

getOs in interface Device<OpenRtbProtobuf.Device>

isDefaultOs

public boolean isDefaultOs()

Specified by:

isDefaultOs in interface Device<OpenRtbProtobuf.Device>

getOsv

public String getOsv()

Description copied from interface: Device

Device operating system version (e.g., “3.1.2”).

Specified by:

getOsv in interface Device<OpenRtbProtobuf.Device>

isDefaultOsv

public boolean isDefaultOsv()

Specified by:

isDefaultOsv in interface Device<OpenRtbProtobuf.Device>

getJs

public int getJs()

Description copied from interface: Device

“1” if the device supports JavaScript; else “0”.

Specified by:

getJs in interface Device<OpenRtbProtobuf.Device>

isDefaultJs

public boolean isDefaultJs()

Specified by:

isDefaultJs in interface Device<OpenRtbProtobuf.Device>

getConnectiontype

public int getConnectiontype()

Description copied from interface: Device

Return the detected data connection type for the device. See Table 6.10 Connection Type.

Specified by:

getConnectiontype in interface Device<OpenRtbProtobuf.Device>

isDefaultConnectiontype

public boolean isDefaultConnectiontype()

Specified by:

isDefaultConnectiontype in interface Device<OpenRtbProtobuf.Device>

getDevicetype

public int getDevicetype()

Description copied from interface: Device

Return the device type being used. See Table 6.16 Device Type.

Specified by:

getDevicetype in interface Device<OpenRtbProtobuf.Device>

isDefaultDevicetype

public boolean isDefaultDevicetype()

Specified by:

isDefaultDevicetype in interface Device<OpenRtbProtobuf.Device>

getFlashver

public String getFlashver()

Description copied from interface: Device

Return the Flash version detected.

Specified by:

getFlashver in interface Device<OpenRtbProtobuf.Device>

isDefaultFlashver

public boolean isDefaultFlashver()

Specified by:

isDefaultFlashver in interface Device<OpenRtbProtobuf.Device>

getIfa

public String getIfa()

Description copied from interface: Device

Native identifier for advertisers; an opaque ID assigned by the device or browser for use as an advertising identifier. (e.g. Apple's IFA, Android's Advertising ID, etc)

Specified by:

getIfa in interface Device<OpenRtbProtobuf.Device>

isDefaultIfa

public boolean isDefaultIfa()

Specified by:

isDefaultIfa in interface Device<OpenRtbProtobuf.Device>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static Device<OpenRtbProtobuf.Device> from(byte[] binaryEncoding)
                                           throws IOException

Decodes a Protobuf message.

Throws:

IOException