Method: customers.generateKeywordHistoricalMetrics

キーワードの過去の指標のリストを返します。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customerId

string

推奨事項があるお客様の ID。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "keywords": [
    string
  ],
  "includeAdultKeywords": boolean,
  "geoTargetConstants": [
    string
  ],
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "aggregateMetrics": {
    object (KeywordPlanAggregateMetrics)
  },
  "historicalMetricsOptions": {
    object (HistoricalMetricsOptions)
  },
  "language": string
}
フィールド
keywords[]

string

過去の指標を取得するキーワードのリスト。ほぼ正確な重複除去の結果として、すべての入力が返されるわけではありません。たとえば、「car」と「cars」の統計情報がリクエストされた場合、「car」のみが返されます。最大 10,000 個のキーワードを使用できます。

includeAdultKeywords

boolean

true の場合、アダルト関連のキーワードがレスポンスに含まれます。デフォルト値は false です。

geoTargetConstants[]

string

ターゲットとするビジネスのリソース名です。最大数は 10 です。すべての対象地域を指定するには、空のリストを使用しても構いません。

keywordPlanNetwork

enum (KeywordPlanNetwork)

ネットワークがターゲティングされています。設定しない場合、Google 検索とパートナー ネットワークが使用されます。

aggregateMetrics

object (KeywordPlanAggregateMetrics)

レスポンスに含める集計フィールド。

historicalMetricsOptions

object (HistoricalMetricsOptions)

過去の指標データのオプション。

language

string

ターゲット言語のリソース名。各キーワードは、ある言語セットに属しています。また、その言語のいずれかにキーワードが含まれている場合は、その言語に属します。設定しない場合、すべてのキーワードが含まれます。

レスポンスの本文

KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics に対するレスポンス メッセージです。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "results": [
    {
      object (GenerateKeywordHistoricalMetricsResult)
    }
  ],
  "aggregateMetricResults": {
    object (KeywordPlanAggregateMetricResults)
  }
}
フィールド
results[]

object (GenerateKeywordHistoricalMetricsResult)

キーワードとその過去の指標のリスト。

aggregateMetricResults

object (KeywordPlanAggregateMetricResults)

すべてのキーワードの集計指標。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/adwords

詳細については、OAuth 2.0 の概要をご覧ください。

GenerateKeywordHistoricalMetricsResult

キーワードの過去の指標を生成した結果。

JSON 表現
{
  "closeVariants": [
    string
  ],
  "keywordMetrics": {
    object (KeywordPlanHistoricalMetrics)
  },
  "text": string
}
フィールド
closeVariants[]

string

リクエストされたキーワードの類似パターンのリストで、統計情報がこの GenerateKeywordHistoryMetricsResult に統合されています。

keywordMetrics

object (KeywordPlanHistoricalMetrics)

テキストとその類似パターンの過去の指標

text

string

1 つ以上のキーワードに関連付けられたクエリのテキスト。Google はキーワード リストの重複を排除し、キーワードをテキストとして返す前に類似パターンを除外します。たとえば、リクエストに「car」と「cars」というキーワードが含まれていた場合、返される検索クエリには「cars」のみが含まれます。重複を排除したクエリのリストは、closeVariants フィールドに含まれます。