com.beeswax.openrtb

Interface Openrtb.BidRequest.Impression.BannerOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

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

Enclosing class:

Openrtb.BidRequest.Impression

public static interface Openrtb.BidRequest.Impression.BannerOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework	getApi(int index) List of supported API frameworks for this banner.
int	getApiCount() List of supported API frameworks for this banner.
List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework>	getApiList() List of supported API frameworks for this banner.
OpenrtbCommon.CreativeAttribute	getBattr(int index) Blocked creative attributes.
int	getBattrCount() Blocked creative attributes.
List<OpenrtbCommon.CreativeAttribute>	getBattrList() Blocked creative attributes.
OpenrtbCommon.Enums.BidRequest.Impression.Banner.AdType	getBtype(int index) Blocked creative types.
int	getBtypeCount() Blocked creative types.
List<OpenrtbCommon.Enums.BidRequest.Impression.Banner.AdType>	getBtypeList() Blocked creative types.
OpenrtbCommon.Enums.BidRequest.Impression.Banner.ExpandableDirection	getExpdir(int index) Specify properties for an expandable ad.
int	getExpdirCount() Specify properties for an expandable ad.
List<OpenrtbCommon.Enums.BidRequest.Impression.Banner.ExpandableDirection>	getExpdirList() Specify properties for an expandable ad.
Extension.BannerExtensions	getExt() optional .openrtb.BannerExtensions ext = 1000;
Extension.BannerExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.BannerExtensions ext = 1000;
int	getH() Height of the impression in pixels.
int	getHmax() Maximum height of the impression in pixels.
int	getHmin() Minumum height of the impression in pixels.
String	getId() Unique identifier for this banner object.
com.google.protobuf.ByteString	getIdBytes() Unique identifier for this banner object.
String	getMimes(int index) Whitelist of content MIME types supported.
com.google.protobuf.ByteString	getMimesBytes(int index) Whitelist of content MIME types supported.
int	getMimesCount() Whitelist of content MIME types supported.
List<String>	getMimesList() Whitelist of content MIME types supported.
OpenrtbCommon.Enums.BidRequest.Impression.AdPosition	getPos() The position of the ad as a relative measure of visibility or prominence.
OpenrtbCommon.Flag	getTopframe() Specify if the banner is delivered in the top frame (YES) or in an iframe (NO).
int	getW() Width of the impression in pixels.
int	getWmax() Maximum width of the impression in pixels.
int	getWmin() Minimum width of the impression in pixels.
boolean	hasExt() optional .openrtb.BannerExtensions ext = 1000;
boolean	hasH() Height of the impression in pixels.
boolean	hasHmax() Maximum height of the impression in pixels.
boolean	hasHmin() Minumum height of the impression in pixels.
boolean	hasId() Unique identifier for this banner object.
boolean	hasPos() The position of the ad as a relative measure of visibility or prominence.
boolean	hasTopframe() Specify if the banner is delivered in the top frame (YES) or in an iframe (NO).
boolean	hasW() Width of the impression in pixels.
boolean	hasWmax() Maximum width of the impression in pixels.
boolean	hasWmin() Minimum width of the impression in pixels.

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

hasW

boolean hasW()

 Width of the impression in pixels. Since some ad types are not restricted by size
 this field is not required, but it’s highly recommended.
 

optional int32 w = 1;

getW

int getW()

 Width of the impression in pixels. Since some ad types are not restricted by size
 this field is not required, but it’s highly recommended.
 

optional int32 w = 1;

hasH

boolean hasH()

 Height of the impression in pixels. Since some ad types are not restricted by size
 this field is not required, but it’s highly recommended.
 

optional int32 h = 2;

getH

int getH()

 Height of the impression in pixels. Since some ad types are not restricted by size
 this field is not required, but it’s highly recommended.
 

optional int32 h = 2;

hasWmax

boolean hasWmax()

 Maximum width of the impression in pixels. If included, it indicates that a range
 of sizes is allowed with this maximum width and "w" is taken as recommended.
 If not included, then "w" should be considered an exact requirement.
 

optional int32 wmax = 11;

getWmax

int getWmax()

 Maximum width of the impression in pixels. If included, it indicates that a range
 of sizes is allowed with this maximum width and "w" is taken as recommended.
 If not included, then "w" should be considered an exact requirement.
 

optional int32 wmax = 11;

hasHmax

boolean hasHmax()

 Maximum height of the impression in pixels. If included, it indicates that a range
 of sizes is allowed with this maximum height and "h" is taken as recommended.
 If not included, then "h" should be considered an exact requirement.
 

optional int32 hmax = 12;

getHmax

int getHmax()

 Maximum height of the impression in pixels. If included, it indicates that a range
 of sizes is allowed with this maximum height and "h" is taken as recommended.
 If not included, then "h" should be considered an exact requirement.
 

optional int32 hmax = 12;

hasWmin

boolean hasWmin()

 Minimum width of the impression in pixels. If included, it indicates that a range
 of sizes is allowed with this minimum width and "w" is taken as recommended.
 If not included, then "w" should be considered an exact requirement.
 

optional int32 wmin = 13;

getWmin

int getWmin()

 Minimum width of the impression in pixels. If included, it indicates that a range
 of sizes is allowed with this minimum width and "w" is taken as recommended.
 If not included, then "w" should be considered an exact requirement.
 

optional int32 wmin = 13;

hasHmin

boolean hasHmin()

 Minumum height of the impression in pixels. If included, it indicates
 that a range of sizes is allowed with this minimum height and "h" is
 taken as recommended.
 If not included, then "h" should be considered an exact requirement.
 

optional int32 hmin = 14;

getHmin

