Interface AdRuleSlotOrBuilder (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface AdRuleSlotOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBumper()

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

Returns
Type	Description
AdRuleSlotBumperEnum.AdRuleSlotBumper	The bumper.

getBumperValue()

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

getMaxBumperDuration()

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

Returns
Type	Description
DurationOrBuilder

getMaxPodDuration()

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

Returns
Type	Description
DurationOrBuilder

getMaxVideoAdDuration()

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

Returns
Type	Description
DurationOrBuilder

getPodMaxAdCount()

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

getSlotBehavior()

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

Returns
Type	Description
AdRuleSlotBehaviorEnum.AdRuleSlotBehavior	The slotBehavior.

getSlotBehaviorValue()

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

Returns
Type	Description
AdRuleSlotMidrollFrequencyTypeEnum.AdRuleSlotMidrollFrequencyType	The videoMidrollFrequencyType.

getVideoMidrollFrequencyTypeValue()

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