AdsApp.SearchRowIterator
Stay organized with collections
Save and categorize content based on your preferences.
An iterator of search rows. Typical usage:
while
(
searchRowIterator
.
hasNext
())
{
var
searchRow
=
searchRowIterator
.
next
();
}
Related: SearchRow
Methods:
hasNext()
Returns true
if the iterator has more elements. Return values:
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:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eSearchRowIterator allows you to iterate through search results retrieved using the \u003ccode\u003eAdsApp.search()\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods like \u003ccode\u003ehasNext()\u003c/code\u003e, \u003ccode\u003enext()\u003c/code\u003e, and \u003ccode\u003etotalNumEntities()\u003c/code\u003e to navigate and process search data.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003enext()\u003c/code\u003e returns a SearchRow object containing the requested fields, accessible via nested properties.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003etotalNumEntities()\u003c/code\u003e provides the total count of matched entities, which may exceed the actual iterable results due to limits.\u003c/p\u003e\n"]]],[],null,["# AdsApp.SearchRowIterator\n\nAn iterator of search rows.\n\nTypical usage:\n\n```gdscript\nwhile (searchRowIterator.hasNext()) {\n var searchRow = searchRowIterator.next();\n}\n```\nRelated: [SearchRow](/google-ads/scripts/docs/reference/adsapp/adsapp_searchrow)\n\n### Methods:\n\n| Member | Type | Description |\n|-----------------------------------------|--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|\n| [hasNext()](#hasNext) | `boolean` | Returns `true` if the iterator has more elements. |\n| [next()](#next) | [AdsApp.SearchRow](/google-ads/scripts/docs/reference/adsapp/adsapp_searchrow) | Returns the next [SearchRow](/google-ads/scripts/docs/reference/adsapp/adsapp_searchrow) in the iterator. |\n| [totalNumEntities()](#totalNumEntities) | `int` | Returns the total number of entities matched by the selector which generated this iterator. |\n\n`hasNext()`\n-----------\n\nReturns `true` if the iterator has more elements.\n\n### Return values:\n\n| Type | Description |\n|-----------|-------------------------------------------|\n| `boolean` | `true` if the iterator has more elements. |\n\n`next()`\n--------\n\nReturns the next [SearchRow](/google-ads/scripts/docs/reference/adsapp/adsapp_searchrow) in the iterator.\n\nSearch rows are returned as plain Javascript objects. Individual\nrequested fields can be accessed by accessing the nested field.\n\n```gdscript\nvar rows = AdsApp.search(\n 'SELECT search_term_view.search_term, metrics.ctr ' +\n 'FROM search_term_view ' +\n 'WHERE segments.date BETWEEN \"2013-01-01\" AND \"2013-03-01\"');\n\nwhile (rows.hasNext()) {\n var row = rows.next();\n var searchTerm = row.search_term_view;\n var query = searchTerm.search_term;\n var ctr = row.metrics.ctr.;\n}\n```\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|\n| [AdsApp.SearchRow](/google-ads/scripts/docs/reference/adsapp/adsapp_searchrow) | The next [SearchRow](/google-ads/scripts/docs/reference/adsapp/adsapp_searchrow) in the iterator. |\n\n`totalNumEntities()`\n--------------------\n\nReturns the total number of entities matched by the selector which generated this iterator.\n\nNote that the returned number disregards limits, and that the iterator\nis not guaranteed to have this many elements --- `hasNext` will\nstart to return `false` and `next` will start to\nthrow exceptions as soon as the limit for entity reads has been reached,\neven if the selector matched more entities.\n\n### Return values:\n\n| Type | Description |\n|-------|-------------------------------------------------------------------------------|\n| `int` | The number of entities matched by the selector which generated this iterator. |"]]
