Method: customers.generateKeywordForecastMetrics

指定されたキャンペーンのキーワード予測の指標(インプレッション数、クリック数、合計費用など)を返します。

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

HTTP リクエスト

POST https://googleads.googleapis.com/v14/customers/{customerId}:generateKeywordForecastMetrics

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

パスパラメータ

パラメータ
customerId

string

顧客の ID。

リクエスト本文

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

JSON 表現
{
  "forecastPeriod": {
    object (DateRange)
  },
  "campaign": {
    object (CampaignToForecast)
  },
  "currencyCode": string
}
フィールド
forecastPeriod

object (DateRange)

予測の期間。開始日は将来の日付、終了日は本日から 1 年以内の日付にする必要があります。基準となるタイムゾーンは、当該顧客の Google 広告アカウントのタイムゾーンです。設定しない場合は、次の日曜日から次の土曜日までのデフォルトの期間が使用されます。

campaign

object (CampaignToForecast)

必須。予測で使用されるキャンペーン。

currencyCode

string

為替レートの換算に使用する通貨。デフォルトでは、お客様のアカウントの通貨が使用されます。このフィールドは、通貨がアカウントの通貨と異なる場合にのみ設定します。有効な通貨コードのリストは https://developers.google.com/google-ads/api/data/codes-formats#currency-codes でご確認いただけます。

レスポンスの本文

[KeywordPlanIdeaService.GenerateKeywordForecastMetrics] に対するレスポンス メッセージ。

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

JSON 表現
{
  "campaignForecastMetrics": {
    object (KeywordForecastMetrics)
  }
}
フィールド
campaignForecastMetrics

object (KeywordForecastMetrics)

キャンペーン予測の結果。

認可スコープ

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

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

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

CampaignToForecast

キーワード キャンペーン予測を行うキャンペーン。

JSON 表現
{
  "languageConstants": [
    string
  ],
  "geoModifiers": [
    {
      object (CriterionBidModifier)
    }
  ],
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "biddingStrategy": {
    object (CampaignBiddingStrategy)
  },
  "adGroups": [
    {
      object (ForecastAdGroup)
    }
  ],
  "conversionRate": number
}
フィールド
languageConstants[]

string

ターゲットとする言語のリソース名のリストです。リソース名の形式は「languageConstants/{CriterionId}」です。言語の条件コードのリストについては、https://developers.google.com/google-ads/api/data/codes-formats#languages をご覧ください。

geoModifiers[]

object (CriterionBidModifier)

ターゲットに設定する地域です。ロケーションは一意である必要があります。

keywordPlanNetwork

enum (KeywordPlanNetwork)

必須。ターゲティングに使用されるネットワーク。

negativeKeywords[]

object (KeywordInfo)

予測を行う際にキャンペーンで使用される除外キーワードのリスト。

biddingStrategy

object (CampaignBiddingStrategy)

必須。キャンペーンの入札戦略です。

adGroups[]

object (ForecastAdGroup)

予測する新しいキャンペーンの広告グループです。

conversionRate

number

ユーザーが定義した推定コンバージョン率(コンバージョン数を合計クリック数で割った値)。この値は 10 進数で表現されるため、推定コンバージョン率の 2% は 0.02 と入力する必要があります。空白のままにすると、推定コンバージョン率が使用されます。

CriterionBidModifier

地域の条件の入札単価調整比。

JSON 表現
{
  "geoTargetConstant": string,
  "bidModifier": number
}
フィールド
geoTargetConstant

string

ターゲットとする地域のリソース名です。リソース名の形式は「geoTargetConstants/{CriterionId}」です。

bidModifier

number

CriterionId に関連付けられた調整因子です。設定する場合、この値を 0 にすることはできません。

CampaignBiddingStrategy

新しいキャンペーン予測でサポートされている入札戦略です。

JSON 表現
{

  // Union field bidding_strategy can be only one of the following:
  "manualCpcBiddingStrategy": {
    object (ManualCpcBiddingStrategy)
  },
  "maximizeClicksBiddingStrategy": {
    object (MaximizeClicksBiddingStrategy)
  },
  "maximizeConversionsBiddingStrategy": {
    object (MaximizeConversionsBiddingStrategy)
  }
  // End of list of possible types for union field bidding_strategy.
}
フィールド
共用体フィールド bidding_strategy。入札戦略bidding_strategy は次のいずれかになります。
manualCpcBiddingStrategy

