GenerateKeywordIdeasRequest

  • The request message for KeywordPlanIdeaService.GenerateKeywordIdeas has various fields for specifying criteria like customer ID, geo targets, adult keyword inclusion, pagination, network, annotations, metrics, language, and different seed types for generating keyword ideas.

  • You can specify up to 10 geo target constant resource names or use an empty list for all targeting geos.

  • By default, adult keywords are not included in the response, but this can be changed by setting include_adult_keywords to true.

  • Pagination is controlled using page_token and page_size, with a maximum of 10,000 results per page.

  • You can choose a specific targeting network or use the default Google Search And Partners Network.

  • The type of seed used for generating keyword ideas can be a combination of a keyword and URL, a keyword only, a URL only, or an entire site.

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.