AdsApp.​TargetedProximityIterator

  • TargetedProximityIterator allows iteration through targeted proximities, which are geographical locations used for ad targeting.

  • It provides methods like hasNext(), next(), and totalNumEntities() to navigate and access these targeted proximities.

  • hasNext() checks for more elements, next() retrieves the next TargetedProximity, and totalNumEntities() reveals the total matching entities.

  • Users can utilize this iterator to programmatically access and manage targeted proximity settings in their Google Ads campaigns.

 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.