AdsApp.​ShoppingCampaignIterator

  • ShoppingCampaignIterator allows you to iterate through a collection of shopping campaigns.

  • It provides methods like hasNext(), next(), and totalNumEntities() to navigate and access campaign data.

  • hasNext() checks if there are more campaigns to iterate, next() returns the next campaign, and totalNumEntities() provides the total count of matched campaigns.

  • This iterator is typically used with a while loop to process each shopping campaign individually.

 An iterator of shopping campaigns.

Typical usage: 

while (shoppingCampaignIterator.hasNext()) {
  var shoppingCampaign = shoppingCampaignIterator.next();
}
 Related:

Methods:

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

Return values:

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