type AdRule (v202411)

Service
AdRuleService
Dependencies
AdRulePage createAdRules() updateAdRules()
▼
AdRule

An AdRule contains data that the ad server will use to generate a playlist of video ads.

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

Field

id

xsd:long

The unique ID of the AdRule. This value is readonly and is assigned by Google.

name

xsd:string

The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.

priority

xsd:int

The priority of the AdRule. This attribute is required and can range from 1 to 1000, with 1 being the highest possible priority.

Changing an ad rule's priority can affect the priorities of other ad rules. For example, increasing an ad rule's priority from 5 to 1 will shift the ad rules that were previously in priority positions 1 through 4 down one.

targeting

Targeting

The targeting criteria of the AdRule. This attribute is required.

startDateTime

DateTime

This AdRule object's start date and time. This attribute is required and must be a date in the future for new ad rules.

startDateTimeType

StartDateTimeType

Specifies whether to start using the AdRule right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

Enumerations
USE_START_DATE_TIME
Use the value in startDateTime.
IMMEDIATELY
The entity will start serving immediately. startDateTime in the request is ignored and will be set to the current time. Additionally, startDateTimeType will be set to StartDateTimeType.USE_START_DATE_TIME.
ONE_HOUR_FROM_NOW
The entity will start serving one hour from now. startDateTime in the request is ignored and will be set to one hour from the current time. Additionally, startDateTimeType will be set to StartDateTimeType.USE_START_DATE_TIME.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

endDateTime

DateTime

This AdRule object's end date and time. This attribute is required unless unlimitedEndDateTime is set to true. If specified, it must be after the startDateTime.

unlimitedEndDateTime

xsd:boolean

Specifies whether the AdRule has an end time. This attribute is optional and defaults to false.

status

AdRuleStatus

The AdRuleStatus of the ad rule. This attribute is read-only and defaults to AdRuleStatus.INACTIVE.

Enumerations
ACTIVE
Created and ready to be served. Is user-visible.
INACTIVE
Paused, user-visible.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

frequencyCapBehavior

FrequencyCapBehavior

The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to FrequencyCapBehavior.DEFER.

Enumerations
TURN_ON
Turn on at least one of the frequency caps.
TURN_OFF
Turn off all frequency caps.
DEFER
Defer frequency cap decisions to the next ad rule in priority order.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

maxImpressionsPerLineItemPerStream

xsd:int

This AdRule object's frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0.

maxImpressionsPerLineItemPerPod

xsd:int

This AdRule object's frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0.

preroll

  1. BaseAdRuleSlot
    1. NoPoddingAdRuleSlot
    2. OptimizedPoddingAdRuleSlot
    3. StandardPoddingAdRuleSlot
    4. UnknownAdRuleSlot

This AdRule object's pre-roll slot. This attribute is required.

midroll

  1. BaseAdRuleSlot
    1. NoPoddingAdRuleSlot
    2. OptimizedPoddingAdRuleSlot
    3. StandardPoddingAdRuleSlot
    4. UnknownAdRuleSlot

This AdRule object's mid-roll slot. This attribute is required.

postroll

  1. BaseAdRuleSlot
    1. NoPoddingAdRuleSlot
    2. OptimizedPoddingAdRuleSlot
    3. StandardPoddingAdRuleSlot
    4. UnknownAdRuleSlot

This AdRule object's post-roll slot. This attribute is required.