> ## 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 forecast

> Forecast cost plus clicks or conversions for a hypothetical Search keyword plan. Supports Manual CPC, Maximize Clicks and Maximize Conversions. This is a read-only estimate and creates no campaigns, ad groups or keywords.

CLI: `adside google-ads keyword-plan forecast`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/google-ads/keyword-plan/forecast
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/forecast:
    post:
      tags:
        - Google Ads
      summary: Keyword-plan forecast
      description: >-
        Forecast cost plus clicks or conversions for a hypothetical Search
        keyword plan. Supports Manual CPC, Maximize Clicks and Maximize
        Conversions. This is a read-only estimate and creates no campaigns, ad
        groups or keywords.


        CLI: `adside google-ads keyword-plan forecast`
      operationId: google-ads.forecast_keyword_plan
      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
                ad_groups:
                  minItems: 1
                  maxItems: 50
                  type: array
                  items:
                    type: object
                    properties:
                      keywords:
                        minItems: 1
                        maxItems: 1000
                        type: array
                        items:
                          type: object
                          properties:
                            text:
                              type: string
                              minLength: 1
                            match_type:
                              default: BROAD
                              type: string
                              enum:
                                - BROAD
                                - PHRASE
                                - EXACT
                          required:
                            - text
                    required:
                      - keywords
                  description: >-
                    The hypothetical ad-group structure. This does not create
                    anything in Google Ads.
                geo_target_ids:
                  description: Geo target IDs from `adside google-ads geo-targets get`.
                  maxItems: 10
                  type: array
                  items:
                    type: string
                    pattern: ^\d+$
                language_ids:
                  default:
                    - '1000'
                  minItems: 1
                  type: array
                  items:
                    type: string
                    pattern: ^\d+$
                bidding_strategy:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          const: MANUAL_CPC
                        max_cpc_bid:
                          type: number
                          exclusiveMinimum: 0
                          description: >-
                            Campaign max CPC in account-currency units, not
                            micros.
                        daily_budget:
                          description: Optional daily budget in account-currency units.
                          type: number
                          exclusiveMinimum: 0
                      required:
                        - type
                        - max_cpc_bid
                    - type: object
                      properties:
                        type:
                          type: string
                          const: MAXIMIZE_CLICKS
                        daily_budget:
                          type: number
                          exclusiveMinimum: 0
                          description: Daily target spend in account-currency units.
                        max_cpc_bid_ceiling:
                          description: Optional CPC ceiling in account-currency units.
                          type: number
                          exclusiveMinimum: 0
                      required:
                        - type
                        - daily_budget
                    - type: object
                      properties:
                        type:
                          type: string
                          const: MAXIMIZE_CONVERSIONS
                        daily_budget:
                          type: number
                          exclusiveMinimum: 0
                          description: Daily target spend in account-currency units.
                      required:
                        - type
                        - daily_budget
                currency_code:
                  description: Omit to use the connected account's currency.
                  type: string
                  pattern: ^[A-Z]{3}$
                start_date:
                  description: >-
                    Forecast start in the account time zone. Must be in the
                    future.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                end_date:
                  description: >-
                    Forecast end in the account time zone, no more than one year
                    ahead.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
              required:
                - ad_groups
                - bidding_strategy
      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.