public static final class VideoPosition.Builder extends GeneratedMessageV3.Builder<VideoPosition.Builder> implements VideoPositionOrBuilderVideo Position Targeting Criterion
Protobuf type google.ads.admanager.v1.VideoPosition
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > VideoPosition.BuilderImplements
VideoPositionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public VideoPosition.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
build()
public VideoPosition build()| Returns | |
|---|---|
| Type | Description |
VideoPosition |
|
buildPartial()
public VideoPosition buildPartial()| Returns | |
|---|---|
| Type | Description |
VideoPosition |
|
clear()
public VideoPosition.Builder clear()| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
clearBumperType()
public VideoPosition.Builder clearBumperType()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 |
VideoPosition.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public VideoPosition.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
clearMidrollIndex()
public VideoPosition.Builder clearMidrollIndex()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 |
VideoPosition.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public VideoPosition.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
clearPodPosition()
public VideoPosition.Builder clearPodPosition()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 |
VideoPosition.Builder |
This builder for chaining. |
clearPositionType()
public VideoPosition.Builder clearPositionType()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 |
VideoPosition.Builder |
This builder for chaining. |
clearReverseMidrollIndex()
public VideoPosition.Builder clearReverseMidrollIndex()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 |
VideoPosition.Builder |
This builder for chaining. |
clone()
public VideoPosition.Builder clone()| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(VideoPosition other)
public VideoPosition.Builder mergeFrom(VideoPosition other)| Parameter | |
|---|---|
| Name | Description |
other |
VideoPosition |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public VideoPosition.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public VideoPosition.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final VideoPosition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
setBumperType(TargetedVideoBumperTypeEnum.TargetedVideoBumperType value)
public VideoPosition.Builder setBumperType(TargetedVideoBumperTypeEnum.TargetedVideoBumperType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
TargetedVideoBumperTypeEnum.TargetedVideoBumperTypeThe bumperType to set. |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
This builder for chaining. |
setBumperTypeValue(int value)
public VideoPosition.Builder setBumperTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for bumperType to set. |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public VideoPosition.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
setMidrollIndex(long value)
public VideoPosition.Builder setMidrollIndex(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe midrollIndex to set. |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
This builder for chaining. |
setPodPosition(long value)
public VideoPosition.Builder setPodPosition(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe podPosition to set. |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
This builder for chaining. |
setPositionType(VideoPositionEnum.VideoPosition value)
public VideoPosition.Builder setPositionType(VideoPositionEnum.VideoPosition value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
VideoPositionEnum.VideoPositionThe positionType to set. |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
This builder for chaining. |
setPositionTypeValue(int value)
public VideoPosition.Builder setPositionTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for positionType to set. |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public VideoPosition.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|
setReverseMidrollIndex(long value)
public VideoPosition.Builder setReverseMidrollIndex(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe reverseMidrollIndex to set. |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final VideoPosition.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
VideoPosition.Builder |
|