AdsApp.CalloutIterator
Stay organized with collections
Save and categorize content based on your preferences.
An iterator of callouts.
Typical usage:
while (calloutIterator.hasNext()) {
var callout = calloutIterator.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
Callout 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-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eProvides a way to iterate through callouts, which are snippets of text that can be added to ads.\u003c/p\u003e\n"],["\u003cp\u003eOffers methods like \u003ccode\u003ehasNext()\u003c/code\u003e, \u003ccode\u003enext()\u003c/code\u003e, and \u003ccode\u003etotalNumEntities()\u003c/code\u003e to navigate and utilize callout data.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ehasNext()\u003c/code\u003e checks for more elements, \u003ccode\u003enext()\u003c/code\u003e retrieves the next callout, and \u003ccode\u003etotalNumEntities()\u003c/code\u003e reveals the total matched entities.\u003c/p\u003e\n"],["\u003cp\u003eCan be used to access and process callouts obtained via a \u003ccode\u003eCalloutSelector\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["An iterator of callouts.\n\nTypical usage:\n\n```gdscript\nwhile (calloutIterator.hasNext()) {\n var callout = calloutIterator.next();\n}\n```\nRelated:\n\n- [CalloutSelector.get()](/google-ads/scripts/docs/reference/adsapp/adsapp_calloutselector#get_0)\n- [Callout](/google-ads/scripts/docs/reference/adsapp/adsapp_callout)\n\nMethods:\n\n| Member | Type | Description |\n|-----------------------------------------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|\n| [hasNext](#hasNext_0) | `boolean` | Returns `true` if the iterator has more elements. |\n| [next](#next_0) | [AdsApp.Callout](/google-ads/scripts/docs/reference/adsapp/adsapp_callout) | Returns the next [Callout](/google-ads/scripts/docs/reference/adsapp/adsapp_callout) in the iterator. |\n| [totalNumEntities](#totalNumEntities_0) | `int` | Returns the total number of entities matched by the selector which generated this iterator. |\n\n`hasNext()` Returns `true` if the iterator has more elements.\n\nReturn values:\n\n| Type | Description |\n|-----------|-------------------------------------------|\n| `boolean` | `true` if the iterator has more elements. |\n\n`next()` Returns the next [Callout](/google-ads/scripts/docs/reference/adsapp/adsapp_callout) in the iterator.\n\nReturn values:\n\n| Type | Description |\n|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|\n| [AdsApp.Callout](/google-ads/scripts/docs/reference/adsapp/adsapp_callout) | The next [Callout](/google-ads/scripts/docs/reference/adsapp/adsapp_callout) in the iterator. |\n\n`totalNumEntities()` Returns 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\nReturn values:\n\n| Type | Description |\n|-------|-------------------------------------------------------------------------------|\n| `int` | The number of entities matched by the selector which generated this iterator. |"]]
