AdsApp.ExcludedLocationIterator
Stay organized with collections
Save and categorize content based on your preferences.
An iterator of excluded locations.
Typical usage:
while (excludedLocationIterator.hasNext()) {
var excludedLocation = excludedLocationIterator.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
ExcludedLocation 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\u003eThis iterator helps you access excluded locations one by one.\u003c/p\u003e\n"],["\u003cp\u003eYou can use \u003ccode\u003ehasNext()\u003c/code\u003e to check for more locations and \u003ccode\u003enext()\u003c/code\u003e to get the next ExcludedLocation object.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003etotalNumEntities()\u003c/code\u003e gives you the total count of excluded locations matched by the selector, but it might exceed the actual iterable elements due to entity read limits.\u003c/p\u003e\n"]]],[],null,["# AdsApp.ExcludedLocationIterator\n\nAn iterator of excluded locations.\n\nTypical usage:\n\n```gdscript\nwhile (excludedLocationIterator.hasNext()) {\n var excludedLocation = excludedLocationIterator.next();\n}\n```\nRelated:\n\n- [ExcludedLocationSelector.get()](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocationselector#get)\n- [ExcludedLocation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation)\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.ExcludedLocation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation) | Returns the next [ExcludedLocation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation) 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 [ExcludedLocation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation) in the iterator.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|\n| [AdsApp.ExcludedLocation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation) | The next [ExcludedLocation](/google-ads/scripts/docs/reference/adsapp/adsapp_excludedlocation) 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. |"]]
