com.beeswax.openrtb

Class Extension.VideoExtensions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.ExtendableMessage<Extension.VideoExtensions>

com.beeswax.openrtb.Extension.VideoExtensions

All Implemented Interfaces:

Extension.VideoExtensionsOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<Extension.VideoExtensions>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Extension

public static final class Extension.VideoExtensions
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<Extension.VideoExtensions>
implements Extension.VideoExtensionsOrBuilder

 Next available tag: 6
 

Protobuf type openrtb.VideoExtensions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extension.VideoExtensions.Builder Next available tag: 6
static class	Extension.VideoExtensions.PlacementType Protobuf enum openrtb.VideoExtensions.PlacementType

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableMessage

com.google.protobuf.GeneratedMessageV3.ExtendableMessage.ExtensionWriter

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.protobuf.Parser<Extension.VideoExtensions>	PARSER Deprecated.
static int	PLACEMENT_TYPE_FIELD_NUMBER
static int	PLAYER_SIZE_FIELD_NUMBER
static int	REQUIRED_ATTRS_FIELD_NUMBER
static int	REWARDED_FIELD_NUMBER
static int	SKIP_OFFSET_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Extension.VideoExtensions	getDefaultInstance()
Extension.VideoExtensions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Extension.VideoExtensions>	getParserForType()
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	getSerializedSize()
int	getSkipOffset() Number of seconds into the video ad when the skip button appears.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Extension.VideoExtensions.Builder	newBuilder()
static Extension.VideoExtensions.Builder	newBuilder(Extension.VideoExtensions prototype)
Extension.VideoExtensions.Builder	newBuilderForType()
protected Extension.VideoExtensions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Extension.VideoExtensions	parseDelimitedFrom(InputStream input)
static Extension.VideoExtensions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.VideoExtensions	parseFrom(byte[] data)
static Extension.VideoExtensions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.VideoExtensions	parseFrom(com.google.protobuf.ByteString data)
static Extension.VideoExtensions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.VideoExtensions	parseFrom(com.google.protobuf.CodedInputStream input)
static Extension.VideoExtensions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Extension.VideoExtensions	parseFrom(InputStream input)
static Extension.VideoExtensions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Extension.VideoExtensions>	parser()
Extension.VideoExtensions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableMessage

extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getDescriptorForType, getOneofFieldDescriptor, hasOneof, internalGetMapField, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PLAYER_SIZE_FIELD_NUMBER

public static final int PLAYER_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRED_ATTRS_FIELD_NUMBER

public static final int REQUIRED_ATTRS_FIELD_NUMBER

See Also:

Constant Field Values

PLACEMENT_TYPE_FIELD_NUMBER

public static final int PLACEMENT_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

SKIP_OFFSET_FIELD_NUMBER

public static final int SKIP_OFFSET_FIELD_NUMBER

See Also:

Constant Field Values

REWARDED_FIELD_NUMBER

public static final int REWARDED_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Extension.VideoExtensions> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasPlayerSize

public boolean hasPlayerSize()

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

optional string player_size = 1;

Specified by:

hasPlayerSize in interface Extension.VideoExtensionsOrBuilder

getPlayerSize

public String getPlayerSize()

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

optional string player_size = 1;

Specified by:

getPlayerSize in interface Extension.VideoExtensionsOrBuilder

getPlayerSizeBytes

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

Specified by:

getPlayerSizeBytes in interface Extension.VideoExtensionsOrBuilder

getRequiredAttrsList

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

Specified by:

getRequiredAttrsList in interface Extension.VideoExtensionsOrBuilder

getRequiredAttrsCount

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

Specified by:

getRequiredAttrsCount in interface Extension.VideoExtensionsOrBuilder

getRequiredAttrs

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

Specified by:

getRequiredAttrs in interface Extension.VideoExtensionsOrBuilder

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

hasSkipOffset

public 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];

Specified by:

hasSkipOffset in interface Extension.VideoExtensionsOrBuilder

getSkipOffset

public 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];

Specified by:

getSkipOffset in interface Extension.VideoExtensionsOrBuilder

hasRewarded

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

Specified by:

hasRewarded in interface Extension.VideoExtensionsOrBuilder

getRewarded

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

Specified by:

getRewarded in interface Extension.VideoExtensionsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.ExtendableMessage<Extension.VideoExtensions>

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Extension.VideoExtensions parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.VideoExtensions parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.VideoExtensions parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.VideoExtensions parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Extension.VideoExtensions parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static Extension.VideoExtensions parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Extension.VideoExtensions parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static Extension.VideoExtensions parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static Extension.VideoExtensions parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Extension.VideoExtensions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Extension.VideoExtensions.Builder newBuilder()

newBuilder

public static Extension.VideoExtensions.Builder newBuilder(Extension.VideoExtensions prototype)

toBuilder

public Extension.VideoExtensions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Extension.VideoExtensions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Extension.VideoExtensions getDefaultInstance()

parser

public static com.google.protobuf.Parser<Extension.VideoExtensions> parser()

getParserForType

public com.google.protobuf.Parser<Extension.VideoExtensions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Extension.VideoExtensions getDefaultInstanceForType()

Specified by:

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder