AdsApp.​SearchAdGroupAudienceIterator

  • The SearchAdGroupAudienceIterator is used to iterate over audiences.

  • It provides methods to check if there are more elements (hasNext()), get the next element (next()), and find the total number of matched entities (totalNumEntities()).

  • The hasNext() method returns a boolean, while next() returns a SearchAdGroupAudience object.

  • The totalNumEntities() method returns an integer representing the count of matched entities, independent of iteration limits.

 An iterator of audiences.

Typical usage: 

while (audienceIterator.hasNext()) {
  var audience = audienceIterator.next();
}
 Related:

Methods:

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

Return values:

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