AdsApp.​CampaignPriceIterator

  • The CampaignPriceIterator allows you to iterate through campaign-level prices.

  • Use hasNext() and next() to access each CampaignPrice object in the iterator.

  • totalNumEntities() provides the total count of entities matched by the selector, but the iterator might not contain all of them due to entity read limits.

 An iterator of campaign-level prices.

Typical usage: 

while (campaignPriceIterator.hasNext()) {
  var campaignPrice = campaignPriceIterator.next();
}
 Related:

Methods:

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

Return values:

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