AdsApp.​PlacementIterator

  • PlacementIterator allows you to iterate through a list of placements, typically obtained using a PlacementSelector.

  • You can access each placement using the next() method while checking for more placements with hasNext().

  • The totalNumEntities() method provides the total count of placements matched by the selector, which may exceed the iterator's accessible elements due to limits.

 An iterator of placements.

Typical usage: 

while (placementIterator.hasNext()) {
  var placement = placementIterator.next();
}
 Related:

Methods:

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

Return values:

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