> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adside.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Keyword-plan-metrics get

> Google Keyword Planner data for keywords that are NOT yet in the account: average monthly searches, top-of-page bid range, competition and average CPC, for pre-launch keyword research. Use this to size conquesting or non-brand terms before committing budget. For keywords already running in the account, use `adside google-ads keyword-performance get` instead.

CLI: `adside google-ads keyword-plan-metrics get`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get:
    post:
      tags:
        - Google Ads
      summary: Keyword-plan-metrics get
      description: >-
        Google Keyword Planner data for keywords that are NOT yet in the
        account: average monthly searches, top-of-page bid range, competition
        and average CPC, for pre-launch keyword research. Use this to size
        conquesting or non-brand terms before committing budget. For keywords
        already running in the account, use `adside google-ads
        keyword-performance get` instead.


        CLI: `adside google-ads keyword-plan-metrics get`
      operationId: google-ads.get_keyword_plan_metrics
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                customer_id:
                  description: >-
                    Omit it: it defaults to the account this workspace is
                    connected to, and any other account is refused.
                  type: string
                keywords:
                  minItems: 1
                  maxItems: 1000
                  type: array
                  items:
                    type: string
                    minLength: 1
                  description: >-
                    The exact terms to measure. Send them all in one call —
                    Google allows only 1 request/second per account, so
                    splitting is slower, not safer.
                geo_target_ids:
                  description: >-
                    Geo target constant IDs (from `adside google-ads geo-targets
                    get`), e.g. '21137' for California. STRONGLY recommended:
                    omitting this returns worldwide volumes, which can be an
                    order of magnitude higher and is almost never what was
                    asked.
                  type: array
                  items:
                    type: string
                language_id:
                  description: >-
                    Language constant ID (from `adside google-ads languages
                    get`). Defaults to '1000' (English).
                  type: string
                network:
                  description: GOOGLE_SEARCH matches what Keyword Planner shows by default.
                  default: GOOGLE_SEARCH
                  type: string
                  enum:
                    - GOOGLE_SEARCH
                    - GOOGLE_SEARCH_AND_PARTNERS
                include_average_cpc:
                  description: Include the historical average CPC alongside the bid range.
                  default: true
                  type: boolean
                include_monthly_volumes:
                  description: >-
                    Include the 12-month volume series per keyword. Off by
                    default: it multiplies the response size by ~12 and is only
                    useful for seasonality.
                  default: false
                  type: boolean
              required:
                - keywords
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.