public static final class OpenRtbProtobuf.Impression extends com.google.protobuf.GeneratedMessageV3 implements OpenRtbProtobuf.ImpressionOrBuilder
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.Protobuf type
open_rtb.Impression| Modifier and Type | Class and Description |
|---|---|
static class |
OpenRtbProtobuf.Impression.Builder
3.3.2 Impression Object
The “imp” object describes the ad position or impression being auctioned.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
BANNER_FIELD_NUMBER |
static int |
BIDFLOOR_FIELD_NUMBER |
static int |
BIDFLOORCUR_FIELD_NUMBER |
static int |
DISPLAYMANAGER_FIELD_NUMBER |
static int |
DISPLAYMANAGERVER_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
IFRAMEBUSTER_FIELD_NUMBER |
static int |
INSTL_FIELD_NUMBER |
static com.google.protobuf.Parser<OpenRtbProtobuf.Impression> |
PARSER
Deprecated.
|
static int |
PMP_FIELD_NUMBER |
static int |
SECURE_FIELD_NUMBER |
static int |
TAGID_FIELD_NUMBER |
static int |
VIDEO_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
OpenRtbProtobuf.Banner |
getBanner()
A reference to a banner object.
|
OpenRtbProtobuf.BannerOrBuilder |
getBannerOrBuilder()
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.
|
com.google.protobuf.ByteString |
getBidfloorcurBytes()
If bid floor is specified and multiple currencies supported per bid request, then currency should be specified here using ISO-4217 alphabetic codes.
|
static OpenRtbProtobuf.Impression |
getDefaultInstance() |
OpenRtbProtobuf.Impression |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplaymanager()
Name of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile).
|
com.google.protobuf.ByteString |
getDisplaymanagerBytes()
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).
|
com.google.protobuf.ByteString |
getDisplaymanagerverBytes()
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).
|
com.google.protobuf.ByteString |
getIdBytes()
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).
|
String |
getIframebuster(int index)
Array of names for supported iframe busters.
|
com.google.protobuf.ByteString |
getIframebusterBytes(int index)
Array of names for supported iframe busters.
|
int |
getIframebusterCount()
Array of names for supported iframe busters.
|
com.google.protobuf.ProtocolStringList |
getIframebusterList()
Array of names for supported iframe busters.
|
int |
getInstl()
1 if the ad is interstitial or full screen; else 0 (i.e., no).
|
com.google.protobuf.Parser<OpenRtbProtobuf.Impression> |
getParserForType() |
OpenRtbProtobuf.Pmp |
getPmp()
A reference to the PMP object containing any Deals eligible for the impression object.
|
OpenRtbProtobuf.PmpOrBuilder |
getPmpOrBuilder()
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.
|
int |
getSerializedSize() |
String |
getTagid()
Identifier for specific ad placement or ad tag that was used to initiate the auction.
|
com.google.protobuf.ByteString |
getTagidBytes()
Identifier for specific ad placement or ad tag that was used to initiate the auction.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
OpenRtbProtobuf.Video |
getVideo()
A reference to a video object.
|
OpenRtbProtobuf.VideoOrBuilder |
getVideoOrBuilder()
A reference to a video object.
|
boolean |
hasBanner()
A reference to a banner object.
|
boolean |
hasBidfloor()
Bid floor for this impression (in CPM of bidfloorcur).
|
boolean |
hasBidfloorcur()
If bid floor is specified and multiple currencies supported per bid request, then currency should be specified here using ISO-4217 alphabetic codes.
|
boolean |
hasDisplaymanager()
Name of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile).
|
boolean |
hasDisplaymanagerver()
Version of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile).
|
int |
hashCode() |
boolean |
hasId()
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).
|
boolean |
hasInstl()
1 if the ad is interstitial or full screen; else 0 (i.e., no).
|
boolean |
hasPmp()
A reference to the PMP object containing any Deals eligible for the impression object.
|
boolean |
hasSecure()
Flag to indicate whether the impression requires secure HTTPS URL creative assets and markup.
|
boolean |
hasTagid()
Identifier for specific ad placement or ad tag that was used to initiate the auction.
|
boolean |
hasVideo()
A reference to a video object.
|
boolean |
isInitialized() |
static OpenRtbProtobuf.Impression.Builder |
newBuilder() |
static OpenRtbProtobuf.Impression.Builder |
newBuilder(OpenRtbProtobuf.Impression prototype) |
OpenRtbProtobuf.Impression.Builder |
newBuilderForType() |
static OpenRtbProtobuf.Impression |
parseDelimitedFrom(InputStream input) |
static OpenRtbProtobuf.Impression |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Impression |
parseFrom(byte[] data) |
static OpenRtbProtobuf.Impression |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Impression |
parseFrom(com.google.protobuf.ByteString data) |
static OpenRtbProtobuf.Impression |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Impression |
parseFrom(com.google.protobuf.CodedInputStream input) |
static OpenRtbProtobuf.Impression |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Impression |
parseFrom(InputStream input) |
static OpenRtbProtobuf.Impression |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<OpenRtbProtobuf.Impression> |
parser() |
OpenRtbProtobuf.Impression.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoffindInitializationErrors, getInitializationErrorString, toStringtoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int ID_FIELD_NUMBER
public static final int BANNER_FIELD_NUMBER
public static final int VIDEO_FIELD_NUMBER
public static final int DISPLAYMANAGER_FIELD_NUMBER
public static final int DISPLAYMANAGERVER_FIELD_NUMBER
public static final int INSTL_FIELD_NUMBER
public static final int TAGID_FIELD_NUMBER
public static final int BIDFLOOR_FIELD_NUMBER
public static final int BIDFLOORCUR_FIELD_NUMBER
public static final int SECURE_FIELD_NUMBER
public static final int IFRAMEBUSTER_FIELD_NUMBER
public static final int PMP_FIELD_NUMBER
@Deprecated public static final com.google.protobuf.Parser<OpenRtbProtobuf.Impression> PARSER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
public boolean hasId()
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).
optional string id = 1;hasId in interface OpenRtbProtobuf.ImpressionOrBuilderpublic 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).
optional string id = 1;getId in interface OpenRtbProtobuf.ImpressionOrBuilderpublic com.google.protobuf.ByteString getIdBytes()
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).
optional string id = 1;getIdBytes in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasBanner()
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.
optional .open_rtb.Banner banner = 2;hasBanner in interface OpenRtbProtobuf.ImpressionOrBuilderpublic OpenRtbProtobuf.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.
optional .open_rtb.Banner banner = 2;getBanner in interface OpenRtbProtobuf.ImpressionOrBuilderpublic OpenRtbProtobuf.BannerOrBuilder getBannerOrBuilder()
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.
optional .open_rtb.Banner banner = 2;getBannerOrBuilder in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasVideo()
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.
optional .open_rtb.Video video = 3;hasVideo in interface OpenRtbProtobuf.ImpressionOrBuilderpublic OpenRtbProtobuf.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.
optional .open_rtb.Video video = 3;getVideo in interface OpenRtbProtobuf.ImpressionOrBuilderpublic OpenRtbProtobuf.VideoOrBuilder getVideoOrBuilder()
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.
optional .open_rtb.Video video = 3;getVideoOrBuilder in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasDisplaymanager()
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.
optional string displaymanager = 4;hasDisplaymanager in interface OpenRtbProtobuf.ImpressionOrBuilderpublic 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.
optional string displaymanager = 4;getDisplaymanager in interface OpenRtbProtobuf.ImpressionOrBuilderpublic com.google.protobuf.ByteString getDisplaymanagerBytes()
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.
optional string displaymanager = 4;getDisplaymanagerBytes in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasDisplaymanagerver()
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.
optional string displaymanagerver = 5;hasDisplaymanagerver in interface OpenRtbProtobuf.ImpressionOrBuilderpublic 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.
optional string displaymanagerver = 5;getDisplaymanagerver in interface OpenRtbProtobuf.ImpressionOrBuilderpublic com.google.protobuf.ByteString getDisplaymanagerverBytes()
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.
optional string displaymanagerver = 5;getDisplaymanagerverBytes in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasInstl()
1 if the ad is interstitial or full screen; else 0 (i.e., no).
optional uint32 instl = 6;hasInstl in interface OpenRtbProtobuf.ImpressionOrBuilderpublic int getInstl()
1 if the ad is interstitial or full screen; else 0 (i.e., no).
optional uint32 instl = 6;getInstl in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasTagid()
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.
optional string tagid = 7;hasTagid in interface OpenRtbProtobuf.ImpressionOrBuilderpublic 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.
optional string tagid = 7;getTagid in interface OpenRtbProtobuf.ImpressionOrBuilderpublic com.google.protobuf.ByteString getTagidBytes()
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.
optional string tagid = 7;getTagidBytes in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasBidfloor()
Bid floor for this impression (in CPM of bidfloorcur).
optional double bidfloor = 8;hasBidfloor in interface OpenRtbProtobuf.ImpressionOrBuilderpublic double getBidfloor()
Bid floor for this impression (in CPM of bidfloorcur).
optional double bidfloor = 8;getBidfloor in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasBidfloorcur()
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.
optional string bidfloorcur = 9 [default = "USD"];hasBidfloorcur in interface OpenRtbProtobuf.ImpressionOrBuilderpublic 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.
optional string bidfloorcur = 9 [default = "USD"];getBidfloorcur in interface OpenRtbProtobuf.ImpressionOrBuilderpublic com.google.protobuf.ByteString getBidfloorcurBytes()
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.
optional string bidfloorcur = 9 [default = "USD"];getBidfloorcurBytes in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasSecure()
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.
optional uint32 secure = 10;hasSecure in interface OpenRtbProtobuf.ImpressionOrBuilderpublic 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.
optional uint32 secure = 10;getSecure in interface OpenRtbProtobuf.ImpressionOrBuilderpublic com.google.protobuf.ProtocolStringList getIframebusterList()
Array of names for supported iframe busters. Exchange specific.
repeated string iframebuster = 11;getIframebusterList in interface OpenRtbProtobuf.ImpressionOrBuilderpublic int getIframebusterCount()
Array of names for supported iframe busters. Exchange specific.
repeated string iframebuster = 11;getIframebusterCount in interface OpenRtbProtobuf.ImpressionOrBuilderpublic String getIframebuster(int index)
Array of names for supported iframe busters. Exchange specific.
repeated string iframebuster = 11;getIframebuster in interface OpenRtbProtobuf.ImpressionOrBuilderpublic com.google.protobuf.ByteString getIframebusterBytes(int index)
Array of names for supported iframe busters. Exchange specific.
repeated string iframebuster = 11;getIframebusterBytes in interface OpenRtbProtobuf.ImpressionOrBuilderpublic boolean hasPmp()
A reference to the PMP object containing any Deals eligible for the impression object. See the PMP Object definition.
optional .open_rtb.Pmp pmp = 12;hasPmp in interface OpenRtbProtobuf.ImpressionOrBuilderpublic OpenRtbProtobuf.Pmp getPmp()
A reference to the PMP object containing any Deals eligible for the impression object. See the PMP Object definition.
optional .open_rtb.Pmp pmp = 12;getPmp in interface OpenRtbProtobuf.ImpressionOrBuilderpublic OpenRtbProtobuf.PmpOrBuilder getPmpOrBuilder()
A reference to the PMP object containing any Deals eligible for the impression object. See the PMP Object definition.
optional .open_rtb.Pmp pmp = 12;getPmpOrBuilder in interface OpenRtbProtobuf.ImpressionOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static OpenRtbProtobuf.Impression parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Impression parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Impression parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Impression parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Impression parseFrom(InputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Impression parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Impression parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Impression parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Impression parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Impression parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic OpenRtbProtobuf.Impression.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static OpenRtbProtobuf.Impression.Builder newBuilder()
public static OpenRtbProtobuf.Impression.Builder newBuilder(OpenRtbProtobuf.Impression prototype)
public OpenRtbProtobuf.Impression.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLitepublic static OpenRtbProtobuf.Impression getDefaultInstance()
public static com.google.protobuf.Parser<OpenRtbProtobuf.Impression> parser()
public com.google.protobuf.Parser<OpenRtbProtobuf.Impression> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public OpenRtbProtobuf.Impression getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2013–2016 AdGear Technologies Inc.. All rights reserved.