GenerateKeywordIdeasRequest

AI-generated Key Takeaways

• The request message for KeywordPlanIdeaService.GenerateKeywordIdeas defines parameters for generating keyword ideas, including customer ID, targeting options, pagination, and seed information.

• You can specify geographic and language targeting for keyword ideas, with a maximum of 10 geo targets or an empty list for all.

• Options are available to include adult keywords, control pagination with page_token and page_size, and specify the targeting network.

• Various types of seeds can be used to generate ideas, including keywords, URLs, or a combination of both, as well as a whole site.

• Additional options allow including keyword annotations, aggregate metrics, and historical metrics data in the response.

Request message for KeywordPlanIdeaService.GenerateKeywordIdeas.

Fields
customer_id	string The ID of the customer with the recommendation.
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.
include_adult_keywords	bool If true, adult keywords will be included in response. The default value is false.
page_token	string 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.
page_size	int32 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.
keyword_plan_network	KeywordPlanNetwork Targeting network. If not set, Google Search And Partners Network will be used.
keyword_annotation[]	KeywordPlanKeywordAnnotation The keyword annotations to include in response.
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.
Union field seed seed. The type of seed to generate keyword ideas. seed can be only one of the following:
keyword_and_url_seed	KeywordAndUrlSeed A Keyword and a specific Url to generate ideas from for example, cars, www.example.com/cars.
keyword_seed	KeywordSeed A Keyword or phrase to generate ideas from, for example, cars.
url_seed	UrlSeed A specific url to generate ideas from, for example, www.example.com/cars.
site_seed	SiteSeed The site to generate ideas from, for example, www.example.com.