Page Summary
-
CampaignIterator is an iterator that provides access to campaigns.
-
The
hasNext()method checks if there are more campaigns to iterate through. -
The
next()method returns the subsequent campaign in the iteration. -
The
totalNumEntities()method indicates the total number of entities matched by the selector that created the iterator, disregarding any limits.
Typical usage:
while ( campaignIterator . hasNext ()) { var campaign = campaignIterator . next (); }
Methods:
| Member | Type | Description |
|---|---|---|
boolean
|
Returns true
if the iterator has more elements. |
|
AdsApp.Campaign
|
Returns the next Campaign in the iterator. | |
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:
| Type | Description |
|---|---|
boolean
|
true
if the iterator has more elements. |
next()
Returns the next Campaign
in the iterator. Return values:
| Type | Description |
|---|---|
AdsApp.Campaign
|
The next Campaign 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:
| Type | Description |
|---|---|
int
|
The number of entities matched by the selector which generated this iterator. |
