AdsApp.​TargetedProximityIterator

  • The TargetedProximityIterator is used to iterate over targeted proximities.

  • It has methods to check if there are more elements (hasNext), get the next element (next), and find the total number of matched entities (totalNumEntities).

  • The totalNumEntities method returns the total matched count, which may exceed the number of elements the iterator can return due to limits.

 An iterator of targeted proximities.

Typical usage: 

while (targetedProximityIterator.hasNext()) {
  var targetedProximity = targetedProximityIterator.next();
}
 Related:

Methods:

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

Return values:

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