AdsApp.​AdGroupPriceIterator

  • Provides an iterator for ad group-level prices.

  • Includes methods to check for the next element (hasNext), retrieve the next element (next), and get the total number of matched entities (totalNumEntities).

  • The totalNumEntities method returns the total matched entities but doesn't guarantee the iterator will have that many elements due to limits.

 An iterator of ad group-level prices.

Typical usage: 

while (adGroupPriceIterator.hasNext()) {
  var adGroupPrice = adGroupPriceIterator.next();
}
 Related:

Methods:

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

Return values:

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