AdsApp.​LabelIterator

  • Provides a way to iterate through a collection of labels.

  • Offers methods to check for more labels (hasNext), retrieve the next label (next), and get the total count of matched labels (totalNumEntities).

  • Used to process labels sequentially within a loop, as demonstrated in the typical usage example.

  • Related to LabelSelector and Label objects for managing and accessing labels within Google Ads scripts.

 An iterator of labels.

Typical usage: 

while (labelIterator.hasNext()) {
  var label = labelIterator.next();
}
 Related:

Methods:

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

Return values:

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