open_rtb

Class Impression.Protobuf

java.lang.Object

open_rtb.Impression.Protobuf

All Implemented Interfaces:

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

Enclosing interface:

Impression<T>

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface open_rtb.Impression

Impression.Avro, Impression.AvroBuilder, Impression.Builder<T>, Impression.Comparator, Impression.NativeImpl, Impression.Protobuf, Impression.ProtobufBuilder, Impression.Thrift, Impression.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 Impression<OpenRtbProtobuf.Impression>	from(byte[] binaryEncoding) Decodes a Protobuf message.
OpenRtbProtobuf.Impression	get() Returns underlying object.
Banner<?>	getBanner() A reference to a banner object.
double	getBidfloor() Bid floor for this impression (in CPM of bidfloorcur).
String	getBidfloorcur() If bid floor is specified and multiple currencies supported per bid request, then currency should be specified here using ISO-4217 alphabetic codes.
String	getDisplaymanager() Name of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile).
String	getDisplaymanagerver() Version of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile).
String	getId() A unique identifier for this impression within the context of the bid request (typically, value starts with 1, and increments up to n for n impressions).
List<String>	getIframebuster() Array of names for supported iframe busters.
int	getInstl() 1 if the ad is interstitial or full screen; else 0 (i.e., no).
Pmp<?>	getPmp() A reference to the PMP object containing any Deals eligible for the impression object.
int	getSecure() Flag to indicate whether the impression requires secure HTTPS URL creative assets and markup.
String	getTagid() Identifier for specific ad placement or ad tag that was used to initiate the auction.
Video<?>	getVideo() A reference to a video object.
int	hashCode()
boolean	isDefaultBanner()
boolean	isDefaultBidfloor()
boolean	isDefaultBidfloorcur()
boolean	isDefaultDisplaymanager()
boolean	isDefaultDisplaymanagerver()
boolean	isDefaultId()
boolean	isDefaultIframebuster()
boolean	isDefaultInstl()
boolean	isDefaultPmp()
boolean	isDefaultSecure()
boolean	isDefaultTagid()
boolean	isDefaultVideo()
Impression.Builder<OpenRtbProtobuf.Impression>	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.Impression

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.Impression get()

Description copied from interface: Impression

Returns underlying object.

Specified by:

get in interface Supplier<OpenRtbProtobuf.Impression>

Specified by:

get in interface Impression<OpenRtbProtobuf.Impression>

newBuilder

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

Description copied from interface: Impression

Creates a new builder based on this object.

Specified by:

newBuilder in interface Impression<OpenRtbProtobuf.Impression>

getId

public String getId()

Description copied from interface: Impression

A unique identifier for this impression within the context of the bid request (typically, value starts with 1, and increments up to n for n impressions).

Specified by:

getId in interface Impression<OpenRtbProtobuf.Impression>

isDefaultId

public boolean isDefaultId()

Specified by:

isDefaultId in interface Impression<OpenRtbProtobuf.Impression>

getBanner

public Banner<?> getBanner()

Description copied from interface: Impression

A reference to a banner object. Either a banner or video object (or both if the impression could be either) must be included in an impression object. See Banner Object.

Specified by:

getBanner in interface Impression<OpenRtbProtobuf.Impression>

isDefaultBanner

public boolean isDefaultBanner()

Specified by:

isDefaultBanner in interface Impression<OpenRtbProtobuf.Impression>

getVideo

public Video<?> getVideo()

Description copied from interface: Impression

A reference to a video object. Either a banner or video object (or both if the impression could be either) must be included in an impression object. See Video Object.

Specified by:

getVideo in interface Impression<OpenRtbProtobuf.Impression>

isDefaultVideo

public boolean isDefaultVideo()

Specified by:

isDefaultVideo in interface Impression<OpenRtbProtobuf.Impression>

getDisplaymanager

public String getDisplaymanager()

Description copied from interface: Impression

Name of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner.

Specified by:

