Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202311.AdRule Class Reference

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

Properties

long id [get, set]
 The unique ID of the AdRule. This value is readonly and is assigned by Google. More...
 
bool idSpecified [get, set]
 
string name [get, set]
 The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters. More...
 
int priority [get, set]
 The priority of the AdRule. This attribute is required and can range from 1 to 1000, with 1 being the highest possible priority. More...
 
bool prioritySpecified [get, set]
 
Targeting targeting [get, set]
 The targeting criteria of the AdRule. This attribute is required. More...
 
DateTime startDateTime [get, set]
 This AdRule object's start date and time. This attribute is required and must be a date in the future for new ad rules. More...
 
StartDateTimeType startDateTimeType [get, set]
 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. More...
 
bool startDateTimeTypeSpecified [get, set]
 
DateTime endDateTime [get, set]
 This AdRule object's end date and time. This attribute is required unless More...
 
bool unlimitedEndDateTime [get, set]
 Specifies whether the AdRule has an end time. This attribute is optional and defaults to false. More...
 
bool unlimitedEndDateTimeSpecified [get, set]
 
AdRuleStatus status [get, set]
 The AdRuleStatus of the ad rule. This attribute is read-only and defaults to AdRuleStatus::INACTIVE. More...
 
bool statusSpecified [get, set]
 
FrequencyCapBehavior frequencyCapBehavior [get, set]
 The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to FrequencyCapBehavior::DEFER. More...
 
bool frequencyCapBehaviorSpecified [get, set]
 
int maxImpressionsPerLineItemPerStream [get, set]
 This AdRule object's frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0. More...
 
bool maxImpressionsPerLineItemPerStreamSpecified [get, set]
 
int maxImpressionsPerLineItemPerPod [get, set]
 This AdRule object's frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0. More...
 
bool maxImpressionsPerLineItemPerPodSpecified [get, set]
 
BaseAdRuleSlot preroll [get, set]
 This AdRule object's pre-roll slot. This attribute is required. More...
 
BaseAdRuleSlot midroll [get, set]
 This AdRule object's mid-roll slot. This attribute is required. More...
 
BaseAdRuleSlot postroll [get, set]
 This AdRule object's post-roll slot. This attribute is required. More...
 

Detailed Description

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

Property Documentation

DateTime Google.Api.Ads.AdManager.v202311.AdRule.endDateTime
getset

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 .

FrequencyCapBehavior Google.Api.Ads.AdManager.v202311.AdRule.frequencyCapBehavior
getset

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

bool Google.Api.Ads.AdManager.v202311.AdRule.frequencyCapBehaviorSpecified
getset

true, if a value is specified for frequencyCapBehavior, false otherwise.

long Google.Api.Ads.AdManager.v202311.AdRule.id
getset

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

bool Google.Api.Ads.AdManager.v202311.AdRule.idSpecified
getset

true, if a value is specified for id, false otherwise.

int Google.Api.Ads.AdManager.v202311.AdRule.maxImpressionsPerLineItemPerPod
getset

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

bool Google.Api.Ads.AdManager.v202311.AdRule.maxImpressionsPerLineItemPerPodSpecified
getset

true, if a value is specified for maxImpressionsPerLineItemPerPod, false otherwise.

int Google.Api.Ads.AdManager.v202311.AdRule.maxImpressionsPerLineItemPerStream
getset

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

bool Google.Api.Ads.AdManager.v202311.AdRule.maxImpressionsPerLineItemPerStreamSpecified
getset

true, if a value is specified for maxImpressionsPerLineItemPerStream, false otherwise.

BaseAdRuleSlot Google.Api.Ads.AdManager.v202311.AdRule.midroll
getset

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

string Google.Api.Ads.AdManager.v202311.AdRule.name
getset

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

BaseAdRuleSlot Google.Api.Ads.AdManager.v202311.AdRule.postroll
getset

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

BaseAdRuleSlot Google.Api.Ads.AdManager.v202311.AdRule.preroll
getset

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

int Google.Api.Ads.AdManager.v202311.AdRule.priority
getset

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.

bool Google.Api.Ads.AdManager.v202311.AdRule.prioritySpecified
getset

true, if a value is specified for priority, false otherwise.

DateTime Google.Api.Ads.AdManager.v202311.AdRule.startDateTime
getset

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 Google.Api.Ads.AdManager.v202311.AdRule.startDateTimeType
getset

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.

bool Google.Api.Ads.AdManager.v202311.AdRule.startDateTimeTypeSpecified
getset

true, if a value is specified for startDateTimeType, false otherwise.

AdRuleStatus Google.Api.Ads.AdManager.v202311.AdRule.status
getset

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

bool Google.Api.Ads.AdManager.v202311.AdRule.statusSpecified
getset

true, if a value is specified for status, false otherwise.

Targeting Google.Api.Ads.AdManager.v202311.AdRule.targeting
getset

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

bool Google.Api.Ads.AdManager.v202311.AdRule.unlimitedEndDateTime
getset

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

bool Google.Api.Ads.AdManager.v202311.AdRule.unlimitedEndDateTimeSpecified
getset

true, if a value is specified for unlimitedEndDateTime, false otherwise.


The documentation for this class was generated from the following file: