AdsApp.​SearchCampaignAudienceIterator

  • SearchCampaignAudienceIterator is an iterator used to retrieve audiences.

  • The hasNext() method checks if there are more elements in the iterator, and the next() method returns the subsequent SearchCampaignAudience.

  • The totalNumEntities() method provides the total count of entities matched by the selector that created the iterator, regardless of any 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.SearchCampaignAudience Returns the next SearchCampaignAudience 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 SearchCampaignAudience in the iterator.

Return values:

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