AdsApp.​ExcludedPlacementIterator

  • Provides a way to iterate through excluded placements, which are specific websites or apps where ads should not be shown.

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

  • Can be used to programmatically review or manage excluded placements in your Google Ads campaigns.

  • The iterator may not contain all matched entities if limits on entity reads are reached.

 An iterator of excluded placements.

Typical usage: 

while (excludedPlacementIterator.hasNext()) {
  var excludedPlacement = excludedPlacementIterator.next();
}
 Related:

Methods:

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

Return values:

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