com.beeswax.openrtb

Interface Extension.BannerExtensionsOrBuilder

All Superinterfaces:

com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<Extension.BannerExtensions>, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Extension.BannerExtensions, Extension.BannerExtensions.Builder

Enclosing class:

Extension

public static interface Extension.BannerExtensionsOrBuilder
extends com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<Extension.BannerExtensions>

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;
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;
boolean	hasRewarded() optional bool rewarded = 4;

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

getDefaultInstanceForType, 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, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getBapisList

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

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

 Blocked ApiFrameworks
 

getBapisCount

int getBapisCount()

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

 Blocked ApiFrameworks
 

getBapis

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

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

 Blocked ApiFrameworks
 

getRequiredAttrsList

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
 

getRequiredAttrsCount

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
 

getRequiredAttrs

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
 

getAdditionalDimensionsList

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.
 

getAdditionalDimensions

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.
 

getAdditionalDimensionsCount

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.
 

getAdditionalDimensionsOrBuilderList

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.
 

getAdditionalDimensionsOrBuilder

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.
 

hasRewarded

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.
 

getRewarded

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.