com.beeswax.openrtb

Class Extension.BannerExtensions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableMessage<Extension.BannerExtensions>

com.beeswax.openrtb.Extension.BannerExtensions

All Implemented Interfaces:

Extension.BannerExtensionsOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<Extension.BannerExtensions>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Extension

public static final class Extension.BannerExtensions
extends com.google.protobuf.GeneratedMessage.ExtendableMessage<Extension.BannerExtensions>
implements Extension.BannerExtensionsOrBuilder

Protobuf type openrtb.BannerExtensions

 Next available tag: 5
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extension.BannerExtensions.Builder Protobuf type openrtb.BannerExtensions

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDITIONAL_DIMENSIONS_FIELD_NUMBER
static int	BAPIS_FIELD_NUMBER
static com.google.protobuf.Parser<Extension.BannerExtensions>	PARSER Deprecated.
static int	REQUIRED_ATTRS_FIELD_NUMBER
static int	REWARDED_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
Extension.Dimension	getAdditionalDimensions(int index) repeated .openrtb.Dimension additional_dimensions = 3;
int	getAdditionalDimensionsCount() repeated .openrtb.Dimension additional_dimensions = 3;
List<Extension.Dimension>	getAdditionalDimensionsList() repeated .openrtb.Dimension additional_dimensions = 3;
Extension.DimensionOrBuilder	getAdditionalDimensionsOrBuilder(int index) repeated .openrtb.Dimension additional_dimensions = 3;
List<? extends Extension.DimensionOrBuilder>	getAdditionalDimensionsOrBuilderList() repeated .openrtb.Dimension additional_dimensions = 3;
OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework	getBapis(int index) repeated .openrtb.Enums.BidRequest.Impression.ApiFramework bapis = 1;
int	getBapisCount() repeated .openrtb.Enums.BidRequest.Impression.ApiFramework bapis = 1;
List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework>	getBapisList() repeated .openrtb.Enums.BidRequest.Impression.ApiFramework bapis = 1;
static Extension.BannerExtensions	getDefaultInstance()
Extension.BannerExtensions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Extension.BannerExtensions>	getParserForType()
OpenrtbCommon.CreativeAttribute	getRequiredAttrs(int index) repeated .openrtb.CreativeAttribute required_attrs = 2;
int	getRequiredAttrsCount() repeated .openrtb.CreativeAttribute required_attrs = 2;
List<OpenrtbCommon.CreativeAttribute>	getRequiredAttrsList() repeated .openrtb.CreativeAttribute required_attrs = 2;
boolean	getRewarded() optional bool rewarded = 4;
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasRewarded() optional bool rewarded = 4;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Extension.BannerExtensions.Builder	newBuilder()
static Extension.BannerExtensions.Builder	newBuilder(Extension.BannerExtensions prototype)
Extension.BannerExtensions.Builder	newBuilderForType()
protected Extension.BannerExtensions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static Extension.BannerExtensions	parseDelimitedFrom(InputStream input)
static Extension.BannerExtensions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.BannerExtensions	parseFrom(byte[] data)
static Extension.BannerExtensions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.BannerExtensions	parseFrom(com.google.protobuf.ByteString data)
static Extension.BannerExtensions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.BannerExtensions	parseFrom(com.google.protobuf.CodedInputStream input)
static Extension.BannerExtensions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.BannerExtensions	parseFrom(InputStream input)
static Extension.BannerExtensions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Extension.BannerExtensions>	parser()
Extension.BannerExtensions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField

Methods inherited from class com.google.protobuf.GeneratedMessage

computeStringSize, computeStringSizeNoTag, getDescriptorForType, getOneofFieldDescriptor, hasOneof, internalGetMapField, newBuilderForType, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

BAPIS_FIELD_NUMBER

public static final int BAPIS_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRED_ATTRS_FIELD_NUMBER

public static final int REQUIRED_ATTRS_FIELD_NUMBER

See Also:

Constant Field Values

ADDITIONAL_DIMENSIONS_FIELD_NUMBER

public static final int ADDITIONAL_DIMENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

REWARDED_FIELD_NUMBER

public static final int REWARDED_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Extension.BannerExtensions> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getBapisList

public List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> getBapisList()

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework bapis = 1;

 Blocked ApiFrameworks
 

Specified by:

getBapisList in interface Extension.BannerExtensionsOrBuilder

getBapisCount

public int getBapisCount()

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework bapis = 1;

 Blocked ApiFrameworks
 

Specified by:

getBapisCount in interface Extension.BannerExtensionsOrBuilder

getBapis

public OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework getBapis(int index)

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework bapis = 1;

 Blocked ApiFrameworks
 

Specified by:

getBapis in interface Extension.BannerExtensionsOrBuilder

getRequiredAttrsList

public List<OpenrtbCommon.CreativeAttribute> getRequiredAttrsList()

repeated .openrtb.CreativeAttribute required_attrs = 2;

 Creative attributes that are required by the request.
 For e.g. MoPub request have "AD_HAS_THUMBNAIL" for the creative
          to be returned in the response
 

Specified by:

getRequiredAttrsList in interface Extension.BannerExtensionsOrBuilder

getRequiredAttrsCount

public int getRequiredAttrsCount()

repeated .openrtb.CreativeAttribute required_attrs = 2;

 Creative attributes that are required by the request.
 For e.g. MoPub request have "AD_HAS_THUMBNAIL" for the creative
          to be returned in the response
 

Specified by:

getRequiredAttrsCount in interface Extension.BannerExtensionsOrBuilder

getRequiredAttrs

public OpenrtbCommon.CreativeAttribute getRequiredAttrs(int index)

