AdsApp.AccountSitelinkIterator
Stay organized with collections
Save and categorize content based on your preferences.
An iterator of account-level sitelinks.
Typical usage:
while (accountSitelinkIterator.hasNext()) {
var accountSitelink = accountSitelinkIterator.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
AccountSitelink 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 content describes an iterator for account-level sitelinks, allowing you to loop through and access multiple account sitelinks.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ehasNext()\u003c/code\u003e method checks if there are more account sitelinks to iterate through, returning \u003ccode\u003etrue\u003c/code\u003e if there are, and \u003ccode\u003efalse\u003c/code\u003e otherwise.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003enext()\u003c/code\u003e method retrieves the next \u003ccode\u003eAccountSitelink\u003c/code\u003e in the sequence.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etotalNumEntities()\u003c/code\u003e method reveals the total number of account sitelinks that were matched by the original selector, which is irrespective of imposed entity limits.\u003c/p\u003e\n"],["\u003cp\u003eExample code is provided which demonstrate how to iterate over the \u003ccode\u003eaccountSitelinkIterator\u003c/code\u003e to access all elements.\u003c/p\u003e\n"]]],[],null,["# AdsApp.AccountSitelinkIterator\n\nAn iterator of account-level sitelinks.\n\nTypical usage:\n\n```gdscript\nwhile (accountSitelinkIterator.hasNext()) {\n var accountSitelink = accountSitelinkIterator.next();\n}\n```\nRelated:\n\n- [AccountSitelinkSelector.get()](/google-ads/scripts/docs/reference/adsapp/adsapp_accountsitelinkselector#get)\n- [AccountSitelink](/google-ads/scripts/docs/reference/adsapp/adsapp_accountsitelink)\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.AccountSitelink](/google-ads/scripts/docs/reference/adsapp/adsapp_accountsitelink) | Returns the next [AccountSitelink](/google-ads/scripts/docs/reference/adsapp/adsapp_accountsitelink) 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 [AccountSitelink](/google-ads/scripts/docs/reference/adsapp/adsapp_accountsitelink) in the iterator.\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|\n| [AdsApp.AccountSitelink](/google-ads/scripts/docs/reference/adsapp/adsapp_accountsitelink) | The next [AccountSitelink](/google-ads/scripts/docs/reference/adsapp/adsapp_accountsitelink) 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. |"]]
