Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.googleAds.search

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/v7/customers/{customerId}/googleAds:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

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 (SummaryRowSetting)
}
Fields
query

string

Required. The query string.

pageToken

string

Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from nextPageToken in the previous response in order to request the next page of results.

pageSize

integer

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

boolean

If true, the request is validated but not executed.

returnTotalResultsCount

boolean

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

enum (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

If successful, the response body contains data with the following structure:

Response message for GoogleAdsService.Search.

JSON representation
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  }
}
Fields
results[]

object (GoogleAdsRow)

The list of rows that matched the query.

nextPageToken

string

Pagination token used to retrieve the next page of results. Pass the content of this string as the pageToken attribute of the next request. nextPageToken is not returned for the last page.

totalResultsCount

string (int64 format)

Total number of results that match the query ignoring the LIMIT clause.

fieldMask

string (FieldMask format)

FieldMask that represents what fields were requested by the user.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

summaryRow

object (GoogleAdsRow)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.