AdsApp.​KeywordIterator

  • KeywordIterator provides a way to iterate through a collection of keywords.

  • It offers methods like hasNext() to check for more keywords, next() to retrieve the next keyword, and totalNumEntities() to get the total count of matched keywords.

  • The iterator might not contain all matched entities due to system limits, indicated by hasNext() returning false and next() throwing exceptions.

 An iterator of keywords.

Typical usage: 

while (keywordIterator.hasNext()) {
  var keyword = keywordIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.Keyword Returns the next Keyword 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 Keyword in the iterator.

Return values:

TypeDescription
AdsApp.Keyword The next Keyword 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.