Method: customers.generateKeywordIdeas

傳回關鍵字提案清單。

擲回錯誤清單：AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError KeywordPlanIdeaError QuotaError RequestError

HTTP 要求

POST https://googleads.googleapis.com/v16/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，則會納入成人關鍵字。預設值為否。
pageToken

string

要擷取的網頁權杖。如未指定，系統會傳回第一頁的結果。如想要求下一頁的結果，請使用在上一個回應中從 nextPageToken 取得的值。所有網頁的要求欄位都必須一致。
pageSize

integer

在單一頁面中擷取的結果數量。如果 pageSize 超過 10,000，則系統會傳回最多 10,000 筆結果。如未指定，最多將傳回 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 總覽。

KeywordPlanKeywordAnnotation

列舉可請求的關鍵字企劃書註解。

列舉
UNSPECIFIED 未指定。
UNKNOWN 這個版本無法辨識這個值。
KEYWORD_CONCEPT 傳回關鍵字概念和概念群組資料。

KeywordAndUrlSeed

關鍵字和網址種子

JSON 表示法 
{
  "keywords": [
    string
  ],
  "url": string
}
欄位
keywords[]

string

需要至少一個關鍵字。
url

string

用來產生關鍵字提案的檢索網址。

KeywordSeed

關鍵字字根

JSON 表示法 
{
  "keywords": [
    string
  ]
}
欄位
keywords[]

string

需要至少一個關鍵字。

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 中的 KeywordPlanKeywordHistoryMetrics 訊息。

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 概念群組分類是以 BRAND 為基礎。
OTHER_BRANDS 依據 BRAND 區分的概念群組分類並不適合 BRAND 分類。這通常都是離群值，在這類分類中可能只有極少的關鍵字。
NON_BRAND 這些概念群組分類並非基於 BRAND。系統會針對沒有品牌關聯的籠統關鍵字傳回這個情況。