com.beeswax.openrtb

Class Extension.VideoExtensions.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.ExtendableBuilder<Extension.VideoExtensions,Extension.VideoExtensions.Builder>

com.beeswax.openrtb.Extension.VideoExtensions.Builder

All Implemented Interfaces:

Extension.VideoExtensionsOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<Extension.VideoExtensions>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Extension.VideoExtensions

public static final class Extension.VideoExtensions.Builder
extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<Extension.VideoExtensions,Extension.VideoExtensions.Builder>
implements Extension.VideoExtensionsOrBuilder

Protobuf type openrtb.VideoExtensions

 Next available tag: 6
 

Method Summary

Modifier and Type	Method and Description
Extension.VideoExtensions.Builder	addAllRequiredAttrs(Iterable<? extends OpenrtbCommon.CreativeAttribute> values) repeated .openrtb.CreativeAttribute required_attrs = 2;
Extension.VideoExtensions.Builder	addRequiredAttrs(OpenrtbCommon.CreativeAttribute value) repeated .openrtb.CreativeAttribute required_attrs = 2;
Extension.VideoExtensions	build()
Extension.VideoExtensions	buildPartial()
Extension.VideoExtensions.Builder	clear()
Extension.VideoExtensions.Builder	clearPlacementType() optional .openrtb.VideoExtensions.PlacementType placement_type = 3 [default = IN_STREAM];
Extension.VideoExtensions.Builder	clearPlayerSize() optional string player_size = 1;
Extension.VideoExtensions.Builder	clearRequiredAttrs() repeated .openrtb.CreativeAttribute required_attrs = 2;
Extension.VideoExtensions.Builder	clearRewarded() optional bool rewarded = 5;
Extension.VideoExtensions.Builder	clearSkipOffset() optional int32 skip_offset = 4 [default = 5];
Extension.VideoExtensions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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];
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Extension.VideoExtensions.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Extension.VideoExtensions.Builder	mergeFrom(Extension.VideoExtensions other)
Extension.VideoExtensions.Builder	mergeFrom(com.google.protobuf.Message other)
Extension.VideoExtensions.Builder	setPlacementType(Extension.VideoExtensions.PlacementType value) optional .openrtb.VideoExtensions.PlacementType placement_type = 3 [default = IN_STREAM];
Extension.VideoExtensions.Builder	setPlayerSize(String value) optional string player_size = 1;
Extension.VideoExtensions.Builder	setPlayerSizeBytes(com.google.protobuf.ByteString value) optional string player_size = 1;
Extension.VideoExtensions.Builder	setRequiredAttrs(int index, OpenrtbCommon.CreativeAttribute value) repeated .openrtb.CreativeAttribute required_attrs = 2;
Extension.VideoExtensions.Builder	setRewarded(boolean value) optional bool rewarded = 5;
Extension.VideoExtensions.Builder	setSkipOffset(int value) optional int32 skip_offset = 4 [default = 5];

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

addExtension, addExtension, addExtension, addRepeatedField, clearExtension, clearExtension, clearExtension, clearField, clone, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, mergeExtensionFields, parseUnknownField, setExtension, setExtension, setExtension, setExtension, setExtension, setExtension, setField, setRepeatedField

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

clearOneof, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedFieldBuilder, getUnknownFields, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, setUnknownFields

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Extension.VideoExtensions.Builder>

clear

public Extension.VideoExtensions.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.ExtendableBuilder<Extension.VideoExtensions,Extension.VideoExtensions.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Extension.VideoExtensions.Builder>

getDefaultInstanceForType

public Extension.VideoExtensions getDefaultInstanceForType()

Specified by:

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Extension.VideoExtensions build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Extension.VideoExtensions buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Extension.VideoExtensions.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Extension.VideoExtensions.Builder>

mergeFrom

public Extension.VideoExtensions.Builder mergeFrom(Extension.VideoExtensions other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableBuilder<Extension.VideoExtensions,Extension.VideoExtensions.Builder>

mergeFrom

public Extension.VideoExtensions.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Extension.VideoExtensions.Builder>

Throws:

IOException

hasPlayerSize

public boolean hasPlayerSize()

optional string player_size = 1;

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

Specified by:

hasPlayerSize in interface Extension.VideoExtensionsOrBuilder

getPlayerSize

public String getPlayerSize()

optional string player_size = 1;

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

Specified by:

getPlayerSize in interface Extension.VideoExtensionsOrBuilder

getPlayerSizeBytes

public 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.
 

Specified by:

getPlayerSizeBytes in interface Extension.VideoExtensionsOrBuilder

setPlayerSize

public Extension.VideoExtensions.Builder setPlayerSize(String value)

optional string player_size = 1;

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

clearPlayerSize

public Extension.VideoExtensions.Builder clearPlayerSize()

optional string player_size = 1;

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

setPlayerSizeBytes

public Extension.VideoExtensions.Builder setPlayerSizeBytes(com.google.protobuf.ByteString value)

optional string player_size = 1;

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

getRequiredAttrsList

public 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
 

Specified by:

getRequiredAttrsList in interface Extension.VideoExtensionsOrBuilder

getRequiredAttrsCount

public 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
 

Specified by:

getRequiredAttrsCount in interface Extension.VideoExtensionsOrBuilder

getRequiredAttrs

public 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
 

Specified by:

getRequiredAttrs in interface Extension.VideoExtensionsOrBuilder

setRequiredAttrs

public Extension.VideoExtensions.Builder setRequiredAttrs(int index,
                                                          OpenrtbCommon.CreativeAttribute value)

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
 

addRequiredAttrs

public Extension.VideoExtensions.Builder addRequiredAttrs(OpenrtbCommon.CreativeAttribute value)

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
 

addAllRequiredAttrs

public Extension.VideoExtensions.Builder addAllRequiredAttrs(Iterable<? extends OpenrtbCommon.CreativeAttribute> values)

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
 

clearRequiredAttrs

public Extension.VideoExtensions.Builder clearRequiredAttrs()

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

public boolean hasPlacementType()

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

Specified by:

hasPlacementType in interface Extension.VideoExtensionsOrBuilder

getPlacementType

public Extension.VideoExtensions.PlacementType getPlacementType()

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

Specified by:

getPlacementType in interface Extension.VideoExtensionsOrBuilder

setPlacementType

public Extension.VideoExtensions.Builder setPlacementType(Extension.VideoExtensions.PlacementType value)

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

clearPlacementType

public Extension.VideoExtensions.Builder clearPlacementType()

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

hasSkipOffset

public 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.
 

Specified by:

hasSkipOffset in interface Extension.VideoExtensionsOrBuilder

getSkipOffset

public 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.
 

Specified by:

getSkipOffset in interface Extension.VideoExtensionsOrBuilder

setSkipOffset

public Extension.VideoExtensions.Builder setSkipOffset(int value)

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.
 

clearSkipOffset

public Extension.VideoExtensions.Builder clearSkipOffset()

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

public 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.
 

Specified by:

hasRewarded in interface Extension.VideoExtensionsOrBuilder

getRewarded

public 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.
 

Specified by:

getRewarded in interface Extension.VideoExtensionsOrBuilder

setRewarded

public Extension.VideoExtensions.Builder setRewarded(boolean value)

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.
 

clearRewarded

public Extension.VideoExtensions.Builder clearRewarded()

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.