AdsApp.​ExcludedDisplayKeywordSelector

  • ExcludedDisplayKeywordSelector fetches excluded display keywords and supports filtering and sorting.

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

  • You can specify the ordering of the results using the orderBy() method.

  • The withCondition() method allows you to narrow down results by adding conditions based on various excluded display keyword attributes.

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

 Fetches excluded display keywords. Supports filtering and sorting.

Typical usage: 

var adGroup = AdsApp.adGroups().get().next();
var excludedDisplayKeywordSelector = adGroup.display().excludedKeywords();

var excludedDisplayKeywordIterator = excludedDisplayKeywordSelector.get();
while (excludedDisplayKeywordIterator.hasNext()) {
  var excludedDisplayKeyword = excludedDisplayKeywordIterator.next();
}
 Related:

Methods:

MemberTypeDescription
get() AdsApp.ExcludedDisplayKeywordIterator Fetches the requested excluded display keywords and returns an iterator.
orderBy(orderBy) AdsApp.ExcludedDisplayKeywordSelector Specifies the ordering of the resulting entities.
withCondition(condition) AdsApp.ExcludedDisplayKeywordSelector Adds the specified condition to the selector in order to narrow down the results.
withLimit(limit) AdsApp.ExcludedDisplayKeywordSelector Specifies limit for the selector to use.

get()

Fetches the requested excluded display keywords and returns an iterator.

Return values:

TypeDescription
AdsApp.ExcludedDisplayKeywordIterator Iterator of the requested excluded display keywords.

orderBy(orderBy)

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

See ExcludedDisplayKeywordSelector.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_criterion.keyword.text")
    .orderBy("ad_group_criterion.keyword.match_type");

The results will be ordered by ad_group_criterion.keyword.text in ascending order. Results with equal ad_group_criterion.keyword.text value will be ordered by ad_group_criterion.keyword.match_type in ascending order.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdsApp.ExcludedDisplayKeywordSelector 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_criterion.keyword.text REGEXP_MATCH 'a.*'")
    .withCondition("ad_group_criterion.keyword.match_type = BROAD");
 All specified conditions are AND-ed together. The above example will retrieve excluded display keywords that start with the letter 'a' and are of broad match type.

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_criterion.keyword.text): 
    =  != (NOT) (LIKE | CONTAINS | REGEXP_MATCH)
  • For Enumeration columns (ones that can only take one value from a pre-defined list, such as ad_group_criterion.keyword.match_type): 
    = !=  IN () NOT IN ()
Conditions using IN, NOT IN, CONTAINS ALL, CONTAINS ANY and CONTAINS NONE operators look as follows: 
withCondition("ad_group_criterion.keyword.match_type IN (Value1, Value2)")

Columns

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

Column Type Example
Excluded display keyword attributes
ad_group_criterion.keyword.text String withCondition("ad_group_criterion.keyword.text REGEXP_MATCH 'leather.*'")
ad_group_criterion.keyword.match_type Enumeration: BROAD, EXACT, PHRASE withCondition("ad_group_criterion.keyword.match_type = PHRASE")
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 display keywords 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 display keywords from only ENABLED campaigns.

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdsApp.ExcludedDisplayKeywordSelector 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.ExcludedDisplayKeywordSelector The selector with limit applied.