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，回應就會包含成人關鍵字。預設值為否。
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 總覽。

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

KeywordAnnotations

關鍵字企劃書關鍵字的註解。

JSON 表示法 
{
  "concepts": [
    {
      object (KeywordConcept)
    }
  ]
}
欄位
concepts[]

object (KeywordConcept)

關鍵字的概念清單。

KeywordConcept

關鍵字的概念。

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

string

概念群組中關鍵字的概念名稱。
conceptGroup

object (ConceptGroup)

概念詳細資料的概念群組。

ConceptGroup

關鍵字概念的概念群組。

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

string

概念群組名稱。
type

enum (KeywordPlanConceptGroupType)

概念群組類型。

KeywordPlanConceptGroupType

列舉關鍵字企劃書概念群組類型。

列舉
UNSPECIFIED 概念群組分類與品牌/非品牌不同。這是用於擷取所有分類的值區，適用於下列皆非。
UNKNOWN 這個版本無法辨識該值。
BRAND 概念群組分類是以 BRAND 為基礎。
OTHER_BRANDS 概念群組分類是以品牌為依據，但不太符合品牌分類。通常這些是離群值，因此在這類分類中只會有極少數關鍵字。
NON_BRAND 這些概念群組分類不是以 BRAND 為基礎。系統會針對沒有品牌關聯的一般關鍵字傳回這項資料。