AdsApp.​AdGroupIterator

  • Provides a way to iterate through a collection of Ad Groups.

  • Offers methods to check for more elements (hasNext), retrieve the next Ad Group (next), and get the total count of matched entities (totalNumEntities).

  • Used in conjunction with an AdGroupSelector to retrieve Ad Groups based on specific criteria.

  • Useful for processing or manipulating multiple Ad Groups within a Google Ads script.

 An iterator of ad groups.

Typical usage: 

while (adGroupIterator.hasNext()) {
  var adGroup = adGroupIterator.next();
}
 Related:

Methods:

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

Return values:

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