GenerateKeywordForecastMetricsRequest

  • This is a request message for the [KeywordPlanIdeaService.GenerateKeywordForecastMetrics] service.

  • The request includes fields for customer_id, forecast_period, campaign, and optionally currency_code.

  • The forecast_period must be a future date range within one year, or a default date range will be used.

  • The campaign field is required for the forecast.

Request message for [KeywordPlanIdeaService.GenerateKeywordForecastMetrics].

Fields

customer_id

string

The ID of the customer.

forecast_period

DateRange

The date range for the forecast. The start date must be in the future and end date must be within 1 year from today. The reference timezone used is the one of the Google Ads account belonging to the customer. If not set, a default date range from next Sunday to the following Saturday will be used.

campaign

CampaignToForecast

Required. The campaign used in the forecast.

currency_code

string

The currency used for exchange rate conversion. By default, the account currency of the customer is used. Set this field only if the currency is different from the account currency. The list of valid currency codes can be found at https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.