Method: customers.generateKeywordIdeas

返回关键字提示列表。

抛出的错误列表：AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError KeywordPlanIdeaError QuotaError RequestError

HTTP 请求

POST https://googleads.googleapis.com/v18/customers/{customerId}:generateKeywordIdeas

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

收到建议的客户的 ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "geoTargetConstants": [
    string
  ],
  "includeAdultKeywords": boolean,
  "pageToken": string,
  "pageSize": integer,
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "keywordAnnotation": [
    enum (KeywordPlanKeywordAnnotation)
  ],
  "aggregateMetrics": {
    object (KeywordPlanAggregateMetrics)
  },
  "historicalMetricsOptions": {
    object (HistoricalMetricsOptions)
  },
  "language": string,

  // Union field seed can be only one of the following:
  "keywordAndUrlSeed": {
    object (KeywordAndUrlSeed)
  },
  "keywordSeed": {
    object (KeywordSeed)
  },
  "urlSeed": {
    object (UrlSeed)
  },
  "siteSeed": {
    object (SiteSeed)
  }
  // End of list of possible types for union field seed.
}
字段
geoTargetConstants[]

string

要定位到的营业地点的资源名称。最多 10 个。可以使用空列表指定所有定位到的地理位置。
includeAdultKeywords

boolean

如果为 true，则响应中将包含成人关键字。默认值为 false。
pageToken

string

要检索的页面的令牌。如果未指定，则返回第一页的结果。如需请求下一页结果，请使用上一个响应中从 nextPageToken 获取的值。请求字段必须在各个页面中保持一致。
pageSize

integer

单个页面中要检索的结果数。最多可返回 10,000 条结果，如果 pageSize 超出此数值，则会被忽略。如果未指定，则最多返回 10,000 条结果。服务器可能会决定进一步限制返回的资源数量。如果响应中包含的结果少于 10,000 个，则可能不会被视为结果的最后一页。
keywordPlanNetwork

enum (KeywordPlanNetwork)

定位到广告网络。如果未设置，系统将使用 Google 搜索网络和合作伙伴网络。
keywordAnnotation[]

enum (KeywordPlanKeywordAnnotation)

要包含在响应中的关键字注释。
aggregateMetrics

object (KeywordPlanAggregateMetrics)

要包含在响应中的汇总字段。
historicalMetricsOptions

object (HistoricalMetricsOptions)

历史指标数据的选项。
language

string

要定位到的语言的资源名称。每个关键字都属于一组语言；如果语言是其所属语言之一，则会包含该关键字。如果未设置，则会包含所有关键字。
联合字段 seed。用于生成关键字提示的种子类型。seed 只能是下列其中一项：
keywordAndUrlSeed

object (KeywordAndUrlSeed)

关键字和特定网址（例如，汽车 www.example.com/cars），以便生成相关创意。
keywordSeed

object (KeywordSeed)

关键字或词组，例如“汽车”，用于生成相关创意。
urlSeed

object (UrlSeed)

要从中生成创意的特定网址，例如 www.example.com/cars。
siteSeed

object (SiteSeed)

要从中生成创意的网站，例如 www.example.com。

响应正文

KeywordPlanIdeaService.GenerateKeywordIdeas 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "results": [
    {
      object (GenerateKeywordIdeaResult)
    }
  ],
  "aggregateMetricResults": {
    object (KeywordPlanAggregateMetricResults)
  },
  "nextPageToken": string,
  "totalSize": string
}
字段
results[]

object (GenerateKeywordIdeaResult)

生成关键字提示的结果。
aggregateMetricResults

object (KeywordPlanAggregateMetricResults)

所有关键字提示的汇总指标。
nextPageToken

string

用于检索下一页结果的分页令牌。将此字符串的内容作为下一个请求的 pageToken 属性传递。系统不会为最后一页返回 nextPageToken。
totalSize

string (int64 format)

可用结果的总数。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/adwords

如需了解详情，请参阅 OAuth 2.0 Overview。

KeywordPlanKeywordAnnotation

枚举可请求的关键字方案注释。

枚举
UNSPECIFIED 未指定。
UNKNOWN 此版本中的值未知。
KEYWORD_CONCEPT 返回关键字概念和概念组数据。

KeywordAndUrlSeed

关键字和网址种子

JSON 表示法 
{
  "keywords": [
    string
  ],
  "url": string
}
字段
keywords[]

string

关键字数量不得少于 1 个，也不得超过 20 个。
url

string

要抓取以生成关键字提示的网址。

KeywordSeed

种子关键字

JSON 表示法 
{
  "keywords": [
    string
  ]
}
字段
keywords[]

string

关键字数量不得少于 1 个，也不得超过 20 个。

UrlSeed

网址种子

JSON 表示法 
{
  "url": string
}
字段
url

string

要抓取以生成关键字提示的网址。

SiteSeed

网站种子

JSON 表示法 
{
  "site": string
}
字段
site

string

网站的域名。如果请求创意提案的客户不是所提供网站的所有者，则系统只会返回公开信息。

GenerateKeywordIdeaResult

生成关键字提示的结果。

JSON 表示法 
{
  "keywordIdeaMetrics": {
    object (KeywordPlanHistoricalMetrics)
  },
  "keywordAnnotations": {
    object (KeywordAnnotations)
  },
  "closeVariants": [
    string
  ],
  "text": string
}
字段
keywordIdeaMetrics

object (KeywordPlanHistoricalMetrics)

关键字的历史指标。
keywordAnnotations

object (KeywordAnnotations)

关键字的注释。只有在收到请求时，系统才会提供注释数据。
closeVariants[]

string

请求的关键字的紧密变体列表，这些变体会合并到此 GenerateKeywordIdeaResult 中。如需了解“相近变体”的定义，请参阅 https://support.google.com/google-ads/answer/9342105。
text

string

关键字提示的文字。与关键字方案历史指标一样，此文本可能不是实际关键字，而是多个关键字的规范形式。请参阅 KeywordPlanService 中的 KeywordPlanKeywordHistoricalMetrics 消息。

KeywordAnnotations

关键字方案关键字的注释。

JSON 表示法 
{
  "concepts": [
    {
      object (KeywordConcept)
    }
  ]
}
字段
concepts[]

object (KeywordConcept)

关键字的概念列表。

KeywordConcept

关键字的概念。

JSON 表示法 
{
  "name": string,
  "conceptGroup": {
    object (ConceptGroup)
  }
}
字段
name

string

conceptGroup 中相应关键字的概念名称。
conceptGroup

object (ConceptGroup)

概念详情的概念组。

ConceptGroup

关键字概念的概念组。

JSON 表示法 
{
  "name": string,
  "type": enum (KeywordPlanConceptGroupType)
}
字段
name

string

概念组名称。
type

enum (KeywordPlanConceptGroupType)

概念组类型。

KeywordPlanConceptGroupType

枚举关键字方案概念组类型。

枚举
UNSPECIFIED 概念群组分类不同于品牌/非品牌。这是适用于不属于以下任何分类的所有分类的统称分类。
UNKNOWN 此版本中的值未知。
BRAND 概念组分类基于品牌。
OTHER_BRANDS 基于品牌的概念群组分类与品牌分类不相符。这类广告系列通常是离群值，并且可能只有很少的关键字属于此类分类。
NON_BRAND 这些概念群组分类并非基于品牌。对于没有品牌关联的通用关键字，系统会返回此值。