Skip to main content
POST
Keyword-plan forecast

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
ad_groups
object[]
required

The hypothetical ad-group structure. This does not create anything in Google Ads.

Required array length: 1 - 50 elements
bidding_strategy
object
required
customer_id
string

Omit it: it defaults to the account this workspace is connected to, and any other account is refused.

geo_target_ids
string[]

Geo target IDs from adside google-ads geo-targets get.

Maximum array length: 10
Pattern: ^\d+$
language_ids
string[]
Minimum array length: 1
Pattern: ^\d+$
currency_code
string

Omit to use the connected account's currency.

Pattern: ^[A-Z]{3}$
start_date
string

Forecast start in the account time zone. Must be in the future.

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string

Forecast end in the account time zone, no more than one year ahead.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

200 - application/json

Success