AdsApp.​ShoppingCampaignAudienceIterator

  • Provides a way to iterate through Shopping audiences, allowing you to access each audience individually.

  • Offers methods like hasNext() to check for more audiences, next() to retrieve the next audience, and totalNumEntities() to get the total count.

  • Works in conjunction with ShoppingCampaignAudienceSelector to define the desired audience set for iteration.

  • Useful for tasks requiring programmatic access to and manipulation of Shopping campaign audiences.

 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.ShoppingCampaignAudience Returns the next ShoppingCampaignAudience 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 ShoppingCampaignAudience in the iterator.

Return values:

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