SearchGoogleAdsRequest
Stay organized with collections
Save and categorize content based on your preferences.
| Fields |
customer_id
|
string
Required. The ID of the customer being queried.
|
query
|
string
Required. The query string.
|
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.
|
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.
|
validate_only
|
bool
If true, the request is validated but not executed.
|
return_total_results_count
|
bool
If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false.
|
summary_row_setting
|
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.
|
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-01-10 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-01-10 UTC."],[[["This page details the `GoogleAdsService.Search` request, used to retrieve data from the Google Ads API."],["The request requires `customer_id` and `query` fields to specify the target account and the data to fetch."],["Optional parameters like `page_token` and `page_size` allow for pagination and controlling the number of results per page."],["The `validate_only` parameter offers a way to test the request's validity without actually executing it."],["Requesting `return_total_results_count` or setting a `summary_row_setting` gives additional metrics and summarized insights."]]],[]]
