com.beeswax.openrtb

Interface Extension.VideoExtensionsOrBuilder

All Superinterfaces:

com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<Extension.VideoExtensions>, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Extension.VideoExtensions, Extension.VideoExtensions.Builder

Enclosing class:

Extension

public static interface Extension.VideoExtensionsOrBuilder
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<Extension.VideoExtensions>

Method Summary

Modifier and Type	Method and Description
Extension.VideoExtensions.PlacementType	getPlacementType() optional .openrtb.VideoExtensions.PlacementType placement_type = 3 [default = IN_STREAM];
String	getPlayerSize() player_size can be one of ["S", "M"., "L", "XL", "NA"].
com.google.protobuf.ByteString	getPlayerSizeBytes() player_size can be one of ["S", "M"., "L", "XL", "NA"].
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 videos".
int	getSkipOffset() Number of seconds into the video ad when the skip button appears.
boolean	hasPlacementType() optional .openrtb.VideoExtensions.PlacementType placement_type = 3 [default = IN_STREAM];
boolean	hasPlayerSize() player_size can be one of ["S", "M"., "L", "XL", "NA"].
boolean	hasRewarded() Some exchanges support "rewarded videos".
boolean	hasSkipOffset() Number of seconds into the video ad when the skip button appears.

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

hasPlayerSize

boolean hasPlayerSize()

 player_size can be one of ["S", "M"., "L", "XL", "NA"].
 Computed by the LocalAugmentor in Stinger.
 

optional string player_size = 1;

getPlayerSize

String getPlayerSize()

 player_size can be one of ["S", "M"., "L", "XL", "NA"].
 Computed by the LocalAugmentor in Stinger.
 

optional string player_size = 1;

getPlayerSizeBytes

com.google.protobuf.ByteString getPlayerSizeBytes()

 player_size can be one of ["S", "M"., "L", "XL", "NA"].
 Computed by the LocalAugmentor in Stinger.
 

optional string player_size = 1;

getRequiredAttrsList

List<OpenrtbCommon.CreativeAttribute> getRequiredAttrsList()

 Creative attributes that are required by the request.
 For e.g. Adx requests that require skippable ads are modeled
 as having required_attr = AD_CAN_BE_SKIPPED
 

repeated .openrtb.CreativeAttribute required_attrs = 2;

getRequiredAttrsCount

int getRequiredAttrsCount()

 Creative attributes that are required by the request.
 For e.g. Adx requests that require skippable ads are modeled
 as having required_attr = AD_CAN_BE_SKIPPED
 

repeated .openrtb.CreativeAttribute required_attrs = 2;

getRequiredAttrs

OpenrtbCommon.CreativeAttribute getRequiredAttrs(int index)

 Creative attributes that are required by the request.
 For e.g. Adx requests that require skippable ads are modeled
 as having required_attr = AD_CAN_BE_SKIPPED
 

repeated .openrtb.CreativeAttribute required_attrs = 2;

hasPlacementType

boolean hasPlacementType()

optional .openrtb.VideoExtensions.PlacementType placement_type = 3 [default = IN_STREAM];

getPlacementType

Extension.VideoExtensions.PlacementType getPlacementType()

optional .openrtb.VideoExtensions.PlacementType placement_type = 3 [default = IN_STREAM];

hasSkipOffset

boolean hasSkipOffset()

 Number of seconds into the video ad when the skip button appears.
 This is only applicable to skippable video ads.
 Some inventory sources such as Google Ad Exchange do not specify
 this skip offset explicity in the bid request.
 For such sources, skip_offset of 5 seconds is a safe default.
 

optional int32 skip_offset = 4 [default = 5];

getSkipOffset

int getSkipOffset()

 Number of seconds into the video ad when the skip button appears.
 This is only applicable to skippable video ads.
 Some inventory sources such as Google Ad Exchange do not specify
 this skip offset explicity in the bid request.
 For such sources, skip_offset of 5 seconds is a safe default.
 

optional int32 skip_offset = 4 [default = 5];

hasRewarded

boolean hasRewarded()

 Some exchanges support "rewarded videos". This signifies that an end user
 will recieve a reward for interacting with the ad. E.g. if the user watches
 the whole video, 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 video is considered "nonrewarded".
   2. No exchange actually defines this field here, it is a generalization
      of the different ways that exchanges denote rewarded videos.
 

optional bool rewarded = 5;

getRewarded

boolean getRewarded()

 Some exchanges support "rewarded videos". This signifies that an end user
 will recieve a reward for interacting with the ad. E.g. if the user watches
 the whole video, 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 video is considered "nonrewarded".
   2. No exchange actually defines this field here, it is a generalization
      of the different ways that exchanges denote rewarded videos.
 

optional bool rewarded = 5;