Class VideoPosition (0.27.0)

public final class VideoPosition extends GeneratedMessageV3 implements VideoPositionOrBuilder

Video Position Targeting Criterion

Protobuf type google.ads.admanager.v1.VideoPosition

Static Fields

BUMPER_TYPE_FIELD_NUMBER

public static final int BUMPER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

MIDROLL_INDEX_FIELD_NUMBER

public static final int MIDROLL_INDEX_FIELD_NUMBER
Field Value
Type Description
int

POD_POSITION_FIELD_NUMBER

public static final int POD_POSITION_FIELD_NUMBER
Field Value
Type Description
int

POSITION_TYPE_FIELD_NUMBER

public static final int POSITION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

REVERSE_MIDROLL_INDEX_FIELD_NUMBER

public static final int REVERSE_MIDROLL_INDEX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VideoPosition getDefaultInstance()
Returns
Type Description
VideoPosition

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static VideoPosition.Builder newBuilder()
Returns
Type Description
VideoPosition.Builder

newBuilder(VideoPosition prototype)

public static VideoPosition.Builder newBuilder(VideoPosition prototype)
Parameter
Name Description
prototype VideoPosition
Returns
Type Description
VideoPosition.Builder

parseDelimitedFrom(InputStream input)

public static VideoPosition parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VideoPosition
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoPosition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoPosition
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VideoPosition parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VideoPosition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VideoPosition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoPosition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VideoPosition parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VideoPosition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VideoPosition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoPosition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VideoPosition parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VideoPosition
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoPosition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoPosition
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VideoPosition parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VideoPosition
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoPosition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoPosition
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VideoPosition parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VideoPosition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VideoPosition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoPosition
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VideoPosition> parser()
Returns
Type Description
Parser<VideoPosition>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBumperType()

public TargetedVideoBumperTypeEnum.TargetedVideoBumperType getBumperType()

Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. position_type), pod position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id).

optional .google.ads.admanager.v1.TargetedVideoBumperTypeEnum.TargetedVideoBumperType bumper_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TargetedVideoBumperTypeEnum.TargetedVideoBumperType

The bumperType.

getBumperTypeValue()

public int getBumperTypeValue()

Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. position_type), pod position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id).

optional .google.ads.admanager.v1.TargetedVideoBumperTypeEnum.TargetedVideoBumperType bumper_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for bumperType.

getDefaultInstanceForType()

public VideoPosition getDefaultInstanceForType()
Returns
Type Description
VideoPosition

getMidrollIndex()

public long getMidrollIndex()

Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL.

optional int64 midroll_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The midrollIndex.

getParserForType()

public Parser<VideoPosition> getParserForType()
Returns
Type Description
Parser<VideoPosition>
Overrides

getPodPosition()

public long getPodPosition()

Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. position_type), bumper type (e.g. bumper_type), or custom ad spot (e.g. custom_spot_id).

optional int64 pod_position = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The podPosition.

getPositionType()

public VideoPositionEnum.VideoPosition getPositionType()

Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.

optional .google.ads.admanager.v1.VideoPositionEnum.VideoPosition position_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoPositionEnum.VideoPosition

The positionType.

getPositionTypeValue()

public int getPositionTypeValue()

Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.

optional .google.ads.admanager.v1.VideoPositionEnum.VideoPosition position_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for positionType.

getReverseMidrollIndex()

public long getReverseMidrollIndex()

Optional. The index from the back of the pod of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL or if targeting a specific midroll index (e.g. midroll_index != 0).

optional int64 reverse_midroll_index = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The reverseMidrollIndex.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasBumperType()

public boolean hasBumperType()

Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. position_type), pod position (e.g. pod_position), or custom ad spot (e.g. custom_spot_id).

optional .google.ads.admanager.v1.TargetedVideoBumperTypeEnum.TargetedVideoBumperType bumper_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bumperType field is set.

hasMidrollIndex()

public boolean hasMidrollIndex()

Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL.

optional int64 midroll_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the midrollIndex field is set.

hasPodPosition()

public boolean hasPodPosition()

Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. position_type), bumper type (e.g. bumper_type), or custom ad spot (e.g. custom_spot_id).

optional int64 pod_position = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the podPosition field is set.

hasPositionType()

public boolean hasPositionType()

Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.

optional .google.ads.admanager.v1.VideoPositionEnum.VideoPosition position_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the positionType field is set.

hasReverseMidrollIndex()

public boolean hasReverseMidrollIndex()

Optional. The index from the back of the pod of the mid-roll to target. This field is ignored when targeting any video position (e.g. position_type) other than MIDROLL or if targeting a specific midroll index (e.g. midroll_index != 0).

optional int64 reverse_midroll_index = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the reverseMidrollIndex field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VideoPosition.Builder newBuilderForType()
Returns
Type Description
VideoPosition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VideoPosition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VideoPosition.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public VideoPosition.Builder toBuilder()
Returns
Type Description
VideoPosition.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException