Returns all rows that match the search query.
List of thrown errors: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
HTTP request
POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:search
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
customerId |
Required. The ID of the customer being queried. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"query": string,
"pageToken": string,
"pageSize": integer,
"validateOnly": boolean,
"returnTotalResultsCount": boolean,
"summaryRowSetting": enum ( |
Fields | |
---|---|
query |
Required. The query string. |
pageToken |
Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from |
pageSize |
Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources. |
validateOnly |
If true, the request is validated but not executed. |
returnTotalResultsCount |
If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false. |
summaryRowSetting |
Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned. |
Response body
Response message for GoogleAdsService.Search
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "results": [ { object ( |
Fields | |
---|---|
results[] |
The list of rows that matched the query. |
nextPageToken |
Pagination token used to retrieve the next page of results. Pass the content of this string as the |
totalResultsCount |
Total number of results that match the query ignoring the LIMIT clause. |
fieldMask |
FieldMask that represents what fields were requested by the user. This is a comma-separated list of fully qualified names of fields. Example: |
summaryRow |
Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc. |
queryResourceConsumption |
The amount of resources consumed to serve the query. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adwords
For more information, see the OAuth 2.0 Overview.