object (ManualCpcBiddingStrategy)

予測には個別クリック単価制入札戦略を使用する。

maximizeClicksBiddingStrategy

object (MaximizeClicksBiddingStrategy)

予測には「クリック数の最大化」入札戦略を使用する。

maximizeConversionsBiddingStrategy

object (MaximizeConversionsBiddingStrategy)

予測には「コンバージョン数の最大化」入札戦略を使用する。

ManualCpcBiddingStrategy

「個別クリック単価制」入札戦略を使用します。

JSON 表現
{
  "maxCpcBidMicros": string,
  "dailyBudgetMicros": string
}
フィールド
maxCpcBidMicros

string (int64 format)

必須。個別クリック単価制入札戦略のキャンペーン内の広告グループに適用する入札単価(マイクロ単位)。

dailyBudgetMicros

string (int64 format)

キャンペーン単位の予算(マイクロ単位)。設定すると、キャンペーンで使用される現地通貨の最小値が適用されます。このフィールドの設定が低すぎると、最小値を示すエラーが発生します。

MaximizeClicksBiddingStrategy

クリック数の最大化入札戦略

JSON 表現
{
  "dailyTargetSpendMicros": string,
  "maxCpcBidCeilingMicros": string
}
フィールド
dailyTargetSpendMicros

string (int64 format)

必須。見積もりに使用する 1 日の目標予算(マイクロ単位)。最小値は、キャンペーンで使用されている現地通貨で適用されます。このフィールドの設定が低すぎると、最小値を示すエラーが発生します。

maxCpcBidCeilingMicros

string (int64 format)

上限クリック単価(マイクロ単位)の上限。

MaximizeConversionsBiddingStrategy

コンバージョン数の最大化入札戦略

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

string (int64 format)

必須。見積もりに使用する 1 日の目標予算(マイクロ単位)。この値は 0 よりも大きくする必要があります。

ForecastAdGroup

予測対象のキャンペーンに含まれる広告グループです。

JSON 表現
{
  "biddableKeywords": [
    {
      object (BiddableKeyword)
    }
  ],
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "maxCpcBidMicros": string
}
フィールド
biddableKeywords[]

object (BiddableKeyword)

必須。予測を行う際に広告グループで使用される、入札可能なキーワードのリスト。少なくとも 1 つのキーワードが必要です。

negativeKeywords[]

object (KeywordInfo)

キーワードの詳細。キーワードのテキストとマッチタイプの両方を指定してください。

maxCpcBidMicros

string (int64 format)

予測トラフィックの生成時に広告グループで使用する上限クリック単価です。この値は、入札戦略で設定された上限クリック単価よりも優先されます。このフィールドは、クリック単価値を上限とする入札戦略の場合にのみ指定します。

BiddableKeyword

広告グループの単価調整可能なキーワードの構成要素。

JSON 表現
{
  "keyword": {
    object (KeywordInfo)
  },
  "maxCpcBidMicros": string
}
フィールド
keyword

object (KeywordInfo)

必須。キーワード。テキストとマッチタイプが必要です。

maxCpcBidMicros

string (int64 format)

予測シミュレーションで広告グループ単位の上限クリック単価を上書きする、上限クリック単価(マイクロ単位)です。この値は、入札戦略と広告グループで設定された上限クリック単価の値よりも優先されます。このフィールドは、上限クリック単価の値に対応している入札戦略の場合にのみ指定します。

KeywordForecastMetrics

プランレス キーワード キャンペーンの予測指標。

JSON 表現
{
  "impressions": number,
  "clickThroughRate": number,
  "averageCpcMicros": string,
  "clicks": number,
  "costMicros": string,
  "conversions": number,
  "conversionRate": number,
  "averageCpaMicros": string
}
フィールド
impressions

number

インプレッションの合計数。

clickThroughRate

number

平均クリック率。インプレッション数 > 0 の場合にのみ使用できます。

averageCpcMicros

string (int64 format)

平均クリック単価。クリック数 > 0 の場合にのみ使用できます。

clicks

number

クリックの総数。

costMicros

string (int64 format)

合計費用。

conversions

number

予測コンバージョン数(クリック数 × コンバージョン率)で算出されます。

conversionRate

number

予測コンバージョン率。

averageCpaMicros

string (int64 format)

平均コンバージョン単価は、costMicros ÷ コンバージョン数で算出されます。