AdsApp.​ExperimentIterator

  • An ExperimentIterator allows you to iterate through a collection of Experiments.

  • Use hasNext() to check if there are more Experiments and next() to retrieve the next Experiment in the iteration.

  • totalNumEntities() provides the total count of Experiments matched by the selector, but it may exceed the actual number of iterable elements due to limits.

 An iterator of experiments.

Typical usage: 

while (experimentIterator.hasNext()) {
  var experiment = experimentIterator.next();
}
 Related:

Methods:

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

Return values:

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