AdsApp.​ReportRowIterator

AI-generated Key Takeaways

outlined_flag

• A ReportRowIterator is used to iterate through report rows.

• The hasNext() method checks if there are more elements in the iterator.

• The next() method returns the subsequent ReportRow in the sequence.

• The totalNumEntities() method provides the total number of entities matched by the selector that created the iterator, irrespective of limits.

Typical usage:

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

Methods:

hasNext()

Return values:

next()

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:

totalNumEntities()

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: