AdsApp.​DisplayKeywordIterator

  • This object is an iterator for display keywords, allowing you to loop through them using hasNext() and next().

  • hasNext() checks if there are more display keywords to iterate through, returning true if there are and false otherwise.

  • next() returns the next display keyword in the iterator.

  • totalNumEntities() provides the total count of display keywords matched by the selector, even if the iterator might not reach all due to limitations.

 An iterator of display keywords.

Typical usage: 

while (displayKeywordIterator.hasNext()) {
  var displayKeyword = displayKeywordIterator.next();
}
 Related:

Methods:

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

Return values:

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