repeated .openrtb.CreativeAttribute required_attrs = 2;

 Creative attributes that are required by the request.
 For e.g. MoPub request have "AD_HAS_THUMBNAIL" for the creative
          to be returned in the response
 

Specified by:

getRequiredAttrs in interface Extension.BannerExtensionsOrBuilder

getAdditionalDimensionsList

public List<Extension.Dimension> getAdditionalDimensionsList()

repeated .openrtb.Dimension additional_dimensions = 3;

 Some exchanges such as Google Adx support multiple allowed sizes for
 an impression.
 In such cases, the additional dimensions (w, h) that are supported
 are present in this field.
 For example, if Adx supports 5 sets of allowed sizes in a request.
 The first allowed size will be in banner.w and banner.h
 The additional 4 sets will be in this field.
 

Specified by:

getAdditionalDimensionsList in interface Extension.BannerExtensionsOrBuilder

getAdditionalDimensionsOrBuilderList

public List<? extends Extension.DimensionOrBuilder> getAdditionalDimensionsOrBuilderList()

repeated .openrtb.Dimension additional_dimensions = 3;

 Some exchanges such as Google Adx support multiple allowed sizes for
 an impression.
 In such cases, the additional dimensions (w, h) that are supported
 are present in this field.
 For example, if Adx supports 5 sets of allowed sizes in a request.
 The first allowed size will be in banner.w and banner.h
 The additional 4 sets will be in this field.
 

Specified by:

getAdditionalDimensionsOrBuilderList in interface Extension.BannerExtensionsOrBuilder

getAdditionalDimensionsCount

public int getAdditionalDimensionsCount()

repeated .openrtb.Dimension additional_dimensions = 3;

 Some exchanges such as Google Adx support multiple allowed sizes for
 an impression.
 In such cases, the additional dimensions (w, h) that are supported
 are present in this field.
 For example, if Adx supports 5 sets of allowed sizes in a request.
 The first allowed size will be in banner.w and banner.h
 The additional 4 sets will be in this field.
 

Specified by:

getAdditionalDimensionsCount in interface Extension.BannerExtensionsOrBuilder

getAdditionalDimensions

public Extension.Dimension getAdditionalDimensions(int index)

repeated .openrtb.Dimension additional_dimensions = 3;

 Some exchanges such as Google Adx support multiple allowed sizes for
 an impression.
 In such cases, the additional dimensions (w, h) that are supported
 are present in this field.
 For example, if Adx supports 5 sets of allowed sizes in a request.
 The first allowed size will be in banner.w and banner.h
 The additional 4 sets will be in this field.
 

Specified by:

getAdditionalDimensions in interface Extension.BannerExtensionsOrBuilder

getAdditionalDimensionsOrBuilder

public Extension.DimensionOrBuilder getAdditionalDimensionsOrBuilder(int index)

repeated .openrtb.Dimension additional_dimensions = 3;

 Some exchanges such as Google Adx support multiple allowed sizes for
 an impression.
 In such cases, the additional dimensions (w, h) that are supported
 are present in this field.
 For example, if Adx supports 5 sets of allowed sizes in a request.
 The first allowed size will be in banner.w and banner.h
 The additional 4 sets will be in this field.
 

Specified by:

getAdditionalDimensionsOrBuilder in interface Extension.BannerExtensionsOrBuilder

hasRewarded

public boolean hasRewarded()

optional bool rewarded = 4;

 Some exchanges support "rewarded banners". This signifies that an end user
 will recieve a reward for interacting with the ad. E.g. if the user plays
 a game in a playable banner, they get game currency in a phone game.
 Two things to note:
   1. Protobufs sets bools false by default. Unless this field exists and
      is explicitly set to true, a banner is considered "nonrewarded".
   2. No exchange actually defines this field here, it is a generalization
      of the different ways that exchanges denote rewarded banners.
 

Specified by:

hasRewarded in interface Extension.BannerExtensionsOrBuilder

getRewarded

public boolean getRewarded()

optional bool rewarded = 4;

 Some exchanges support "rewarded banners". This signifies that an end user
 will recieve a reward for interacting with the ad. E.g. if the user plays
 a game in a playable banner, they get game currency in a phone game.
 Two things to note:
   1. Protobufs sets bools false by default. Unless this field exists and
      is explicitly set to true, a banner is considered "nonrewarded".
   2. No exchange actually defines this field here, it is a generalization
      of the different ways that exchanges denote rewarded banners.
 

Specified by:

getRewarded in interface Extension.BannerExtensionsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<Extension.BannerExtensions>

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

parseFrom

public static Extension.BannerExtensions parseFrom(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.BannerExtensions parseFrom(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.BannerExtensions parseFrom(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.BannerExtensions parseFrom(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.BannerExtensions parseFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static Extension.BannerExtensions parseFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Extension.BannerExtensions parseDelimitedFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Extension.BannerExtensions parseDelimitedFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseFrom

public static Extension.BannerExtensions parseFrom(com.google.protobuf.CodedInputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static Extension.BannerExtensions parseFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

newBuilderForType

public Extension.BannerExtensions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Extension.BannerExtensions.Builder newBuilder()

newBuilder

public static Extension.BannerExtensions.Builder newBuilder(Extension.BannerExtensions prototype)

toBuilder

public Extension.BannerExtensions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Extension.BannerExtensions.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage

getDefaultInstance

public static Extension.BannerExtensions getDefaultInstance()

parser

public static com.google.protobuf.Parser<Extension.BannerExtensions> parser()

getParserForType

public com.google.protobuf.Parser<Extension.BannerExtensions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Extension.BannerExtensions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<Extension.BannerExtensions>

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder