Impression (anoa-tests 3.1.2 API)

All Superinterfaces:

Comparable<Impression<?>>, Serializable, Supplier<T>

All Known Implementing Classes:

Impression.Avro, Impression.NativeImpl, Impression.Protobuf, Impression.Thrift
```
public interface Impression<T>
extends Supplier<T>, Comparable<Impression<?>>, Serializable
```
3.3.2 Impression Object The “imp” object describes the ad position or impression being auctioned. A single bid request can include multiple “imp” objects, a use case for which might be an exchange that supports selling all ad positions on a given page as a bundle. Each “imp” object has a required ID so that bids can reference them individually. An exchange can also conduct private auctions by restricting involvement to specific subsets of seats within bidders.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Impression.Avro`
`static class`	`Impression.AvroBuilder`
`static interface`	`Impression.Builder<T>`
`static class`	`Impression.Comparator`
`static class`	`Impression.NativeImpl`
`static class`	`Impression.Protobuf`
`static class`	`Impression.ProtobufBuilder`
`static class`	`Impression.Thrift`
`static class`	`Impression.ThriftBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Impression.Avro`	`avro(Impression<?> instance)` Returns a wrapped Avro record based on an instance of Impression.
`static Impression.Avro`	`avro(ImpressionAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Impression<?> other)`
`T`	`get()` Returns underlying object.
`static Class<ImpressionAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`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.
`static Comparator<Impression<?>>`	`getComparator()` Returns comparator instance for Impression objects.
`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.
`static Class<OpenRtbProtobuf.Impression>`	`getProtobufClass()` Returns Protobuf class for this struct.
`static com.google.protobuf.Descriptors.Descriptor`	`getProtobufDescriptor()` Returns Protobuf descriptor for this struct.
`static Class<AdExchangeProtobuf>`	`getProtobufProtocolClass()` Returns Protobuf protocol class for this struct.
`static com.google.protobuf.Descriptors.FileDescriptor`	`getProtobufProtocolDescriptor()` Returns Protobuf protocol descriptor for this struct.
`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.
`static Class<ImpressionThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<ImpressionThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`Video<?>`	`getVideo()` A reference to a video object.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultBanner()`
`boolean`	`isDefaultBidfloor()`
`boolean`	`isDefaultBidfloorcur()`
`boolean`	`isDefaultDisplaymanager()`
`boolean`	`isDefaultDisplaymanagerver()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultIframebuster()`
`boolean`	`isDefaultInstl()`
`boolean`	`isDefaultPmp()`
`boolean`	`isDefaultSecure()`
`boolean`	`isDefaultTagid()`
`boolean`	`isDefaultVideo()`
`static Impression.NativeImpl`	`nativeImpl(Impression<?> instance)` Returns a POJO based on an instance of Impression.
`static Impression.Builder<ImpressionAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Impression.Builder<ImpressionAvro>`	`newAvroBuilder(Impression<?> other)` Returns new Avro builder instance based on existing prototype Impression.
`static Impression.Builder<ImpressionAvro>`	`newAvroBuilder(ImpressionAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Impression.Builder<ImpressionAvro>`	`newAvroBuilder(ImpressionAvro other)` Returns new Avro builder instance based on existing prototype.
`Impression.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Impression.Builder<Impression.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Impression.Builder<Impression.NativeImpl>`	`newNativeImplBuilder(Impression<?> other)` Returns a POJO builder instance based on existing prototype Impression.
`static Impression.Builder<OpenRtbProtobuf.Impression>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Impression.Builder<OpenRtbProtobuf.Impression>`	`newProtobufBuilder(Impression<?> other)` Returns new Protobuf builder instance based on existing prototype Impression.
`static Impression.Builder<OpenRtbProtobuf.Impression>`	`newProtobufBuilder(OpenRtbProtobuf.Impression other)` Returns new Protobuf builder instance based on existing prototype.
`static Impression.Builder<ImpressionThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Impression.Builder<ImpressionThrift>`	`newThriftBuilder(Impression<?> other)` Returns new Thrift builder instance based on existing prototype Impression.
`static Impression.Builder<ImpressionThrift>`	`newThriftBuilder(ImpressionThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Impression.Protobuf`	`protobuf(Impression<?> instance)` Returns a wrapped Protobuf message based on an instance of Impression.
`static Impression.Protobuf`	`protobuf(OpenRtbProtobuf.Impression wrapped)` Wraps an existing Protobuf message.
`static Impression.Thrift`	`thrift(Impression<?> instance)` Returns a wrapped Thrift struct based on an instance of Impression.
`static Impression.Thrift`	`thrift(ImpressionThrift instance)` Creates a new wrapped Thrift struct copied from an existing instance.

- Method Detail
  - isDefault
```
default boolean isDefault()
```
    True if all fields are set to default values.
  - get
```
T get()
```
    Returns underlying object.
    
    Specified by:
    
    get in interface Supplier<T>
  - newBuilder
```
Impression.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
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).
  - isDefaultId
```
boolean isDefaultId()
```
  - getBanner
```
Banner<?> getBanner()
```
    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.
  - isDefaultBanner
```
boolean isDefaultBanner()
```
  - getVideo
```
Video<?> getVideo()
```
    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.
  - isDefaultVideo
```
boolean isDefaultVideo()
```
  - getDisplaymanager
```
String getDisplaymanager()
```
    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.
  - isDefaultDisplaymanager
```
boolean isDefaultDisplaymanager()
```
  - getDisplaymanagerver
```
String getDisplaymanagerver()
```
    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.
  - isDefaultDisplaymanagerver
```
boolean isDefaultDisplaymanagerver()
```
  - getInstl
```
int getInstl()
```
    1 if the ad is interstitial or full screen; else 0 (i.e., no).
  - isDefaultInstl
```
boolean isDefaultInstl()
```
  - getTagid
```
String getTagid()
```
    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.
  - isDefaultTagid
```
boolean isDefaultTagid()
```
  - getBidfloor
```
double getBidfloor()
```
    Bid floor for this impression (in CPM of bidfloorcur).
  - isDefaultBidfloor
```
boolean isDefaultBidfloor()
```
  - getBidfloorcur
```
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. Note, this may be different from bid currency returned by bidder, if this is allowed on an exchange.
  - isDefaultBidfloorcur
```
boolean isDefaultBidfloorcur()
```
  - getSecure
```
int getSecure()
```
    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.
  - isDefaultSecure
```
boolean isDefaultSecure()
```
  - getIframebuster
```
List<String> getIframebuster()
```
    Array of names for supported iframe busters. Exchange specific.
  - isDefaultIframebuster
```
boolean isDefaultIframebuster()
```
  - getPmp
```
Pmp<?> getPmp()
```
    A reference to the PMP object containing any Deals eligible for the impression object. See the PMP Object definition.
  - isDefaultPmp
```
boolean isDefaultPmp()
```
  - getComparator
```
static Comparator<Impression<?>> getComparator()
```
    Returns comparator instance for Impression objects.
  - compareTo
```
default int compareTo(Impression<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Impression<?>>
  - newNativeImplBuilder
```
static Impression.Builder<Impression.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Impression.Builder<Impression.NativeImpl> newNativeImplBuilder(Impression<?> other)
```
    Returns a POJO builder instance based on existing prototype Impression.
  - nativeImpl
```
static Impression.NativeImpl nativeImpl(Impression<?> instance)
```
    Returns a POJO based on an instance of Impression.
  - newAvroBuilder
```
static Impression.Builder<ImpressionAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Impression.Builder<ImpressionAvro> newAvroBuilder(ImpressionAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Impression.Builder<ImpressionAvro> newAvroBuilder(ImpressionAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Impression.Builder<ImpressionAvro> newAvroBuilder(Impression<?> other)
```
    Returns new Avro builder instance based on existing prototype Impression.
  - avro
```
static Impression.Avro avro(Impression<?> instance)
```
    Returns a wrapped Avro record based on an instance of Impression.
  - avro
```
static Impression.Avro avro(ImpressionAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<ImpressionAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Impression.Builder<OpenRtbProtobuf.Impression> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Impression.Builder<OpenRtbProtobuf.Impression> newProtobufBuilder(OpenRtbProtobuf.Impression other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Impression.Builder<OpenRtbProtobuf.Impression> newProtobufBuilder(Impression<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Impression.
  - protobuf
```
static Impression.Protobuf protobuf(Impression<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Impression.
  - protobuf
```
static Impression.Protobuf protobuf(OpenRtbProtobuf.Impression wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Impression> getProtobufClass()
```
    Returns Protobuf class for this struct.
  - getProtobufProtocolClass
```
static Class<AdExchangeProtobuf> getProtobufProtocolClass()
```
    Returns Protobuf protocol class for this struct.
  - getProtobufDescriptor
```
static com.google.protobuf.Descriptors.Descriptor getProtobufDescriptor()
```
    Returns Protobuf descriptor for this struct.
  - getProtobufProtocolDescriptor
```
static com.google.protobuf.Descriptors.FileDescriptor getProtobufProtocolDescriptor()
```
    Returns Protobuf protocol descriptor for this struct.
  - newThriftBuilder
```
static Impression.Builder<ImpressionThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Impression.Builder<ImpressionThrift> newThriftBuilder(ImpressionThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Impression.Builder<ImpressionThrift> newThriftBuilder(Impression<?> other)
```
    Returns new Thrift builder instance based on existing prototype Impression.
  - thrift
```
static Impression.Thrift thrift(Impression<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Impression.
  - thrift
```
static Impression.Thrift thrift(ImpressionThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<ImpressionThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<ImpressionThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Impression<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getBanner

isDefaultBanner

getVideo

isDefaultVideo

getDisplaymanager

isDefaultDisplaymanager

getDisplaymanagerver

isDefaultDisplaymanagerver

getInstl

isDefaultInstl

getTagid

isDefaultTagid

getBidfloor

isDefaultBidfloor

getBidfloorcur

isDefaultBidfloorcur

getSecure

isDefaultSecure

getIframebuster

isDefaultIframebuster

getPmp

isDefaultPmp

getComparator

compareTo

newNativeImplBuilder

newNativeImplBuilder

nativeImpl

newAvroBuilder

newAvroBuilder

newAvroBuilder

newAvroBuilder

avro

avro

getAvroClass

getAvroSchema

newProtobufBuilder

newProtobufBuilder

newProtobufBuilder

protobuf

protobuf

getProtobufClass

getProtobufProtocolClass

getProtobufDescriptor

getProtobufProtocolDescriptor

newThriftBuilder

newThriftBuilder

newThriftBuilder

thrift

thrift

getThriftClass

getThriftMetadataMap