GenerateKeywordHistoricalMetricsRequest

  • The request message for KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics is used to get historical metrics for a list of keywords.

  • You can specify the customer ID, a list of up to 10,000 keywords, and whether to include adult keywords.

  • Targeting options include geographical locations (up to 10), the keyword plan network, and the language.

  • You can also specify aggregate metrics and historical metrics options to include in the response.

Request message for KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics.

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.