int getHmin()

 Minumum height of the impression in pixels. If included, it indicates
 that a range of sizes is allowed with this minimum height and "h" is
 taken as recommended.
 If not included, then "h" should be considered an exact requirement.
 

optional int32 hmin = 14;

hasId

boolean hasId()

 Unique identifier for this banner object. Useful for tracking multiple banner objects
 (e.g., in companion banner array). Usually starts with 1, increasing with each object.
 Combination of impression id X banner id should be unique.
 

optional string id = 3;

getId

String getId()

 Unique identifier for this banner object. Useful for tracking multiple banner objects
 (e.g., in companion banner array). Usually starts with 1, increasing with each object.
 Combination of impression id X banner id should be unique.
 

optional string id = 3;

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 Unique identifier for this banner object. Useful for tracking multiple banner objects
 (e.g., in companion banner array). Usually starts with 1, increasing with each object.
 Combination of impression id X banner id should be unique.
 

optional string id = 3;

hasPos

boolean hasPos()

 The position of the ad as a relative measure of visibility or
 prominence.
 

optional .openrtb.Enums.BidRequest.Impression.AdPosition pos = 4 [default = POSITION_UNKNOWN];

getPos

OpenrtbCommon.Enums.BidRequest.Impression.AdPosition getPos()

 The position of the ad as a relative measure of visibility or
 prominence.
 

optional .openrtb.Enums.BidRequest.Impression.AdPosition pos = 4 [default = POSITION_UNKNOWN];

getBtypeList

List<OpenrtbCommon.Enums.BidRequest.Impression.Banner.AdType> getBtypeList()

 Blocked creative types. If blank, assume all types are allowed.
 

repeated .openrtb.Enums.BidRequest.Impression.Banner.AdType btype = 5;

getBtypeCount

int getBtypeCount()

 Blocked creative types. If blank, assume all types are allowed.
 

repeated .openrtb.Enums.BidRequest.Impression.Banner.AdType btype = 5;

getBtype

OpenrtbCommon.Enums.BidRequest.Impression.Banner.AdType getBtype(int index)

 Blocked creative types. If blank, assume all types are allowed.
 

repeated .openrtb.Enums.BidRequest.Impression.Banner.AdType btype = 5;

getBattrList

List<OpenrtbCommon.CreativeAttribute> getBattrList()

 Blocked creative attributes. If blank assume all types are allowed.
 

repeated .openrtb.CreativeAttribute battr = 6;

getBattrCount

int getBattrCount()

 Blocked creative attributes. If blank assume all types are allowed.
 

repeated .openrtb.CreativeAttribute battr = 6;

getBattr

OpenrtbCommon.CreativeAttribute getBattr(int index)

 Blocked creative attributes. If blank assume all types are allowed.
 

repeated .openrtb.CreativeAttribute battr = 6;

getMimesList

List<String> getMimesList()

 Whitelist of content MIME types supported. Popular MIME types include,
 but are not limited to “image/jpg”, “image/gif” and “application/x-shockwave-flash”.
 

repeated string mimes = 7;

getMimesCount

int getMimesCount()

 Whitelist of content MIME types supported. Popular MIME types include,
 but are not limited to “image/jpg”, “image/gif” and “application/x-shockwave-flash”.
 

repeated string mimes = 7;

getMimes

String getMimes(int index)

 Whitelist of content MIME types supported. Popular MIME types include,
 but are not limited to “image/jpg”, “image/gif” and “application/x-shockwave-flash”.
 

repeated string mimes = 7;

getMimesBytes

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

 Whitelist of content MIME types supported. Popular MIME types include,
 but are not limited to “image/jpg”, “image/gif” and “application/x-shockwave-flash”.
 

repeated string mimes = 7;

hasTopframe

boolean hasTopframe()

 Specify if the banner is delivered in the top frame (YES) or in an iframe (NO).
 

optional .openrtb.Flag topframe = 8 [default = NO];

getTopframe

OpenrtbCommon.Flag getTopframe()

 Specify if the banner is delivered in the top frame (YES) or in an iframe (NO).
 

optional .openrtb.Flag topframe = 8 [default = NO];

getExpdirList

List<OpenrtbCommon.Enums.BidRequest.Impression.Banner.ExpandableDirection> getExpdirList()

 Specify properties for an expandable ad.
 

repeated .openrtb.Enums.BidRequest.Impression.Banner.ExpandableDirection expdir = 9;

getExpdirCount

int getExpdirCount()

 Specify properties for an expandable ad.
 

repeated .openrtb.Enums.BidRequest.Impression.Banner.ExpandableDirection expdir = 9;

getExpdir

OpenrtbCommon.Enums.BidRequest.Impression.Banner.ExpandableDirection getExpdir(int index)

 Specify properties for an expandable ad.
 

repeated .openrtb.Enums.BidRequest.Impression.Banner.ExpandableDirection expdir = 9;

getApiList

List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> getApiList()

 List of supported API frameworks for this banner. If an API is not explicitly listed
 it is assumed not to be supported.
 

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 10;

getApiCount

int getApiCount()

 List of supported API frameworks for this banner. If an API is not explicitly listed
 it is assumed not to be supported.
 

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 10;

getApi

OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework getApi(int index)

 List of supported API frameworks for this banner. If an API is not explicitly listed
 it is assumed not to be supported.
 

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 10;

hasExt

boolean hasExt()

optional .openrtb.BannerExtensions ext = 1000;

getExt

Extension.BannerExtensions getExt()

optional .openrtb.BannerExtensions ext = 1000;

getExtOrBuilder

Extension.BannerExtensionsOrBuilder getExtOrBuilder()

optional .openrtb.BannerExtensions ext = 1000;