Ads API .NET library
|
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... | |
An AdRule contains data that the ad server will use to generate a playlist of video ads.
|
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 .
|
getset |
The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to FrequencyCapBehavior::DEFER.
|
getset |
true
, if a value is specified for frequencyCapBehavior, false
otherwise.
|
getset |
|
getset |
true
, if a value is specified for id, false
otherwise.
|
getset |
This AdRule object's frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0.
|
getset |
true
, if a value is specified for maxImpressionsPerLineItemPerPod, false
otherwise.
|
getset |
This AdRule object's frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0.
|
getset |
true
, if a value is specified for maxImpressionsPerLineItemPerStream, false
otherwise.
|
getset |
This AdRule object's mid-roll slot. This attribute is required.
|
getset |
The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.
|
getset |
This AdRule object's post-roll slot. This attribute is required.
|
getset |
This AdRule object's pre-roll slot. This attribute is required.
|
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.
|
getset |
true
, if a value is specified for priority, false
otherwise.
|
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.
|
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.
|
getset |
true
, if a value is specified for startDateTimeType, false
otherwise.
|
getset |
The AdRuleStatus of the ad rule. This attribute is read-only and defaults to AdRuleStatus::INACTIVE.
|
getset |
true
, if a value is specified for status, false
otherwise.
|
getset |
The targeting criteria of the AdRule. This attribute is required.
|
getset |
Specifies whether the AdRule has an end time. This attribute is optional and defaults to false.
|
getset |
true
, if a value is specified for unlimitedEndDateTime, false
otherwise.