AdsApp.TargetedProximityIterator
Stay organized with collections
Save and categorize content based on your preferences.
An iterator of targeted proximities.
Typical usage:
while (targetedProximityIterator.hasNext()) {
var targetedProximity = targetedProximityIterator.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
TargetedProximity 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\u003e\u003ccode\u003eTargetedProximityIterator\u003c/code\u003e allows iteration through targeted proximities, which are geographical locations used for ad targeting.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods like \u003ccode\u003ehasNext()\u003c/code\u003e, \u003ccode\u003enext()\u003c/code\u003e, and \u003ccode\u003etotalNumEntities()\u003c/code\u003e to navigate and access these targeted proximities.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ehasNext()\u003c/code\u003e checks for more elements, \u003ccode\u003enext()\u003c/code\u003e retrieves the next \u003ccode\u003eTargetedProximity\u003c/code\u003e, and \u003ccode\u003etotalNumEntities()\u003c/code\u003e reveals the total matching entities.\u003c/p\u003e\n"],["\u003cp\u003eUsers can utilize this iterator to programmatically access and manage targeted proximity settings in their Google Ads campaigns.\u003c/p\u003e\n"]]],[],null,["# AdsApp.TargetedProximityIterator\n\nAn iterator of targeted proximities.\n\nTypical usage:\n\n```gdscript\nwhile (targetedProximityIterator.hasNext()) {\n var targetedProximity = targetedProximityIterator.next();\n}\n```\nRelated:\n\n- [TargetedProximitySelector.get()](/google-ads/scripts/docs/reference/adsapp/adsapp_targetedproximityselector#get)\n- [TargetedProximity](/google-ads/scripts/docs/reference/adsapp/adsapp_targetedproximity)\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.TargetedProximity](/google-ads/scripts/docs/reference/adsapp/adsapp_targetedproximity) | Returns the next [TargetedProximity](/google-ads/scripts/docs/reference/adsapp/adsapp_targetedproximity) 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 [TargetedProximity](/google-ads/scripts/docs/reference/adsapp/adsapp_targetedproximity) in the iterator.\n\n### Return values:\n\n| Type | Description |\n|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|\n| [AdsApp.TargetedProximity](/google-ads/scripts/docs/reference/adsapp/adsapp_targetedproximity) | The next [TargetedProximity](/google-ads/scripts/docs/reference/adsapp/adsapp_targetedproximity) 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. |"]]