An iterator of search rows.
Typical usage:
while (searchRowIterator.hasNext()) {
var searchRow = searchRowIterator.next();
}
Related:
SearchRow
Methods:
Member | Type | Description |
hasNext |
boolean |
Returns true if the iterator has more elements. |
next |
AdsApp.SearchRow |
Returns the next SearchRow 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:
Type | Description |
boolean |
true if the iterator has more elements. |
next()
Returns the next
SearchRow in the iterator.
Search rows are returned as plain Javascript objects. Individual
requested fields can be accessed by accessing the nested field.
var rows = AdsApp.search(
'SELECT search_term_view.search_term, metrics.ctr ' +
'FROM search_term_view ' +
'WHERE segments.date BETWEEN "2013-01-01" AND "2013-03-01"');
while (rows.hasNext()) {
var row = rows.next();
var searchTerm = row.search_term_view;
var query = searchTerm.search_term;
var ctr = row.metrics.ctr.;
}
Return values:
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. |