com.beeswax.openrtb

Interface Openrtb.BidRequest.ImpressionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Openrtb.BidRequest.Impression, Openrtb.BidRequest.Impression.Builder

Enclosing class:

Openrtb.BidRequest

public static interface Openrtb.BidRequest.ImpressionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Openrtb.BidRequest.Impression.Banner	getBanner() Banner object.
Openrtb.BidRequest.Impression.BannerOrBuilder	getBannerOrBuilder() 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.
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).
Extension.ImpressionExtensions	getExt() optional .openrtb.ImpressionExtensions ext = 1000;
Extension.ImpressionExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.ImpressionExtensions ext = 1000;
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.
List<String>	getIframebusterList() Array of names for supported iframe busters.
OpenrtbCommon.Flag	getInstl() YES if the ad is interstitial or full screen; else NO.
Openrtb.BidRequest.Impression.Native	getNative() A Native object (Section 3.2.5); required if this impression is offered as a native ad opportunity.
Openrtb.BidRequest.Impression.NativeOrBuilder	getNativeOrBuilder() A Native object (Section 3.2.5); required if this impression is offered as a native ad opportunity.
Openrtb.BidRequest.Impression.PMP	getPmp() Contains any Deals eligible for this Impression.
Openrtb.BidRequest.Impression.PMPOrBuilder	getPmpOrBuilder() Contains any Deals eligible for this Impression.
int	getSecure() A flag to indicate if the impression requires secure HTTPS creative assets and markup.
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.
Openrtb.BidRequest.Impression.Video	getVideo() Video object.
Openrtb.BidRequest.Impression.VideoOrBuilder	getVideoOrBuilder() Video object.
boolean	hasBanner() 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).
boolean	hasExt() optional .openrtb.ImpressionExtensions ext = 1000;
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() YES if the ad is interstitial or full screen; else NO.
boolean	hasNative() A Native object (Section 3.2.5); required if this impression is offered as a native ad opportunity.
boolean	hasPmp() Contains any Deals eligible for this Impression.
boolean	hasSecure() A flag to indicate if the impression requires secure HTTPS creative assets and markup.
boolean	hasTagid() Identifier for specific ad placement or ad tag that was used to initiate the auction.
boolean	hasVideo() Video object.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasId

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

required string id = 1;

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

required string id = 1;

getIdBytes

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

required string id = 1;

hasBanner

boolean hasBanner()

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

optional .openrtb.BidRequest.Impression.Banner banner = 2;

getBanner

Openrtb.BidRequest.Impression.Banner getBanner()

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

optional .openrtb.BidRequest.Impression.Banner banner = 2;

getBannerOrBuilder

Openrtb.BidRequest.Impression.BannerOrBuilder getBannerOrBuilder()

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

optional .openrtb.BidRequest.Impression.Banner banner = 2;

hasVideo

boolean hasVideo()

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

optional .openrtb.BidRequest.Impression.Video video = 3;

getVideo

Openrtb.BidRequest.Impression.Video getVideo()

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

optional .openrtb.BidRequest.Impression.Video video = 3;

getVideoOrBuilder

Openrtb.BidRequest.Impression.VideoOrBuilder getVideoOrBuilder()

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

optional .openrtb.BidRequest.Impression.Video video = 3;

hasNative

boolean hasNative()

 A Native object (Section 3.2.5); required if this impression is
 offered as a native ad opportunity.
 

optional .openrtb.BidRequest.Impression.Native native = 13;

getNative

Openrtb.BidRequest.Impression.Native getNative()

 A Native object (Section 3.2.5); required if this impression is
 offered as a native ad opportunity.
 

optional .openrtb.BidRequest.Impression.Native native = 13;

getNativeOrBuilder

Openrtb.BidRequest.Impression.NativeOrBuilder getNativeOrBuilder()

 A Native object (Section 3.2.5); required if this impression is
 offered as a native ad opportunity.
 

optional .openrtb.BidRequest.Impression.Native native = 13;

hasDisplaymanager

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;

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.
 

optional string displaymanager = 4;

getDisplaymanagerBytes

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;

hasDisplaymanagerver

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;

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.
 

optional string displaymanagerver = 5;

getDisplaymanagerverBytes

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;

hasInstl

boolean hasInstl()

 YES if the ad is interstitial or full screen; else NO.
 

optional .openrtb.Flag instl = 6 [default = NO];

getInstl

OpenrtbCommon.Flag getInstl()

 YES if the ad is interstitial or full screen; else NO.
 

optional .openrtb.Flag instl = 6 [default = NO];

hasTagid

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;

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.
 

optional string tagid = 7;

getTagidBytes

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;

hasBidfloor

boolean hasBidfloor()

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

optional double bidfloor = 8 [default = 0];

getBidfloor

double getBidfloor()

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

optional double bidfloor = 8 [default = 0];

hasBidfloorcur

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"];

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.
 

optional string bidfloorcur = 9 [default = "USD"];

getBidfloorcurBytes

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"];

getIframebusterList

List<String> getIframebusterList()

 Array of names for supported iframe busters. Exchange specific.
 

repeated string iframebuster = 10;

getIframebusterCount

int getIframebusterCount()

 Array of names for supported iframe busters. Exchange specific.
 

repeated string iframebuster = 10;

getIframebuster

String getIframebuster(int index)

 Array of names for supported iframe busters. Exchange specific.
 

repeated string iframebuster = 10;

getIframebusterBytes

com.google.protobuf.ByteString getIframebusterBytes(int index)

 Array of names for supported iframe busters. Exchange specific.
 

repeated string iframebuster = 10;

hasPmp

boolean hasPmp()

 Contains any Deals eligible for this Impression.
 

optional .openrtb.BidRequest.Impression.PMP pmp = 11;

getPmp

Openrtb.BidRequest.Impression.PMP getPmp()

 Contains any Deals eligible for this Impression.
 

optional .openrtb.BidRequest.Impression.PMP pmp = 11;

getPmpOrBuilder

Openrtb.BidRequest.Impression.PMPOrBuilder getPmpOrBuilder()

 Contains any Deals eligible for this Impression.
 

optional .openrtb.BidRequest.Impression.PMP pmp = 11;

hasSecure

boolean hasSecure()

 A flag to indicate if the impression requires secure HTTPS creative
 assets and markup.
 Value of 1 indicates that the impression requires secure creatives.
 If the value is 0 or not set, then the impression allows non-secure
 HTTP creatives.
 

optional int32 secure = 12;

getSecure

int getSecure()

 A flag to indicate if the impression requires secure HTTPS creative
 assets and markup.
 Value of 1 indicates that the impression requires secure creatives.
 If the value is 0 or not set, then the impression allows non-secure
 HTTP creatives.
 

optional int32 secure = 12;

hasExt

boolean hasExt()

optional .openrtb.ImpressionExtensions ext = 1000;

getExt

Extension.ImpressionExtensions getExt()

optional .openrtb.ImpressionExtensions ext = 1000;

getExtOrBuilder

Extension.ImpressionExtensionsOrBuilder getExtOrBuilder()

optional .openrtb.ImpressionExtensions ext = 1000;