Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131541,3491.5 MB
customers

Returns a list of keyword historical metrics. List of thrown errors: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

post/v23/customers/{+customerId}:generateKeywordHistoricalMetrics

Path parameters

customerIdstring required

The ID of the customer with the recommendation.

Request body

geoTargetConstantsstring[]

The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.

keywordsstring[]

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.

languagestring

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.

keywordPlanNetwork'UNSPECIFIED' | 'UNKNOWN' | 'GOOGLE_SEARCH' | 'GOOGLE_SEARCH_AND_PARTNERS'

Targeting network. If not set, Google Search And Partners Network will be used.

includeAdultKeywordsboolean

If true, adult keywords will be included in response. The default value is false.

Response

Successful response