AdsApp.​ExcludedVideoPlacementIterator

  • ExcludedVideoPlacementIterator allows iteration through excluded video placements, which are specific videos or channels where ads won't be shown.

  • It provides methods like hasNext() to check for more placements, next() to retrieve the next placement, and totalNumEntities() to get the total count of matched placements.

  • You can use it to programmatically access and manage the video placements that have been excluded from your ad campaigns.

  • This iterator is typically obtained through an ExcludedVideoPlacementSelector, which defines the criteria for selecting excluded placements.

 An iterator of excluded video placements.

Typical usage: 

while (excludedVideoPlacementIterator.hasNext()) {
  var excludedVideoPlacement = excludedVideoPlacementIterator.next();
}
 Related:

Methods:

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

Return values:

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