AdsApp.NegativeKeywordSelector
Stay organized with collections Save and categorize content based on your preferences.
Fetches negative keywords (except from shared libraries).
Typical usage:
var adGroup = AdsApp.adGroups().get().next();
var negativeKeywordSelector = adGroup.negativeKeywords();
var negativeKeywordIterator = negativeKeywordSelector.get();
while (negativeKeywordIterator.hasNext()) {
var negativeKeyword = negativeKeywordIterator.next();
}Related:
Methods:
get()
Fetches the requested negative keywords and returns an iterator.
Return values:
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 text, in ascending order.orderBy("ad_group_criterion.keyword.text ASC") - orders results by text, in ascending order.orderBy("ad_group_criterion.keyword.text DESC") - orders results by text, in descending order.
See NegativeKeywordSelector.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 text in ascending order. Results with equal text value will be ordered by match type in ascending order.
Arguments:
| Name | Type | Description |
|---|
| orderBy | String | Ordering to apply. |
Return values:
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 negative 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 |
|---|
| Negative 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 negative 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 negative keywords from only ENABLED campaigns. |
Arguments:
| Name | Type | Description |
|---|
| condition | String | Condition to add to the selector. |
Return values:
withLimit(limit)
Specifies limit for the selector to use. For instance,
withLimit(50) returns only the first 50 entities.
Arguments:
| Name | Type | Description |
|---|
| limit | int | How many entities to return. |
Return values:
