AdsApp.​SearchCampaignExcludedAudienceIterator

  • An iterator provides access to excluded audiences from a Search Campaign Excluded Audience Selector.

  • It allows you to iterate through each excluded audience using hasNext() and next().

  • totalNumEntities() shows the total count of excluded audiences matched by the selector, but iteration might stop earlier due to entity read limits.

  • Related methods include SearchCampaignExcludedAudienceSelector.get() to retrieve the selector and SearchCampaignExcludedAudience representing an individual excluded audience.

 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.SearchCampaignExcludedAudience Returns the next SearchCampaignExcludedAudience 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 SearchCampaignExcludedAudience in the iterator.

Return values:

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