AdsApp.​DraftIterator

  • DraftIterator allows you to iterate through a collection of drafts, typically obtained using a DraftSelector.

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

  • Use hasNext() in a loop to iterate and process each draft individually.

  • While totalNumEntities() provides the total matched count, the iterator might not have all elements due to entity read limits.

 An iterator of drafts.

Typical usage: 

while (draftIterator.hasNext()) {
  var draft = draftIterator.next();
}
 Related:

Methods:

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

Return values:

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