AdsApp.​AdGroupSitelinkIterator

  • This iterator allows you to iterate through ad group-level sitelinks.

  • It provides methods to check if more sitelinks exist (hasNext()), retrieve the next sitelink (next()), and get the total count of matched sitelinks (totalNumEntities()).

  • Use this iterator with a while loop to process each AdGroupSitelink object individually.

  • Refer to the AdGroupSitelinkSelector.get() documentation for creating the initial selector to fetch sitelinks.

 An iterator of ad group-level sitelinks.

Typical usage: 

while (adGroupSitelinkIterator.hasNext()) {
  var adGroupSitelink = adGroupSitelinkIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.AdGroupSitelink Returns the next AdGroupSitelink 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 AdGroupSitelink in the iterator.

Return values:

TypeDescription
AdsApp.AdGroupSitelink The next AdGroupSitelink 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.