getDisplaymanager in interface Impression<OpenRtbProtobuf.Impression>

isDefaultDisplaymanager

public boolean isDefaultDisplaymanager()

Specified by:

isDefaultDisplaymanager in interface Impression<OpenRtbProtobuf.Impression>

getDisplaymanagerver

public String getDisplaymanagerver()

Description copied from interface: Impression

Version of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner.

Specified by:

getDisplaymanagerver in interface Impression<OpenRtbProtobuf.Impression>

isDefaultDisplaymanagerver

public boolean isDefaultDisplaymanagerver()

Specified by:

isDefaultDisplaymanagerver in interface Impression<OpenRtbProtobuf.Impression>

getInstl

public int getInstl()

Description copied from interface: Impression

1 if the ad is interstitial or full screen; else 0 (i.e., no).

Specified by:

getInstl in interface Impression<OpenRtbProtobuf.Impression>

isDefaultInstl

public boolean isDefaultInstl()

Specified by:

isDefaultInstl in interface Impression<OpenRtbProtobuf.Impression>

getTagid

public String getTagid()

Description copied from interface: Impression

Identifier for specific ad placement or ad tag that was used to initiate the auction. This can be useful for debugging of any issues, or for optimization by the buyer.

Specified by:

getTagid in interface Impression<OpenRtbProtobuf.Impression>

isDefaultTagid

public boolean isDefaultTagid()

Specified by:

isDefaultTagid in interface Impression<OpenRtbProtobuf.Impression>

getBidfloor

public double getBidfloor()

Description copied from interface: Impression

Bid floor for this impression (in CPM of bidfloorcur).

Specified by:

getBidfloor in interface Impression<OpenRtbProtobuf.Impression>

isDefaultBidfloor

public boolean isDefaultBidfloor()

Specified by:

isDefaultBidfloor in interface Impression<OpenRtbProtobuf.Impression>

getBidfloorcur

public String getBidfloorcur()

Description copied from interface: Impression

If bid floor is specified and multiple currencies supported per bid request, then currency should be specified here using ISO-4217 alphabetic codes. Note, this may be different from bid currency returned by bidder, if this is allowed on an exchange.

Specified by:

getBidfloorcur in interface Impression<OpenRtbProtobuf.Impression>

isDefaultBidfloorcur

public boolean isDefaultBidfloorcur()

Specified by:

isDefaultBidfloorcur in interface Impression<OpenRtbProtobuf.Impression>

getSecure

public int getSecure()

Description copied from interface: Impression

Flag to indicate whether the impression requires secure HTTPS URL creative assets and markup. A value of “1” means that the impression requires secure assets. A value of "0" means non-secure assets. If this field is omitted the bidder should interpret the secure state is unknown and assume HTTP is supported.

Specified by:

getSecure in interface Impression<OpenRtbProtobuf.Impression>

isDefaultSecure

public boolean isDefaultSecure()

Specified by:

isDefaultSecure in interface Impression<OpenRtbProtobuf.Impression>

getIframebuster

public List<String> getIframebuster()

Description copied from interface: Impression

Array of names for supported iframe busters. Exchange specific.

Specified by:

getIframebuster in interface Impression<OpenRtbProtobuf.Impression>

isDefaultIframebuster

public boolean isDefaultIframebuster()

Specified by:

isDefaultIframebuster in interface Impression<OpenRtbProtobuf.Impression>

getPmp

public Pmp<?> getPmp()

Description copied from interface: Impression

A reference to the PMP object containing any Deals eligible for the impression object. See the PMP Object definition.

Specified by:

getPmp in interface Impression<OpenRtbProtobuf.Impression>

isDefaultPmp

public boolean isDefaultPmp()

Specified by:

isDefaultPmp in interface Impression<OpenRtbProtobuf.Impression>

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 Impression<OpenRtbProtobuf.Impression> from(byte[] binaryEncoding)
                                                   throws IOException

Decodes a Protobuf message.

Throws:

IOException