AdsApp.​ShoppingAdGroupIterator

  • An iterator provides access to a collection of ShoppingAdGroup objects, retrieved using a ShoppingAdGroupSelector.

  • It allows you to iterate through each ShoppingAdGroup using hasNext() and next() methods within a loop.

  • totalNumEntities() provides the total count of ShoppingAdGroups matched by the selector, but this may exceed the actual iterable items due to limits.

 An iterator of shopping ad groups.

Typical usage: 

while (shoppingAdGroupIterator.hasNext()) {
  var shoppingAdGroup = shoppingAdGroupIterator.next();
}
 Related:

Methods:

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

Return values:

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