AdsApp.​ShoppingAdGroupAudienceIterator

  • This iterator provides access to a collection of ShoppingAdGroupAudience objects, allowing you to process them sequentially.

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

  • You can iterate through the Shopping audiences using a while loop, accessing each ShoppingAdGroupAudience in turn.

  • The total number of entities returned by totalNumEntities() may exceed the actual number of iterable elements due to system limits.

 An iterator of shopping audiences.

Typical usage: 

while (shoppingAudienceIterator.hasNext()) {
  var shoppingAudience = shoppingAudienceIterator.next();
}
 Related:

Methods:

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

Return values:

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