AdsApp.SearchCampaignExcludedAudienceIterator
Stay organized with collections
Save and categorize content based on your preferences.
An iterator of excluded audiences.
Typical usage:
while (excludedAudienceIterator.hasNext()) {
var excludedAudience = excludedAudienceIterator.next();
}
Related:
Methods:
hasNext()
Returns
true if the iterator has more elements.
Return values:
| Type | Description |
|---|
boolean |
true if the iterator has more elements. |
next()
Returns the next
SearchCampaignExcludedAudience in the iterator.
Return values:
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:
| Type | Description |
|---|
int |
The number of entities matched by the selector which generated this
iterator. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-25 UTC.
[null,null,["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eAn iterator provides access to excluded audiences from a Search Campaign Excluded Audience Selector.\u003c/p\u003e\n"],["\u003cp\u003eIt allows you to iterate through each excluded audience using \u003ccode\u003ehasNext()\u003c/code\u003e and \u003ccode\u003enext()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003etotalNumEntities()\u003c/code\u003e shows the total count of excluded audiences matched by the selector, but iteration might stop earlier due to entity read limits.\u003c/p\u003e\n"],["\u003cp\u003eRelated methods include \u003ccode\u003eSearchCampaignExcludedAudienceSelector.get()\u003c/code\u003e to retrieve the selector and \u003ccode\u003eSearchCampaignExcludedAudience\u003c/code\u003e representing an individual excluded audience.\u003c/p\u003e\n"]]],[],null,["# AdsApp.SearchCampaignExcludedAudienceIterator\n\nAn iterator of excluded audiences.\n\nTypical usage:\n\n```gdscript\nwhile (excludedAudienceIterator.hasNext()) {\n var excludedAudience = excludedAudienceIterator.next();\n}\n```\nRelated:\n\n- [SearchCampaignExcludedAudienceSelector.get()](/google-ads/scripts/docs/reference/adsapp/adsapp_searchcampaignexcludedaudienceselector#get)\n- [SearchCampaignExcludedAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_searchcampaignexcludedaudience)\n\n### Methods:\n\n| Member | Type | Description |\n|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| [hasNext()](#hasNext) | `boolean` | Returns `true` if the iterator has more elements. |\n| [next()](#next) | [AdsApp.SearchCampaignExcludedAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_searchcampaignexcludedaudience) | Returns the next [SearchCampaignExcludedAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_searchcampaignexcludedaudience) in the iterator. |\n| [totalNumEntities()](#totalNumEntities) | `int` | Returns the total number of entities matched by the selector which generated this iterator. |\n\n`hasNext()`\n-----------\n\nReturns `true` if the iterator has more elements.\n\n### Return values:\n\n| Type | Description |\n|-----------|-------------------------------------------|\n| `boolean` | `true` if the iterator has more elements. |\n\n`next()`\n--------\n\nReturns the next [SearchCampaignExcludedAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_searchcampaignexcludedaudience) in the iterator.\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| [AdsApp.SearchCampaignExcludedAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_searchcampaignexcludedaudience) | The next [SearchCampaignExcludedAudience](/google-ads/scripts/docs/reference/adsapp/adsapp_searchcampaignexcludedaudience) in the iterator. |\n\n`totalNumEntities()`\n--------------------\n\nReturns the total number of entities matched by the selector which generated this iterator.\n\nNote that the returned number disregards limits, and that the iterator\nis not guaranteed to have this many elements --- `hasNext` will\nstart to return `false` and `next` will start to\nthrow exceptions as soon as the limit for entity reads has been reached,\neven if the selector matched more entities.\n\n### Return values:\n\n| Type | Description |\n|-------|-------------------------------------------------------------------------------|\n| `int` | The number of entities matched by the selector which generated this iterator. |"]]
