Method: customers.generateKeywordIdeas

キーワード候補のリストを返します。

スローされるエラーのリスト: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError KeywordPlanIdeaError QuotaError RequestError

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

1 ページで取得する結果の数。最大 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」などから候補を生成するキーワードと具体的な URL。

keywordSeed

object (KeywordSeed)

「車」などから候補を生成するキーワードまたはフレーズ。

urlSeed

object (UrlSeed)

候補を生成する具体的な URL(例: 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

キーワードと URL のシード

JSON 表現
{
  "keywords": [
    string
  ],
  "url": string
}
フィールド
keywords[]

string

少なくとも 1 つのキーワードが必要です。

url

string

キーワード候補を生成するためにクロールする URL です。

KeywordSeed

キーワード シード

JSON 表現
{
  "keywords": [
    string
  ]
}
フィールド
keywords[]

string

少なくとも 1 つのキーワードが必要です。

UrlSeed

URL シード

JSON 表現
{
  "url": string
}
フィールド
url

string

キーワード候補を生成するためにクロールする URL です。

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 これらのコンセプト グループの分類は、ブランドに基づくものではありません。ブランドとの関連性がない一般的なキーワードに対して返されます。