Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.keywordPlans

Resource: KeywordPlan

A Keyword Planner plan. Max number of saved keyword plans: 10000. It's possible to remove plans if limit is reached.

JSON representation
{
  "resourceName": string,
  "forecastPeriod": {
    object (KeywordPlanForecastPeriod)
  },
  "id": string,
  "name": string
}
Fields
resourceName

string

Immutable. The resource name of the Keyword Planner plan. KeywordPlan resource names have the form:

customers/{customerId}/keywordPlans/{kp_plan_id}

forecastPeriod

object (KeywordPlanForecastPeriod)

The date period used for forecasting the plan.

id

string (int64 format)

Output only. The ID of the keyword plan.

name

string

The name of the keyword plan.

This field is required and should not be empty when creating new keyword plans.

KeywordPlanForecastPeriod

The forecasting period associated with the keyword plan.

JSON representation
{

  // Union field interval can be only one of the following:
  "dateInterval": enum (KeywordPlanForecastInterval),
  "dateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field interval.
}
Fields
Union field interval. Required. The date used for forecasting the Plan. interval can be only one of the following:
dateInterval

enum (KeywordPlanForecastInterval)

A future date range relative to the current date used for forecasting.

dateRange

object (DateRange)

The custom date range used for forecasting. The start and end dates must be in the future. Otherwise, an error will be returned when the forecasting action is performed. The start and end dates are inclusive.

KeywordPlanForecastInterval

Forecast intervals.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
NEXT_WEEK The next week date range for keyword plan. The next week is based on the default locale of the user's account and is mostly SUN-SAT or MON-SUN. This can be different from next-7 days.
NEXT_MONTH The next month date range for keyword plan.
NEXT_QUARTER The next quarter date range for keyword plan.

DateRange

A date range.

JSON representation
{
  "startDate": string,
  "endDate": string
}
Fields
startDate

string

The start date, in yyyy-mm-dd format. This date is inclusive.

endDate

string

The end date, in yyyy-mm-dd format. This date is inclusive.

Methods

generateForecastCurve

Returns the requested Keyword Plan forecast curve.

generateForecastMetrics

Returns the requested Keyword Plan forecasts.

generateForecastTimeSeries

Returns a forecast in the form of a time series for the Keyword Plan over the next 52 weeks.

generateHistoricalMetrics

Returns the requested Keyword Plan historical metrics.

get

Returns the requested plan in full detail.

mutate

Creates, updates, or removes keyword plans.