GenerateKeywordIdeasRequest
Stay organized with collections
Save and categorize content based on your preferences.
| 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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[null,null,["Last updated 2025-08-07 UTC."],[],[],null,["# GenerateKeywordIdeasRequest\n\nRequest message for [KeywordPlanIdeaService.GenerateKeywordIdeas](/google-ads/api/reference/rpc/v21/KeywordPlanIdeaService/GenerateKeywordIdeas).\n\n| Fields ||\n|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `customer_id` | `string` The ID of the customer with the recommendation. |\n| ### `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. |\n| ### `include_adult_keywords` | `bool` If true, adult keywords will be included in response. The default value is false. |\n| ### `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. |\n| ### `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. |\n| ### `keyword_plan_network` | [KeywordPlanNetwork](/google-ads/api/reference/rpc/v21/KeywordPlanNetworkEnum.KeywordPlanNetwork) Targeting network. If not set, Google Search And Partners Network will be used. |\n| ### `keyword_annotation[]` | [KeywordPlanKeywordAnnotation](/google-ads/api/reference/rpc/v21/KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation) The keyword annotations to include in response. |\n| ### `aggregate_metrics` | [KeywordPlanAggregateMetrics](/google-ads/api/reference/rpc/v21/KeywordPlanAggregateMetrics) The aggregate fields to include in response. |\n| ### `historical_metrics_options` | [HistoricalMetricsOptions](/google-ads/api/reference/rpc/v21/HistoricalMetricsOptions) The options for historical metrics data. |\n| ### `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. |\n| Union field ### `seed` `seed`. The type of seed to generate keyword ideas. `seed` can be only one of the following: ||\n| ### `keyword_and_url_seed` | [KeywordAndUrlSeed](/google-ads/api/reference/rpc/v21/KeywordAndUrlSeed) A Keyword and a specific Url to generate ideas from for example, cars, www.example.com/cars. |\n| ### `keyword_seed` | [KeywordSeed](/google-ads/api/reference/rpc/v21/KeywordSeed) A Keyword or phrase to generate ideas from, for example, cars. |\n| ### `url_seed` | [UrlSeed](/google-ads/api/reference/rpc/v21/UrlSeed) A specific url to generate ideas from, for example, www.example.com/cars. |\n| ### `site_seed` | [SiteSeed](/google-ads/api/reference/rpc/v21/SiteSeed) The site to generate ideas from, for example, www.example.com. |"]]
