abstract type BaseAdRuleSlot (v202405)

Service
AdRuleService
Dependencies
AdRule
▼
BaseAdRuleSlot
Inheritance
BaseAdRuleSlot
▼
NoPoddingAdRuleSlot OptimizedPoddingAdRuleSlot StandardPoddingAdRuleSlot UnknownAdRuleSlot

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.

Namespace
https://www.google.com/apis/ads/publisher/v202405

Field

slotBehavior

AdRuleSlotBehavior

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 a lower-priority ad rule.

Enumerations
ALWAYS_SHOW
This ad rule always includes this slot's ads.
NEVER_SHOW
This ad rule never includes this slot's ads.
DEFER
Defer to lower priority rules. This ad rule doesn't specify guidelines for this slot's ads.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

maxVideoAdDuration

xsd:long

The maximum duration in milliseconds of video ads within this slot. This attribute is optional and defaults to 0.

videoMidrollFrequencyType

MidrollFrequencyType

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 MidrollFrequencyType.NONE.

Enumerations
NONE
The ad rule slot is not a mid-roll and hence MidrollFrequency should be ignored.
EVERY_N_SECONDS
MidrollFrequency is a time interval and mentioned as a single numeric value in seconds. For example, "100" would mean "play a mid-roll every 100 seconds".
FIXED_TIME
MidrollFrequency is a comma-delimited list of points in time (in seconds) when an ad should play. For example, "100,300" would mean "play an ad at 100 seconds and 300 seconds".
EVERY_N_CUEPOINTS
MidrollFrequency is a cue point interval and is a single integer value, such as "5", which means "play a mid-roll every 5th cue point".
FIXED_CUE_POINTS
Same as FIXED_TIME, except the values represent the ordinal cue points ("1,3,5", for example).
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

videoMidrollFrequency

xsd:string

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 MidrollFrequencyType.NONE, this value should be ignored. For example, if this slot has a frequency type of MidrollFrequencyType.EVERY_N_SECONDS and #videoMidrollFrequency = "60", this would mean " play a mid-roll every 60 seconds."

bumper

AdRuleSlotBumper

The AdRuleSlotBumper for this slot. This attribute is optional and defaults to AdRuleSlotBumper.NONE.

Enumerations
NONE
Do not show a bumper ad.
BEFORE
Show a bumper ad before the slot's other ads.
AFTER
Show a bumper ad after the slot's other ads.
BEFORE_AND_AFTER
Show a bumper before and after the slot's other ads.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

maxBumperDuration

xsd:long

The maximum duration of bumper ads within this slot. This attribute is optional and defaults to 0.

maxPodDuration

xsd:long

The maximum pod duration in milliseconds for this slot. This attribute is optional and defaults to 0.

maxAdsInPod

xsd:int

The maximum number of ads allowed in a pod in this slot. This attribute is optional and defaults to 0.

breakTemplateId

xsd:long

ID of a BreakTemplate that defines what kinds of ads show at which positions within this slot. This field is optional and only supported on OptimizedPoddingAdRuleSlot entities.