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() optional .openrtb.BidRequest.Impression.Banner banner = 2;
Openrtb.BidRequest.Impression.BannerOrBuilder	getBannerOrBuilder() optional .openrtb.BidRequest.Impression.Banner banner = 2;
double	getBidfloor() optional double bidfloor = 8 [default = 0];
String	getBidfloorcur() optional string bidfloorcur = 9 [default = "USD"];
com.google.protobuf.ByteString	getBidfloorcurBytes() optional string bidfloorcur = 9 [default = "USD"];
String	getDisplaymanager() optional string displaymanager = 4;
com.google.protobuf.ByteString	getDisplaymanagerBytes() optional string displaymanager = 4;
String	getDisplaymanagerver() optional string displaymanagerver = 5;
com.google.protobuf.ByteString	getDisplaymanagerverBytes() optional string displaymanagerver = 5;
Extension.ImpressionExtensions	getExt() optional .openrtb.ImpressionExtensions ext = 1000;
Extension.ImpressionExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.ImpressionExtensions ext = 1000;
String	getId() required string id = 1;
com.google.protobuf.ByteString	getIdBytes() required string id = 1;
String	getIframebuster(int index) repeated string iframebuster = 10;
com.google.protobuf.ByteString	getIframebusterBytes(int index) repeated string iframebuster = 10;
int	getIframebusterCount() repeated string iframebuster = 10;
com.google.protobuf.ProtocolStringList	getIframebusterList() repeated string iframebuster = 10;
OpenrtbCommon.Flag	getInstl() optional .openrtb.Flag instl = 6 [default = NO];
Openrtb.BidRequest.Impression.Native	getNative() optional .openrtb.BidRequest.Impression.Native native = 13;
Openrtb.BidRequest.Impression.NativeOrBuilder	getNativeOrBuilder() optional .openrtb.BidRequest.Impression.Native native = 13;
Openrtb.BidRequest.Impression.PMP	getPmp() optional .openrtb.BidRequest.Impression.PMP pmp = 11;
Openrtb.BidRequest.Impression.PMPOrBuilder	getPmpOrBuilder() optional .openrtb.BidRequest.Impression.PMP pmp = 11;
int	getSecure() optional int32 secure = 12;
String	getTagid() optional string tagid = 7;
com.google.protobuf.ByteString	getTagidBytes() optional string tagid = 7;
Openrtb.BidRequest.Impression.Video	getVideo() optional .openrtb.BidRequest.Impression.Video video = 3;
Openrtb.BidRequest.Impression.VideoOrBuilder	getVideoOrBuilder() optional .openrtb.BidRequest.Impression.Video video = 3;
boolean	hasBanner() optional .openrtb.BidRequest.Impression.Banner banner = 2;
boolean	hasBidfloor() optional double bidfloor = 8 [default = 0];
boolean	hasBidfloorcur() optional string bidfloorcur = 9 [default = "USD"];
boolean	hasDisplaymanager() optional string displaymanager = 4;
boolean	hasDisplaymanagerver() optional string displaymanagerver = 5;
boolean	hasExt() optional .openrtb.ImpressionExtensions ext = 1000;
boolean	hasId() required string id = 1;
boolean	hasInstl() optional .openrtb.Flag instl = 6 [default = NO];
boolean	hasNative() optional .openrtb.BidRequest.Impression.Native native = 13;
boolean	hasPmp() optional .openrtb.BidRequest.Impression.PMP pmp = 11;
boolean	hasSecure() optional int32 secure = 12;
boolean	hasTagid() optional string tagid = 7;
boolean	hasVideo() optional .openrtb.BidRequest.Impression.Video video = 3;

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

required string id = 1;

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

getId

String getId()

required string id = 1;

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

getIdBytes

com.google.protobuf.ByteString getIdBytes()

required string id = 1;

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

hasBanner

boolean hasBanner()

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

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

getBanner

Openrtb.BidRequest.Impression.Banner getBanner()

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

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

getBannerOrBuilder

Openrtb.BidRequest.Impression.BannerOrBuilder getBannerOrBuilder()

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

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

hasVideo

boolean hasVideo()

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

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

getVideo

Openrtb.BidRequest.Impression.Video getVideo()

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

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

getVideoOrBuilder

Openrtb.BidRequest.Impression.VideoOrBuilder getVideoOrBuilder()

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

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

hasNative

boolean hasNative()

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

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

getNative

Openrtb.BidRequest.Impression.Native getNative()

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

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

getNativeOrBuilder

Openrtb.BidRequest.Impression.NativeOrBuilder getNativeOrBuilder()

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

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

hasDisplaymanager

boolean hasDisplaymanager()

optional string displaymanager = 4;

 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.
 

getDisplaymanager

String getDisplaymanager()

optional string displaymanager = 4;

 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.
 

getDisplaymanagerBytes

com.google.protobuf.ByteString getDisplaymanagerBytes()

optional string displaymanager = 4;

 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.
 

hasDisplaymanagerver

boolean hasDisplaymanagerver()

optional string displaymanagerver = 5;

 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.
 

getDisplaymanagerver

String getDisplaymanagerver()

optional string displaymanagerver = 5;

 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.
 

getDisplaymanagerverBytes

com.google.protobuf.ByteString getDisplaymanagerverBytes()

optional string displaymanagerver = 5;

 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.
 

hasInstl

boolean hasInstl()

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

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

getInstl

OpenrtbCommon.Flag getInstl()

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

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

hasTagid

boolean hasTagid()

optional string tagid = 7;

 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.
 

getTagid

String getTagid()

optional string tagid = 7;

 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.
 

getTagidBytes

com.google.protobuf.ByteString getTagidBytes()

optional string tagid = 7;

 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.
 

hasBidfloor

boolean hasBidfloor()

optional double bidfloor = 8 [default = 0];

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

getBidfloor

double getBidfloor()

optional double bidfloor = 8 [default = 0];

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

hasBidfloorcur

boolean hasBidfloorcur()

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

 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.
 

getBidfloorcur

String getBidfloorcur()

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

 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.
 

getBidfloorcurBytes

com.google.protobuf.ByteString getBidfloorcurBytes()

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

 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.
 

getIframebusterList

com.google.protobuf.ProtocolStringList getIframebusterList()

repeated string iframebuster = 10;

 Array of names for supported iframe busters. Exchange specific.
 

getIframebusterCount

int getIframebusterCount()

repeated string iframebuster = 10;

 Array of names for supported iframe busters. Exchange specific.
 

getIframebuster

String getIframebuster(int index)

repeated string iframebuster = 10;

 Array of names for supported iframe busters. Exchange specific.
 

getIframebusterBytes

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

repeated string iframebuster = 10;

 Array of names for supported iframe busters. Exchange specific.
 

hasPmp

boolean hasPmp()

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

 Contains any Deals eligible for this Impression.
 

getPmp

Openrtb.BidRequest.Impression.PMP getPmp()

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

 Contains any Deals eligible for this Impression.
 

getPmpOrBuilder

Openrtb.BidRequest.Impression.PMPOrBuilder getPmpOrBuilder()

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

 Contains any Deals eligible for this Impression.
 

hasSecure

boolean hasSecure()

optional int32 secure = 12;

 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.
 

getSecure

int getSecure()

optional int32 secure = 12;

 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.
 

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;