AdsApp.​AccountSitelinkIterator

  • This content describes an iterator for account-level sitelinks, allowing you to loop through and access multiple account sitelinks.

  • The hasNext() method checks if there are more account sitelinks to iterate through, returning true if there are, and false otherwise.

  • The next() method retrieves the next AccountSitelink in the sequence.

  • The totalNumEntities() method reveals the total number of account sitelinks that were matched by the original selector, which is irrespective of imposed entity limits.

  • Example code is provided which demonstrate how to iterate over the accountSitelinkIterator to access all elements.

 An iterator of account-level sitelinks.

Typical usage: 

while (accountSitelinkIterator.hasNext()) {
  var accountSitelink = accountSitelinkIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.AccountSitelink Returns the next AccountSitelink in the iterator.
totalNumEntities() int Returns the total number of entities matched by the selector which generated this iterator.

hasNext()

Returns true if the iterator has more elements.

Return values:

TypeDescription
boolean true if the iterator has more elements.

next()

Returns the next AccountSitelink in the iterator.

Return values:

TypeDescription
AdsApp.AccountSitelink The next AccountSitelink in the iterator.

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:

TypeDescription
int The number of entities matched by the selector which generated this iterator.