Method: customers.generateKeywordForecastMetrics

傳回指定廣告活動關鍵字預測的指標 (例如曝光次數、點擊次數、總費用)。

擲回錯誤清單：AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

HTTP 要求

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

條件 ID 的相關調節係數。設定此值不能為 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)

平均單次轉換出價計算方式為費用百萬分之一 / 轉換次數。