AdsApp.​VideoCampaignIterator

  • VideoCampaignIterator iterates through video campaigns.

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

  • The hasNext() method returns a boolean indicating if there are more elements.

  • The next() method returns the next VideoCampaign object.

  • The totalNumEntities() method returns the total count of matched entities, which might be different from the number of elements the iterator can provide due to limits.

 An iterator of video campaigns.

Typical usage: 

while (videoCampaignIterator.hasNext()) {
  var videoCampaign = videoCampaignIterator.next();
}
 Related:

Methods:

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

Return values:

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