AdsApp.​ExcludedVideoParentalStatusSelector

  • ExcludedVideoParentalStatusSelector fetches excluded video parental statuses and supports filtering and sorting.

  • The get() method fetches the requested statuses and returns an iterator.

  • The orderBy() method specifies the order in which results are returned.

  • The withCondition() method adds conditions to narrow down results based on various columns and operators.

  • The withLimit() method specifies the maximum number of entities to return.

 Fetches excluded video parental statuses. Supports filtering and sorting.

Typical usage: 

var excludedVideoParentalStatusSelector = AdsApp.videoTargeting()
    .excludedVideoParentalStatuses()
    .withCondition("ad_group.status = 'ENABLED'")
    .orderBy("ad_group.name DESC");

var excludedVideoParentalStatusIterator = excludedVideoParentalStatusSelector.get();
while (excludedVideoParentalStatusIterator.hasNext()) {
  var excludedVideoParentalStatus = excludedVideoParentalStatusIterator.next();
}
 Related:

Methods:

MemberTypeDescription
get() AdsApp.ExcludedVideoParentalStatusIterator Fetches the requested excluded video parental statuses and returns an iterator.
orderBy(orderBy) AdsApp.ExcludedVideoParentalStatusSelector Specifies the ordering of the resulting entities.
withCondition(condition) AdsApp.ExcludedVideoParentalStatusSelector Adds the specified condition to the selector in order to narrow down the results.
withLimit(limit) AdsApp.ExcludedVideoParentalStatusSelector Specifies limit for the selector to use.

get()

Fetches the requested excluded video parental statuses and returns an iterator.

Return values:

TypeDescription
AdsApp.ExcludedVideoParentalStatusIterator Iterator of the requested excluded video parental statuses.

orderBy(orderBy)

Specifies the ordering of the resulting entities. orderBy parameter can have one of the following forms:
  • orderBy("ad_group.name") - orders results by ad_group.name, in ascending order.
  • orderBy("ad_group.name ASC") - orders results by ad_group.name, in ascending order.
  • orderBy("ad_group.name DESC") - orders results by ad_group.name, in descending order.

See ExcludedVideoParentalStatusSelector.withCondition(String) for enumeration of columns that can be used.

orderBy() may be called multiple times. Consider the following example: 

selector = selector.
    .orderBy("ad_group.name")
    .orderBy("campaign.name");

The results will be ordered by ad_group.name in ascending order. Results with equal ad_group.name value will be ordered by campaign.name in ascending order.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdsApp.ExcludedVideoParentalStatusSelector The selector with ordering applied.

withCondition(condition)

Adds the specified condition to the selector in order to narrow down the results.

Multiple conditions may be added to the same selector: 

selector = selector
    .withCondition("ad_group.status NOT IN [PAUSED]")
    .withCondition("campaign.name = 'Campaign 1'");
 All specified conditions are AND-ed together. The above example will retrieve excluded entities in Campaign 1 that are in ad groups that are not paused.

The parameter to be passed into this method must be of the following form: 

"COLUMN_NAME OPERATOR VALUE"

Operators

The operator that can be used in a condition depends on the type of column.
  • For String columns (e.g. ad_group.name): 
    =  !=  (NOT) (LIKE | CONTAINS | REGEXP_MATCH)
  • For Enumeration columns (ones that can only take one value from a pre-defined list, such as ad_group.status): 
    =  !=  IN () NOT IN ()
Conditions using IN, NOT IN, CONTAINS ALL, CONTAINS ANY and CONTAINS NONE operators look as follows: 
withCondition("ad_group.status IN [ENABLED, PAUSED]")

Columns

All column names are case-sensitive, and so are all values of enumerated columns (such as ad_group.status)

Column Type Example
Attributes of excluded video parental status
ParentType Enumeration: PARENT_PARENT, PARENT_NOT_A_PARENT, PARENT_UNDETERMINED withCondition("ParentType != 'PARENT_UNDETERMINED'")
ad_group.name String withCondition("ad_group.name REGEXP_MATCH '.*shoes.*'")
ad_group.status Enumeration: ENABLED, PAUSED, REMOVED withCondition("ad_group.status = ENABLED"). Use to fetch excluded topics from only ENABLED ad groups.
campaign.name String withCondition("campaign.name REGEXP_MATCH '.*promotion.*'")
campaign.status Enumeration: ENABLED, PAUSED, REMOVED withCondition("campaign.status = ENABLED"). Use to fetch excluded topics from only ENABLED campaigns.

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdsApp.ExcludedVideoParentalStatusSelector The selector with the condition applied.

withLimit(limit)

Specifies limit for the selector to use. For instance, withLimit(50) returns only the first 50 entities.

Arguments:

NameTypeDescription
limit int How many entities to return.

Return values:

TypeDescription
AdsApp.ExcludedVideoParentalStatusSelector The selector with limit applied.