- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- KeywordPlanKeywordHistoricalMetrics
- Try it!
Returns the requested Keyword Plan historical metrics.
List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError KeywordPlanError QuotaError RequestError
HTTP request
POST https://googleads.googleapis.com/v13/{keywordPlan=customers/*/keywordPlans/*}:generateHistoricalMetrics
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
keywordPlan |
Required. The resource name of the keyword plan of which historical metrics are requested. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "aggregateMetrics": { object ( |
Fields | |
---|---|
aggregateMetrics |
The aggregate fields to include in response. |
historicalMetricsOptions |
The options for historical metrics data. |
Response body
Response message for KeywordPlanService.GenerateHistoricalMetrics
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "metrics": [ { object ( |
Fields | |
---|---|
metrics[] |
List of keyword historical metrics. |
aggregateMetricResults |
The aggregate metrics for all the keywords in the keyword planner plan. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adwords
For more information, see the OAuth 2.0 Overview.
KeywordPlanKeywordHistoricalMetrics
A keyword historical metrics.
JSON representation |
---|
{
"closeVariants": [
string
],
"keywordMetrics": {
object ( |
Fields | |
---|---|
closeVariants[] |
The list of close variant queries for searchQuery whose search results are combined into the searchQuery. |
keywordMetrics |
The historical metrics for the query associated with one or more ad_group_keywords in the plan. |
searchQuery |
The text of the query associated with one or more ad_group_keywords in the plan. Note that we de-dupe your keywords list, eliminating close variants before returning the plan's keywords as text. For example, if your plan originally contained the keywords 'car' and 'cars', the returned search query will only contain 'cars'. Starting V5, the list of de-duped queries will be included in closeVariants field. |