public final class AdRuleSlot extends GeneratedMessage implements AdRuleSlotOrBuilder
Simple object representing an ad slot within an AdRule. Ad rule slots contain
information about the types/number of ads to display, as well as additional
information on how the ad server will generate playlists.
Protobuf type google.ads.admanager.v1.AdRuleSlot
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
BUMPER_FIELD_NUMBER
public static final int BUMPER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_BUMPER_DURATION_FIELD_NUMBER
public static final int MAX_BUMPER_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_POD_DURATION_FIELD_NUMBER
public static final int MAX_POD_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_VIDEO_AD_DURATION_FIELD_NUMBER
public static final int MAX_VIDEO_AD_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
POD_MAX_AD_COUNT_FIELD_NUMBER
public static final int POD_MAX_AD_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SLOT_BEHAVIOR_FIELD_NUMBER
public static final int SLOT_BEHAVIOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VIDEO_MIDROLL_FREQUENCY_FIELD_NUMBER
public static final int VIDEO_MIDROLL_FREQUENCY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VIDEO_MIDROLL_FREQUENCY_TYPE_FIELD_NUMBER
public static final int VIDEO_MIDROLL_FREQUENCY_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static AdRuleSlot getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AdRuleSlot.Builder newBuilder()
newBuilder(AdRuleSlot prototype)
public static AdRuleSlot.Builder newBuilder(AdRuleSlot prototype)
public static AdRuleSlot parseDelimitedFrom(InputStream input)
public static AdRuleSlot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AdRuleSlot parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AdRuleSlot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AdRuleSlot parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AdRuleSlot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AdRuleSlot parseFrom(CodedInputStream input)
public static AdRuleSlot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AdRuleSlot parseFrom(InputStream input)
public static AdRuleSlot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AdRuleSlot parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AdRuleSlot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AdRuleSlot> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBumper()
public AdRuleSlotBumperEnum.AdRuleSlotBumper getBumper()
Optional. The AdRuleSlotBumper for this slot. This attribute is optional
and defaults to [AdRuleSlotBumper.NONE][].
optional .google.ads.admanager.v1.AdRuleSlotBumperEnum.AdRuleSlotBumper bumper = 7 [(.google.api.field_behavior) = OPTIONAL];
getBumperValue()
public int getBumperValue()
Optional. The AdRuleSlotBumper for this slot. This attribute is optional
and defaults to [AdRuleSlotBumper.NONE][].
optional .google.ads.admanager.v1.AdRuleSlotBumperEnum.AdRuleSlotBumper bumper = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for bumper.
|
getDefaultInstanceForType()
public AdRuleSlot getDefaultInstanceForType()
getMaxBumperDuration()
public Duration getMaxBumperDuration()
Optional. The maximum duration of bumper ads within this slot. This
attribute is optional and defaults to 0.
optional .google.protobuf.Duration max_bumper_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Duration |
The maxBumperDuration.
|
getMaxBumperDurationOrBuilder()
public DurationOrBuilder getMaxBumperDurationOrBuilder()
Optional. The maximum duration of bumper ads within this slot. This
attribute is optional and defaults to 0.
optional .google.protobuf.Duration max_bumper_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
getMaxPodDuration()
public Duration getMaxPodDuration()
Optional. The maximum pod duration for this slot. This attribute is
optional and defaults to 0.
optional .google.protobuf.Duration max_pod_duration = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Duration |
The maxPodDuration.
|
getMaxPodDurationOrBuilder()
public DurationOrBuilder getMaxPodDurationOrBuilder()
Optional. The maximum pod duration for this slot. This attribute is
optional and defaults to 0.
optional .google.protobuf.Duration max_pod_duration = 9 [(.google.api.field_behavior) = OPTIONAL];
getMaxVideoAdDuration()
public Duration getMaxVideoAdDuration()
Optional. The maximum duration in milliseconds of video ads within this
slot. This attribute is optional and defaults to 0.
optional .google.protobuf.Duration max_video_ad_duration = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Duration |
The maxVideoAdDuration.
|
getMaxVideoAdDurationOrBuilder()
public DurationOrBuilder getMaxVideoAdDurationOrBuilder()
Optional. The maximum duration in milliseconds of video ads within this
slot. This attribute is optional and defaults to 0.
optional .google.protobuf.Duration max_video_ad_duration = 4 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<AdRuleSlot> getParserForType()
Overrides
getPodMaxAdCount()
public int getPodMaxAdCount()
Optional. The maximum number of ads allowed in a pod in this slot. This
attribute is optional and defaults to 0.
optional int32 pod_max_ad_count = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The podMaxAdCount.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSlotBehavior()
public AdRuleSlotBehaviorEnum.AdRuleSlotBehavior getSlotBehavior()
Optional. The AdRuleSlotBehavior for video ads for this slot. This
attribute is optional and defaults to [AdRuleSlotBehavior.DEFER][].
Indicates whether video ads are allowed for this slot, or if the decision
is deferred to alower-priority ad rule.
optional .google.ads.admanager.v1.AdRuleSlotBehaviorEnum.AdRuleSlotBehavior slot_behavior = 1 [(.google.api.field_behavior) = OPTIONAL];
getSlotBehaviorValue()
public int getSlotBehaviorValue()
Optional. The AdRuleSlotBehavior for video ads for this slot. This
attribute is optional and defaults to [AdRuleSlotBehavior.DEFER][].
Indicates whether video ads are allowed for this slot, or if the decision
is deferred to alower-priority ad rule.
optional .google.ads.admanager.v1.AdRuleSlotBehaviorEnum.AdRuleSlotBehavior slot_behavior = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for slotBehavior.
|
getVideoMidrollFrequency()
public String getVideoMidrollFrequency()
Optional. The mid-roll frequency of this ad rule slot for video ads. This
attribute is required for mid-rolls, but if MidrollFrequencyType is set to
[AdRuleSlotMidrollFrequencyType.NONE][], this value should be ignored. For
example, if this slot has a frequency type of
[AdRuleSlotMidrollFrequencyType.EVERY_N_SECONDS][] and
videoMidrollFrequency = "60", this would mean "play a mid-roll every 60
seconds."
optional string video_midroll_frequency = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The videoMidrollFrequency.
|
getVideoMidrollFrequencyBytes()
public ByteString getVideoMidrollFrequencyBytes()
Optional. The mid-roll frequency of this ad rule slot for video ads. This
attribute is required for mid-rolls, but if MidrollFrequencyType is set to
[AdRuleSlotMidrollFrequencyType.NONE][], this value should be ignored. For
example, if this slot has a frequency type of
[AdRuleSlotMidrollFrequencyType.EVERY_N_SECONDS][] and
videoMidrollFrequency = "60", this would mean "play a mid-roll every 60
seconds."
optional string video_midroll_frequency = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for videoMidrollFrequency.
|
getVideoMidrollFrequencyType()
public AdRuleSlotMidrollFrequencyTypeEnum.AdRuleSlotMidrollFrequencyType getVideoMidrollFrequencyType()
Optional. The frequency type for video ads in this ad rule slot. This
attribute is required for mid-rolls, but if this is not a mid-roll, the
value is set to [AdRuleSlotMidrollFrequencyType.NONE][].
optional .google.ads.admanager.v1.AdRuleSlotMidrollFrequencyTypeEnum.AdRuleSlotMidrollFrequencyType video_midroll_frequency_type = 5 [(.google.api.field_behavior) = OPTIONAL];
getVideoMidrollFrequencyTypeValue()
public int getVideoMidrollFrequencyTypeValue()
Optional. The frequency type for video ads in this ad rule slot. This
attribute is required for mid-rolls, but if this is not a mid-roll, the
value is set to [AdRuleSlotMidrollFrequencyType.NONE][].
optional .google.ads.admanager.v1.AdRuleSlotMidrollFrequencyTypeEnum.AdRuleSlotMidrollFrequencyType video_midroll_frequency_type = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for videoMidrollFrequencyType.
|
hasBumper()
public boolean hasBumper()
Optional. The AdRuleSlotBumper for this slot. This attribute is optional
and defaults to [AdRuleSlotBumper.NONE][].
optional .google.ads.admanager.v1.AdRuleSlotBumperEnum.AdRuleSlotBumper bumper = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the bumper field is set.
|
hasMaxBumperDuration()
public boolean hasMaxBumperDuration()
Optional. The maximum duration of bumper ads within this slot. This
attribute is optional and defaults to 0.
optional .google.protobuf.Duration max_bumper_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the maxBumperDuration field is set.
|
hasMaxPodDuration()
public boolean hasMaxPodDuration()
Optional. The maximum pod duration for this slot. This attribute is
optional and defaults to 0.
optional .google.protobuf.Duration max_pod_duration = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the maxPodDuration field is set.
|
hasMaxVideoAdDuration()
public boolean hasMaxVideoAdDuration()
Optional. The maximum duration in milliseconds of video ads within this
slot. This attribute is optional and defaults to 0.
optional .google.protobuf.Duration max_video_ad_duration = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the maxVideoAdDuration field is set.
|
hasPodMaxAdCount()
public boolean hasPodMaxAdCount()
Optional. The maximum number of ads allowed in a pod in this slot. This
attribute is optional and defaults to 0.
optional int32 pod_max_ad_count = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the podMaxAdCount field is set.
|
hasSlotBehavior()
public boolean hasSlotBehavior()
Optional. The AdRuleSlotBehavior for video ads for this slot. This
attribute is optional and defaults to [AdRuleSlotBehavior.DEFER][].
Indicates whether video ads are allowed for this slot, or if the decision
is deferred to alower-priority ad rule.
optional .google.ads.admanager.v1.AdRuleSlotBehaviorEnum.AdRuleSlotBehavior slot_behavior = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the slotBehavior field is set.
|
hasVideoMidrollFrequency()
public boolean hasVideoMidrollFrequency()
Optional. The mid-roll frequency of this ad rule slot for video ads. This
attribute is required for mid-rolls, but if MidrollFrequencyType is set to
[AdRuleSlotMidrollFrequencyType.NONE][], this value should be ignored. For
example, if this slot has a frequency type of
[AdRuleSlotMidrollFrequencyType.EVERY_N_SECONDS][] and
videoMidrollFrequency = "60", this would mean "play a mid-roll every 60
seconds."
optional string video_midroll_frequency = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the videoMidrollFrequency field is set.
|
hasVideoMidrollFrequencyType()
public boolean hasVideoMidrollFrequencyType()
Optional. The frequency type for video ads in this ad rule slot. This
attribute is required for mid-rolls, but if this is not a mid-roll, the
value is set to [AdRuleSlotMidrollFrequencyType.NONE][].
optional .google.ads.admanager.v1.AdRuleSlotMidrollFrequencyTypeEnum.AdRuleSlotMidrollFrequencyType video_midroll_frequency_type = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the videoMidrollFrequencyType field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AdRuleSlot.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected AdRuleSlot.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public AdRuleSlot.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides