AdsApp.​CampaignIterator

An iterator of campaigns.

Typical usage:

while (campaignIterator.hasNext()) {
  var campaign = campaignIterator.next();
}
Related:

Methods:

MemberTypeDescription
hasNextbooleanReturns true if the iterator has more elements.
nextAdsApp.CampaignReturns the next Campaign in the iterator.
totalNumEntitiesintReturns 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
booleantrue if the iterator has more elements.

next()

Returns the next Campaign in the iterator.

Return values:

TypeDescription
AdsApp.CampaignThe next Campaign 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
intThe number of entities matched by the selector which generated this iterator.