Method: customers.generateKeywordIdeas

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

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

HTTP リクエスト

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

候補を生成するキーワードと特定の URL（例: 車、www.example.com/cars）。
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 の 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 BRAND に基づくコンセプト グループの分類は、BRAND の分類に適合しませんでした。これらは通常外れ値であり、このタイプの分類ではキーワードの数が非常に少ない場合があります。
NON_BRAND これらのコンセプト グループの分類は、ブランドに基づくものではありません。ブランドとの関連性がない一般的なキーワードに対して返されます。