Interested in sharing your feedback about the Google Ads API?
Sign up to be invited to participate in user research!
GenerateKeywordHistoricalMetricsRequest
Stay organized with collections
Save and categorize content based on your preferences.
| Fields |
customer_id
|
string
The ID of the customer with the recommendation.
|
keywords[]
|
string
A list of keywords to get historical metrics. Not all inputs will be returned as a result of near-exact deduplication. For example, if stats for "car" and "cars" are requested, only "car" will be returned. A maximum of 10,000 keywords can be used.
|
include_adult_keywords
|
bool
If true, adult keywords will be included in response. The default value is false.
|
geo_target_constants[]
|
string
The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.
|
keyword_plan_network
|
KeywordPlanNetwork
Targeting network. If not set, Google Search And Partners Network will be used.
|
aggregate_metrics
|
KeywordPlanAggregateMetrics
The aggregate fields to include in response.
|
historical_metrics_options
|
HistoricalMetricsOptions
The options for historical metrics data.
|
language
|
string
The resource name of the language to target. Each keyword belongs to some set of languages; a keyword is included if language is one of its languages. If not set, all keywords will be included.
|
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-02-25 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-02-25 UTC."],[[["The `GenerateKeywordHistoricalMetrics` request retrieves historical metrics for a list of keywords, allowing analysis of their past performance."],["You can specify targeting criteria like location, network, and language to refine the data retrieved for your keywords."],["The request allows customization of the metrics received, including aggregated data and options for historical data retrieval."],["While supporting up to 10,000 keywords, the service may deduplicate similar terms (like \"car\" and \"cars\") to provide concise results."],["Adult keywords can optionally be included in the response by setting the `include_adult_keywords` field to true."]]],["The request message `KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics` retrieves historical metrics for keywords. Key actions include providing a `customer_id` and a list of `keywords` (up to 10,000). Options include specifying `geo_target_constants` (max 10), `language`, the `keyword_plan_network`, and whether to `include_adult_keywords`. You can also refine the results using `aggregate_metrics`, `historical_metrics_options`. An empty `geo_target_constants` list target all location. If no `language` is indicated all keywords will be used.\n"]]
