AdsApp.​VideoAdGroupIterator

  • Enables iteration through a collection of VideoAdGroups, allowing you to access and process each one individually.

  • Provides methods like hasNext() to check for more elements, next() to retrieve the next VideoAdGroup, and totalNumEntities() to get the total count of matched entities.

  • Works in conjunction with VideoAdGroupSelector to define the criteria for selecting VideoAdGroups.

  • Useful for automating tasks and applying changes to multiple VideoAdGroups within Google Ads scripts.

 An iterator of video ad groups.

Typical usage: 

while (videoAdGroupIterator.hasNext()) {
  var videoAdGroup = videoAdGroupIterator.next();
}
 Related:

Methods:

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

Return values:

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