AdsApp.​SnippetIterator

  • A SnippetIterator is used to iterate through snippets.

  • The hasNext() method checks if there are more snippets to iterate through.

  • The next() method returns the next snippet in the iteration.

  • The totalNumEntities() method returns the total number of entities matched by the selector, disregarding limits.

 An iterator of snippets.

Typical usage: 

while (snippetIterator.hasNext()) {
  var snippet = snippetIterator.next();
}
 Related:

Methods:

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

Return values:

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