AdWordsApp.​NegativeKeywordListSelector

Fetches negative keyword lists. Supports filtering and sorting.

Typical usage:

 var negativeKeywordListSelector = AdWordsApp.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 AdWordsApp.NegativeKeywordListIterator Fetches the requested negative keyword lists and returns an iterator.
orderBy AdWordsApp.NegativeKeywordListSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.NegativeKeywordListSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.NegativeKeywordListSelector Restricts this selector to return only negative keyword lists with the given negative keyword list IDs.
withLimit AdWordsApp.NegativeKeywordListSelector Specifies limit for the selector to use.

get()

Fetches the requested negative keyword lists and returns an iterator.

Return values:

TypeDescription
AdWordsApp.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("Name") - orders results by Name, in ascending order.
  • orderBy("MemberCount ASC") - orders results by MemberCount, in ascending order.
  • orderBy("Name DESC") - orders results by 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("SharedSetId DESC");

The results will be ordered by SharedSetId in descending order.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdWordsApp.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):
    =  !=  STARTS_WITH  STARTS_WITH_IGNORE_CASE  CONTAINS
     CONTAINS_IGNORE_CASE  DOES_NOT_CONTAIN  DOES_NOT_CONTAIN_IGNORE_CASE
  • 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]")
Operators are case-sensitive: starts_with won't work.

Columns

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

Column Type Example
Shared Set Attributes
MemberCount Integer withCondition("MemberCount > 5")
Name String withCondition("Name = 'negative keyword list'")
ReferenceCount Integer withCondition("ReferenceCount> 5")
SharedSetId Long withCondition("SharedSetId > 5")
Status Enumeration: ACTIVE, DELETED withCondition("Status = ACTIVE")

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdWordsApp.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:

 AdWordsApp.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 long[] Array of negative keyword list IDs.

Return values:

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

Feedback geben zu...

AdWords Scripts
AdWords Scripts