AdsApp.​ShoppingAdGroupIterator

  • ShoppingAdGroupIterator provides an iterator for shopping ad groups.

  • The hasNext() method returns true if there are more elements to iterate through.

  • The next() method returns the subsequent ShoppingAdGroup in the iteration.

  • The totalNumEntities() method provides the count of entities that matched the selector that generated the iterator.

 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.