AdsApp.​NegativeKeywordListSelector

Fetches negative keyword lists. Supports filtering and sorting.

Typical usage:

 var negativeKeywordListSelector = AdsApp.negativeKeywordLists()
     .withCondition("Name CONTAINS 'test'")
     .withLimit(1)
     .withIds([10,20])
     .orderBy("SharedSetId DESC");

 var negativeKeywordListIterator = negativeKeywordListSelector.get();

 while (negativeKeywordListIterator.hasNext()) {
   var negativeKeywordList = negativeKeywordListIterator.next();
 }

Methods:

MemberTypeDescription
get AdsApp.NegativeKeywordListIterator Fetches the requested negative keyword lists and returns an iterator.
orderBy AdsApp.NegativeKeywordListSelector Specifies the ordering of the resulting entities.
withCondition AdsApp.NegativeKeywordListSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdsApp.NegativeKeywordListSelector Restricts this selector to return only negative keyword lists with the given negative keyword list IDs.
withLimit AdsApp.NegativeKeywordListSelector Specifies limit for the selector to use.
withResourceNames AdsApp.NegativeKeywordListSelector Restricts this selector to return only negative keyword lists with the given Google Ads API resource names.

get()

Fetches the requested negative keyword lists and returns an iterator.

Return values:

TypeDescription
AdsApp.NegativeKeywordListIterator Iterator of the requested negative keyword lists.

orderBy(orderBy)

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

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

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

 negativeKeywordListSelector = negativeKeywordListSelector
     .orderBy("shared_set.name ASC")
     .orderBy("shared_set.id DESC");

The results will be ordered by shared_set.name in ascending order. Results with equal shared_set.name value will be ordered by shared_set.id in descending order.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdsApp.NegativeKeywordListSelector The selector with ordering applied. Adds the specified condition to the selector in order to narrow down the results.

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:

 negativeKeywordListSelector = negativeKeywordListSelector
     .withCondition("SharedSetId > 5")
     .withCondition("Name CONTAINS 'negative keyword list'");
All specified conditions are AND-ed together. The above example will retrieve negative keyword lists that have a Shared Set Id greater than 5 and contains "negative keyword list" in its name.

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 Integer and Long columns (e.g. SharedSetId):
    <  <=  >  >=  =  !=
  • For String columns (e.g. Name):
    =  !=  (NOT) (LIKE | CONTAINS | REGEXP_MATCH)
  • For Enumeration columns (ones that can only take one value from a predefined list, such as Status):
    =  !=  IN () NOT IN ()
Conditions using IN, NOT IN, CONTAINS ALL, CONTAINS ANY and CONTAINS NONE operators look as follows:
 withCondition("Name IN (Value1, Value2)")

Columns

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

Column Type Example
Shared Set Attributes
shared_set.name String withCondition("shared_set.name = 'my shared set'")
shared_set.id Long withCondition("shared_set.id > 5")
shared_set.status Enumeration: ENABLED, REMOVED withCondition("shared_set.status = ENABLED")

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdsApp.NegativeKeywordListSelector The selector with the condition applied.

withIds(ids)

Restricts this selector to return only negative keyword lists with the given negative keyword list IDs.
 var negativeKeywordListIds = ['12345', '23456', '34567'];
 selector = selector.withIds(negativeKeywordListIds);

The resulting selector can be further refined by applying additional conditions to it. The ID-based condition will then be AND-ed together with all the other conditions, including any other ID-based conditions. So, for instance, the following selector:

 AdsApp.negativeKeywordLists()
    .withIds(['12345', '23456', '34567'])
    .withIds(['34567', '45678', '56789']);
will only get the negative keyword list with ID 34567, since it would be the only negative keyword list that satisfies both ID conditions.

The selector can only support up to 10,000 IDs. If more than 10,000 IDs are specified, the corresponding get() call will fail with a runtime error.

Arguments:

NameTypeDescription
ids Object[] Array of negative keyword list IDs.

Return values:

TypeDescription
AdsApp.NegativeKeywordListSelector The selector restricted to the given IDs.

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.NegativeKeywordListSelector The selector with limit applied.

withResourceNames(resourceNames)

Restricts this selector to return only negative keyword lists with the given Google Ads API resource names.
 const negativeKeywordListResourceNames = [
   'customers/1234567890/sharedSets/111',
   'customers/1234567890/sharedSets/222',
   'customers/1234567890/sharedSets/333',
 ];
 selector = selector.withResourceNames(negativeKeywordListResourceNames);

The resulting selector can be further refined by applying additional conditions to it. The resource name condition will then be AND-ed together with all the other conditions.

The selector can only support up to 10,000 resource names. If more than 10,000 resource names are specified, the corresponding get() call will fail with a runtime error.

Arguments:

NameTypeDescription
resourceNames String[] Array of negative keyword list resource names.

Return values:

TypeDescription
AdsApp.NegativeKeywordListSelector The selector restricted to the given resource names.