AdsApp.​SharedExcludedPlacementIterator

  • SharedExcludedPlacementIterator allows iteration through shared excluded placements, which are locations 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 this iterator to review or manage shared excluded placements in your Google Ads campaigns.

  • The iterator might not contain all matched entities if entity read limits are reached.

 An iterator of shared excluded placements.

Typical usage: 

while (sharedExcludedPlacementIterator.hasNext()) {
  var sharedExcludedPlacement = sharedExcludedPlacementIterator.next();
}
 Related:

Methods:

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

Return values:

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