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.

HistoricalMetricsOptions

Historical metrics options.

JSON representation
{
  "includeAverageCpc": boolean,
  "yearMonthRange": {
    object (YearMonthRange)
  }
}
Fields
includeAverageCpc

boolean

Indicates whether to include average cost per click value. Average CPC is a legacy value that will be removed and replaced in the future, and as such we are including it as an optioanl value so clients only use it when strictly necessary and to better track clients that use this value.

yearMonthRange

object (YearMonthRange)

The year month range for historical metrics. If not specified the searches will be returned for past 12 months. Searches data is available for the past 4 years. If the search volume is not available for the entire yearMonthRange provided, the subset of the year month range for which search volume is available will be returned.

YearMonthRange

The year month range inclusive of the start and end months. Eg: A year month range to represent Jan 2020 would be: (Jan 2020, Jan 2020).

JSON representation
{
  "start": {
    object (YearMonth)
  },
  "end": {
    object (YearMonth)
  }
}
Fields
start

object (YearMonth)

The inclusive start year month.

end

object (YearMonth)

The inclusive end year month.

YearMonth

Year month.

JSON representation
{
  "year": string,
  "month": enum (MonthOfYear)
}
Fields
year

string (int64 format)

The year (e.g. 2020).

month

enum (MonthOfYear)

The month of the year. (e.g. FEBRUARY).