Method: customers.generateKeywordForecastMetrics

返回指定广告系列的关键字预测指标（如展示次数、点击次数、总费用）。

抛出的错误列表：AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

客户的 ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "forecastPeriod": {
    object (DateRange)
  },
  "campaign": {
    object (CampaignToForecast)
  },
  "currencyCode": string
}
字段
forecastPeriod

object (DateRange)

预测的日期范围。开始日期必须是将来的日期，结束日期必须在自今日起的 1 年内。所使用的参考时区是属于该客户的 Google Ads 帐号的时区。如果您未设置此政策，系统会使用从下周日至下周六的默认日期范围。
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

用户定义的预期转化率（转化次数除以总点击次数）。此值以小数值表示，因此预期转化率 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)

必需。用于估算的每日目标支出（以微单位表示）。广告系列中使用的本地货币设置了最低值。如果此字段设置得太小，将发生错误显示最小值。
maxCpcBidCeilingMicros

string (int64 format)

每次点击费用的最高出价上限（以微单位表示）。

MaximizeConversionsBiddingStrategy

“尽可能提高转化次数”出价策略。

JSON 表示法 
{
  "dailyTargetSpendMicros": string
}
字段
dailyTargetSpendMicros

string (int64 format)

必需。用于估算的每日目标支出（以微单位表示）。此值必须大于零。

ForecastAdGroup

属于要预测的广告系列的广告组。

JSON 表示法 
{
  "biddableKeywords": [
    {
      object (BiddableKeyword)
    }
  ],
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "maxCpcBidMicros": string
}
字段
biddableKeywords[]

object (BiddableKeyword)

必需。进行预测时要在广告组中使用的可出价关键字列表。需要至少一个关键字。
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 / 转化次数。