AdsApp.​TargetedLocationIterator

  • TargetedLocationIterator allows iteration through targeted locations retrieved by a selector.

  • It provides methods to check for more elements (hasNext), retrieve the next element (next), and get the total count (totalNumEntities).

  • next() returns a TargetedLocation object representing the location information.

  • The total number of entities returned by totalNumEntities() may exceed the iterator's accessible elements due to limits.

 An iterator of targeted locations.

Typical usage: 

while (targetedLocationIterator.hasNext()) {
  var targetedLocation = targetedLocationIterator.next();
}
 Related:

Methods:

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

Return values:

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