Method: customers.generateKeywordIdeas

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

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

HTTP リクエスト

POST https://googleads.googleapis.com/v15/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

ターゲットとする言語のリソース名。各キーワードは、ある言語セットに属しています。その言語が 1 つの言語である場合には、キーワードが追加されます。設定しない場合、すべてのキーワードが含まれます。

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