AdsApp.​CampaignPhoneNumberIterator

  • This iterator provides access to campaign-level phone numbers, allowing you to iterate through them using the hasNext() and next() methods.

  • hasNext() indicates if there are more phone numbers to iterate through, returning true if more elements exist.

  • next() returns the next CampaignPhoneNumber object in the iterator, providing access to its properties and methods.

  • totalNumEntities() returns the total number of phone numbers matched by the selector that created the iterator, which may exceed the actual number of iterable elements due to limits.

An iterator of campaign-level phone numbers.

Typical usage:

while (campaignPhoneNumberIterator.hasNext()) {
  var campaignPhoneNumber = campaignPhoneNumberIterator.next();
}
Related:

Methods:

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

Return values:

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