AdsApp.​SearchAdGroupExcludedAudienceIterator

  • Provides an iterator to access excluded audiences for search ad groups.

  • Use hasNext() and next() to iterate through excluded audiences.

  • totalNumEntities() reveals the total count of matched entities, potentially exceeding the iterator's accessible elements due to limits.

  • Related functionalities include retrieving specific excluded audiences and selectors.

 An iterator of excluded audiences.

Typical usage: 

while (excludedAudienceIterator.hasNext()) {
  var excludedAudience = excludedAudienceIterator.next();
}
 Related:

Methods:

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

Return values:

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