AdsApp.​VideoPlacementIterator

  • The VideoPlacementIterator allows you to iterate through a collection of video placements, typically obtained using a VideoPlacementSelector.

  • You can use the hasNext() method to check if there are more placements to iterate over and next() to retrieve the next placement.

  • The totalNumEntities() method provides the total number of placements matched by the selector, but it's important to note that iteration might stop before reaching this number due to entity read limits.

 An iterator of video 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.VideoPlacement Returns the next VideoPlacement 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 VideoPlacement in the iterator.

Return values:

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