Sign in

v1

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

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

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

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.

keywordAnnotationstring[]

The keyword annotations to include in response.

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.

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.

pageTokenstring

Token of the page to retrieve. If not specified, the first page of results will be returned. To request next page of results use the value obtained from next_page_token in the previous response. The request fields must match across pages.

pageSizeinteger

Number of results to retrieve in a single page. A maximum of 10,000 results may be returned, if the page_size exceeds this, it is ignored. If unspecified, at most 10,000 results will be returned. The server may decide to further limit the number of returned resources. If the response contains fewer than 10,000 results it may not be assumed as last page of results.

Response

Successful response