AdsApp.​NegativeKeywordListSelector

AI-generated Key Takeaways

outlined_flag

• AdsApp.negativeKeywordLists() is used to fetch negative keyword lists and supports filtering and sorting.

• You can apply conditions to narrow down the results using methods like withCondition(), withIds(), withLimit(), and withResourceNames().

• The orderBy() method allows you to specify the sorting order of the results.

• The get() method retrieves the requested negative keyword lists and returns an iterator to access them.

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:

get()

Return values:

orderBy(orderBy)

• 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:

Return values:

withCondition(condition)

Multiple conditions may be added to the same selector:

negativeKeywordListSelector = negativeKeywordListSelector
    .withCondition("SharedSetId > 5")
    .withCondition("Name CONTAINS 'negative keyword list'");

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

"COLUMN_NAME OPERATOR VALUE"

Operators

• 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 ()

withCondition("Name IN (Value1, Value2)")

Columns

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

Arguments:

Return values:

withIds(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']);

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:

Return values:

withLimit(limit)

Arguments:

Return values:

withResourceNames(resourceNames)

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:

Return values: