AdsApp.​CampaignCalloutIterator

  • Represents an iterator specifically designed for campaign-level callouts, enabling traversal through a collection of these callouts.

  • Provides methods like hasNext() and next() to navigate and access individual CampaignCallout objects within the iterator.

  • Includes totalNumEntities() which reveals the total count of callouts matched by the selector that originated this iterator, irrespective of any imposed limits.

  • Offers convenient integration with CampaignCalloutSelector for retrieving and iterating over campaign callouts efficiently.

 An iterator of campaign-level callouts.

Typical usage: 

while (campaignCalloutIterator.hasNext()) {
  var campaignCallout = campaignCalloutIterator.next();
}
 Related:

Methods:

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

Return values:

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