Method: customers.generateKeywordForecastMetrics

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

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

HTTP 请求

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

生成预测的流量时，为广告组使用的最高每次点击费用。此值将覆盖出价策略中设置的最高每次点击费用值。仅为具有最高 CPC 值的出价策略指定此字段。

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 / 转化次数。