com.beeswax.openrtb

Interface Extension.VideoExtensionsOrBuilder

All Superinterfaces:

com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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() optional string player_size = 1;
com.google.protobuf.ByteString	getPlayerSizeBytes() optional string player_size = 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 = 5;
int	getSkipOffset() optional int32 skip_offset = 4 [default = 5];
boolean	hasPlacementType() optional .openrtb.VideoExtensions.PlacementType placement_type = 3 [default = IN_STREAM];
boolean	hasPlayerSize() optional string player_size = 1;
boolean	hasRewarded() optional bool rewarded = 5;
boolean	hasSkipOffset() optional int32 skip_offset = 4 [default = 5];

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

hasPlayerSize

boolean hasPlayerSize()

optional string player_size = 1;

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

getPlayerSize

String getPlayerSize()

optional string player_size = 1;

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

getPlayerSizeBytes

com.google.protobuf.ByteString getPlayerSizeBytes()

optional string player_size = 1;

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

getRequiredAttrsList

List<OpenrtbCommon.CreativeAttribute> getRequiredAttrsList()

repeated .openrtb.CreativeAttribute required_attrs = 2;

 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
 

getRequiredAttrsCount

int getRequiredAttrsCount()

repeated .openrtb.CreativeAttribute required_attrs = 2;

 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
 

getRequiredAttrs

OpenrtbCommon.CreativeAttribute getRequiredAttrs(int index)

repeated .openrtb.CreativeAttribute required_attrs = 2;

 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
 

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()

optional int32 skip_offset = 4 [default = 5];

 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.
 

getSkipOffset

int getSkipOffset()

optional int32 skip_offset = 4 [default = 5];

 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.
 

hasRewarded

boolean hasRewarded()

optional bool rewarded = 5;

 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.
 

getRewarded

boolean getRewarded()

optional bool rewarded = 5;

 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.