AdsApp.​NegativeKeywordIterator

  • The NegativeKeywordIterator allows you to iterate through negative keywords obtained from a NegativeKeywordSelector.

  • It provides methods like hasNext() to check for more elements, next() to retrieve the next NegativeKeyword, and totalNumEntities() to get the total count of matched entities.

  • This iterator is useful for processing negative keywords in scripts, enabling tasks like reviewing or modifying them.

 An iterator of negative keywords.

Typical usage: 

while (negativeKeywordIterator.hasNext()) {
  var negativeKeyword = negativeKeywordIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.NegativeKeyword Returns the next NegativeKeyword in the iterator.
totalNumEntities() int Returns the total number of entities matched by the selector which generated this iterator.

hasNext()

Returns true if the iterator has more elements.

Return values:

TypeDescription
boolean true if the iterator has more elements.

next()

Returns the next NegativeKeyword in the iterator.

Return values:

TypeDescription
AdsApp.NegativeKeyword The next NegativeKeyword in the iterator.

totalNumEntities()

Returns the total number of entities matched by the selector which generated this iterator.

Note that the returned number disregards limits, and that the iterator is not guaranteed to have this many elements — hasNext will start to return false and next will start to throw exceptions as soon as the limit for entity reads has been reached, even if the selector matched more entities.

Return values:

TypeDescription
int The number of entities matched by the selector which generated this iterator.