AdsApp.​ReportRowIterator

Stay organized with collections Save and categorize content based on your preferences.
An iterator of report rows.

Typical usage:

 while (reportRowIterator.hasNext()) {
   var reportRow = reportRowIterator.next();
 }
Related: ReportRow

Methods:

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

Report rows are returned as plain Javascript objects — in other words, associative arrays. Individual columns can be accessed by indexing by AWQL column names:

 var report = AdsApp.report(
     'SELECT search_term_view.search_term, metrics.ctr ' +
     'FROM   search_term_view ' +
     'WHERE segments.date BETWEEN "2013-01-01" AND "2013-03-01"');
 var rows = report.rows();

 while (rows.hasNext()) {
   var row = rows.next();
   var query = row['search_term_view.search_term'];
   var ctr = row['metrics.ctr'];
 }

Return values:

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