public static final class OpenRtbProtobuf.Banner extends com.google.protobuf.GeneratedMessageV3 implements OpenRtbProtobuf.BannerOrBuilder
3.3.3 Banner Object The “banner” object _must_ be included directly in the impression object if the impression offered for auction is display or rich media, or it may be _optionally_ embedded in the video object to describe the companion banners available for the linear or non-linear video ad. The banner object may include a unique identifier; this can be useful if these IDs can be leveraged in the VAST response to dictate placement of the companion creatives when multiple companion ad opportunities of the same size are available on a page.Protobuf type
open_rtb.Banner| Modifier and Type | Class and Description |
|---|---|
static class |
OpenRtbProtobuf.Banner.Builder
3.3.3 Banner Object
The “banner” object _must_ be included directly in the impression object if the impression offered for auction is display or rich media, or it may be _optionally_ embedded in the video object to describe the companion banners available for the linear or non-linear video ad.
|
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 |
API_FIELD_NUMBER |
static int |
BATTR_FIELD_NUMBER |
static int |
BTYPE_FIELD_NUMBER |
static int |
EXPDIR_FIELD_NUMBER |
static int |
H_FIELD_NUMBER |
static int |
HMAX_FIELD_NUMBER |
static int |
HMIN_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
MIMES_FIELD_NUMBER |
static com.google.protobuf.Parser<OpenRtbProtobuf.Banner> |
PARSER
Deprecated.
|
static int |
POS_FIELD_NUMBER |
static int |
TOPFRAME_FIELD_NUMBER |
static int |
W_FIELD_NUMBER |
static int |
WMAX_FIELD_NUMBER |
static int |
WMIN_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
int |
getApi(int index)
List of supported API frameworks for this banner.
|
int |
getApiCount()
List of supported API frameworks for this banner.
|
List<Integer> |
getApiList()
List of supported API frameworks for this banner.
|
int |
getBattr(int index)
Blocked creative attributes.
|
int |
getBattrCount()
Blocked creative attributes.
|
List<Integer> |
getBattrList()
Blocked creative attributes.
|
int |
getBtype(int index)
Blocked creative types.
|
int |
getBtypeCount()
Blocked creative types.
|
List<Integer> |
getBtypeList()
Blocked creative types.
|
static OpenRtbProtobuf.Banner |
getDefaultInstance() |
OpenRtbProtobuf.Banner |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
int |
getExpdir(int index)
Specify properties for an expandable ad.
|
int |
getExpdirCount()
Specify properties for an expandable ad.
|
List<Integer> |
getExpdirList()
Specify properties for an expandable ad.
|
int |
getH()
Height of the impression in pixels.
|
int |
getHmax()
Maximum height of the impression in pixels.
|
int |
getHmin()
Minimum 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.
|
com.google.protobuf.ProtocolStringList |
getMimesList()
Whitelist of content MIME types supported.
|
com.google.protobuf.Parser<OpenRtbProtobuf.Banner> |
getParserForType() |
int |
getPos()
Ad Position.
|
int |
getSerializedSize() |
int |
getTopframe()
Specify if the banner is delivered in the top frame or in an iframe.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
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 |
hasH()
Height of the impression in pixels.
|
int |
hashCode() |
boolean |
hasHmax()
Maximum height of the impression in pixels.
|
boolean |
hasHmin()
Minimum height of the impression in pixels.
|
boolean |
hasId()
Unique identifier for this banner object.
|
boolean |
hasPos()
Ad Position.
|
boolean |
hasTopframe()
Specify if the banner is delivered in the top frame or in an iframe.
|
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.
|
boolean |
isInitialized() |
static OpenRtbProtobuf.Banner.Builder |
newBuilder() |
static OpenRtbProtobuf.Banner.Builder |
newBuilder(OpenRtbProtobuf.Banner prototype) |
OpenRtbProtobuf.Banner.Builder |
newBuilderForType() |
static OpenRtbProtobuf.Banner |
parseDelimitedFrom(InputStream input) |
static OpenRtbProtobuf.Banner |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Banner |
parseFrom(byte[] data) |
static OpenRtbProtobuf.Banner |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Banner |
parseFrom(com.google.protobuf.ByteString data) |
static OpenRtbProtobuf.Banner |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Banner |
parseFrom(com.google.protobuf.CodedInputStream input) |
static OpenRtbProtobuf.Banner |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Banner |
parseFrom(InputStream input) |
static OpenRtbProtobuf.Banner |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<OpenRtbProtobuf.Banner> |
parser() |
OpenRtbProtobuf.Banner.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 W_FIELD_NUMBER
public static final int H_FIELD_NUMBER
public static final int WMAX_FIELD_NUMBER
public static final int HMAX_FIELD_NUMBER
public static final int WMIN_FIELD_NUMBER
public static final int HMIN_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
public static final int POS_FIELD_NUMBER
public static final int BTYPE_FIELD_NUMBER
public static final int BATTR_FIELD_NUMBER
public static final int MIMES_FIELD_NUMBER
public static final int TOPFRAME_FIELD_NUMBER
public static final int EXPDIR_FIELD_NUMBER
public static final int API_FIELD_NUMBER
@Deprecated public static final com.google.protobuf.Parser<OpenRtbProtobuf.Banner> 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 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 that this information be included when possible.
optional uint32 w = 1;hasW in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 that this information be included when possible.
optional uint32 w = 1;getW in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 that this information be included when possible.
optional uint32 h = 2;hasH in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 that this information be included when possible.
optional uint32 h = 2;getH in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 uint32 wmax = 3;hasWmax in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 uint32 wmax = 3;getWmax in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 uint32 hmax = 4;hasHmax in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 uint32 hmax = 4;getHmax in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 uint32 wmin = 5;hasWmin in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 uint32 wmin = 5;getWmin in interface OpenRtbProtobuf.BannerOrBuilderpublic boolean hasHmin()
Minimum 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 uint32 hmin = 6;hasHmin in interface OpenRtbProtobuf.BannerOrBuilderpublic int getHmin()
Minimum 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 uint32 hmin = 6;getHmin in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 banner object should be unique.
optional string id = 7;hasId in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 banner object should be unique.
optional string id = 7;getId in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 banner object should be unique.
optional string id = 7;getIdBytes in interface OpenRtbProtobuf.BannerOrBuilderpublic boolean hasPos()
Ad Position. Use Table 6.5
optional uint32 pos = 8;hasPos in interface OpenRtbProtobuf.BannerOrBuilderpublic int getPos()
Ad Position. Use Table 6.5
optional uint32 pos = 8;getPos in interface OpenRtbProtobuf.BannerOrBuilderpublic List<Integer> getBtypeList()
Blocked creative types. See Table 6.2 Banner Ad Types. If blank, assume all types are allowed.
repeated uint32 btype = 9 [packed = true];getBtypeList in interface OpenRtbProtobuf.BannerOrBuilderpublic int getBtypeCount()
Blocked creative types. See Table 6.2 Banner Ad Types. If blank, assume all types are allowed.
repeated uint32 btype = 9 [packed = true];getBtypeCount in interface OpenRtbProtobuf.BannerOrBuilderpublic int getBtype(int index)
Blocked creative types. See Table 6.2 Banner Ad Types. If blank, assume all types are allowed.
repeated uint32 btype = 9 [packed = true];getBtype in interface OpenRtbProtobuf.BannerOrBuilderpublic List<Integer> getBattrList()
Blocked creative attributes. See Table 6.3 Creative Attributes. If blank assume all types are allowed.
repeated uint32 battr = 10 [packed = true];getBattrList in interface OpenRtbProtobuf.BannerOrBuilderpublic int getBattrCount()
Blocked creative attributes. See Table 6.3 Creative Attributes. If blank assume all types are allowed.
repeated uint32 battr = 10 [packed = true];getBattrCount in interface OpenRtbProtobuf.BannerOrBuilderpublic int getBattr(int index)
Blocked creative attributes. See Table 6.3 Creative Attributes. If blank assume all types are allowed.
repeated uint32 battr = 10 [packed = true];getBattr in interface OpenRtbProtobuf.BannerOrBuilderpublic com.google.protobuf.ProtocolStringList 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 = 11;getMimesList in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 = 11;getMimesCount in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 = 11;getMimes in interface OpenRtbProtobuf.BannerOrBuilderpublic 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 = 11;getMimesBytes in interface OpenRtbProtobuf.BannerOrBuilderpublic boolean hasTopframe()
Specify if the banner is delivered in the top frame or in an iframe. “0” means it is not in the top frame, and “1” means that it is.
optional uint32 topframe = 12;hasTopframe in interface OpenRtbProtobuf.BannerOrBuilderpublic int getTopframe()
Specify if the banner is delivered in the top frame or in an iframe. “0” means it is not in the top frame, and “1” means that it is.
optional uint32 topframe = 12;getTopframe in interface OpenRtbProtobuf.BannerOrBuilderpublic List<Integer> getExpdirList()
Specify properties for an expandable ad. See Table 6.11 Expandable Direction for possible values.
repeated uint32 expdir = 13 [packed = true];getExpdirList in interface OpenRtbProtobuf.BannerOrBuilderpublic int getExpdirCount()
Specify properties for an expandable ad. See Table 6.11 Expandable Direction for possible values.
repeated uint32 expdir = 13 [packed = true];getExpdirCount in interface OpenRtbProtobuf.BannerOrBuilderpublic int getExpdir(int index)
Specify properties for an expandable ad. See Table 6.11 Expandable Direction for possible values.
repeated uint32 expdir = 13 [packed = true];getExpdir in interface OpenRtbProtobuf.BannerOrBuilderpublic List<Integer> getApiList()
List of supported API frameworks for this banner. (See Table 6.4 API Frameworks). If an API is not explicitly listed it is assumed not to be supported.
repeated uint32 api = 14 [packed = true];getApiList in interface OpenRtbProtobuf.BannerOrBuilderpublic int getApiCount()
List of supported API frameworks for this banner. (See Table 6.4 API Frameworks). If an API is not explicitly listed it is assumed not to be supported.
repeated uint32 api = 14 [packed = true];getApiCount in interface OpenRtbProtobuf.BannerOrBuilderpublic int getApi(int index)
List of supported API frameworks for this banner. (See Table 6.4 API Frameworks). If an API is not explicitly listed it is assumed not to be supported.
repeated uint32 api = 14 [packed = true];getApi in interface OpenRtbProtobuf.BannerOrBuilderpublic 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.Banner parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Banner parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Banner parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Banner parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Banner parseFrom(InputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Banner parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Banner parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Banner parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Banner parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Banner parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic OpenRtbProtobuf.Banner.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static OpenRtbProtobuf.Banner.Builder newBuilder()
public static OpenRtbProtobuf.Banner.Builder newBuilder(OpenRtbProtobuf.Banner prototype)
public OpenRtbProtobuf.Banner.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLitepublic static OpenRtbProtobuf.Banner getDefaultInstance()
public static com.google.protobuf.Parser<OpenRtbProtobuf.Banner> parser()
public com.google.protobuf.Parser<OpenRtbProtobuf.Banner> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public OpenRtbProtobuf.Banner getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2013–2016 AdGear Technologies Inc.. All rights reserved.