com.beeswax.openrtb

Interface Extension.BannerExtensionsOrBuilder

All Superinterfaces:

com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.ExtendableMessageOrBuilder<Extension.BannerExtensions>

Method Summary

Modifier and Type	Method and Description
Extension.Dimension	getAdditionalDimensions(int index) Some exchanges such as Google Adx support multiple allowed sizes for an impression.
int	getAdditionalDimensionsCount() Some exchanges such as Google Adx support multiple allowed sizes for an impression.
List<Extension.Dimension>	getAdditionalDimensionsList() Some exchanges such as Google Adx support multiple allowed sizes for an impression.
Extension.DimensionOrBuilder	getAdditionalDimensionsOrBuilder(int index) Some exchanges such as Google Adx support multiple allowed sizes for an impression.
List<? extends Extension.DimensionOrBuilder>	getAdditionalDimensionsOrBuilderList() Some exchanges such as Google Adx support multiple allowed sizes for an impression.
OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework	getBapis(int index) Blocked ApiFrameworks
int	getBapisCount() Blocked ApiFrameworks
List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework>	getBapisList() Blocked ApiFrameworks
OpenrtbCommon.CreativeAttribute	getRequiredAttrs(int index) Creative attributes that are required by the request.
int	getRequiredAttrsCount() Creative attributes that are required by the request.
List<OpenrtbCommon.CreativeAttribute>	getRequiredAttrsList() Creative attributes that are required by the request.
boolean	getRewarded() Some exchanges support "rewarded banners".
boolean	hasRewarded() Some exchanges support "rewarded banners".

Methods inherited from interface com.google.protobuf.GeneratedMessageV3.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()

 Blocked ApiFrameworks
 

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

getBapisCount

int getBapisCount()

 Blocked ApiFrameworks
 

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

getBapis

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

 Blocked ApiFrameworks
 

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

getRequiredAttrsList

List<OpenrtbCommon.CreativeAttribute> getRequiredAttrsList()

 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
 

repeated .openrtb.CreativeAttribute required_attrs = 2;

getRequiredAttrsCount

int getRequiredAttrsCount()

 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
 

repeated .openrtb.CreativeAttribute required_attrs = 2;

getRequiredAttrs

OpenrtbCommon.CreativeAttribute getRequiredAttrs(int index)

 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
 

repeated .openrtb.CreativeAttribute required_attrs = 2;

getAdditionalDimensionsList

List<Extension.Dimension> getAdditionalDimensionsList()

 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.
 

repeated .openrtb.Dimension additional_dimensions = 3;

getAdditionalDimensions

Extension.Dimension getAdditionalDimensions(int index)

 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.
 

repeated .openrtb.Dimension additional_dimensions = 3;

getAdditionalDimensionsCount

int getAdditionalDimensionsCount()

 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.
 

repeated .openrtb.Dimension additional_dimensions = 3;

getAdditionalDimensionsOrBuilderList

List<? extends Extension.DimensionOrBuilder> getAdditionalDimensionsOrBuilderList()

 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.
 

repeated .openrtb.Dimension additional_dimensions = 3;

getAdditionalDimensionsOrBuilder

Extension.DimensionOrBuilder getAdditionalDimensionsOrBuilder(int index)

 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.
 

repeated .openrtb.Dimension additional_dimensions = 3;

hasRewarded

boolean hasRewarded()

 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.
 

optional bool rewarded = 4;

getRewarded

boolean getRewarded()

 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.
 

optional bool rewarded = 4;