SearchGoogleAdsRequest

  • The GoogleAdsService.Search request message requires customer_id and query fields.

  • The page_token field is used for retrieving subsequent pages of results.

  • The page_size field is deprecated and will cause an error if set.

  • The validate_only field allows validating the request without execution.

  • The search_settings field allows specifying request count, summary row, and results behavior.

Request message for GoogleAdsService.Search.

Proto definition GitHub

Fields

customer_id

string

Required. The ID of the customer being queried.

page_size

int32

This field is deprecated and will be removed in a future version of the API. As of v17, Google Ads API will return a PAGE_SIZE_NOT_SUPPORTED error if this field is set in the request body. See https://ads-developers.googleblog.com/2024/07/upcoming-changes-to-page-size-in-google.html to learn more details.

page_token

string

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

query

string

Required. The query string.

search_settings

SearchSettings

Settings that allow users to specify request count, summary row, and results behavior.

validate_only

bool

If true, the request is validated but not executed.