Skip to main content
POST
google.keywords.ad-traffic

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
keywords
string[]
required

Keywords to advertise on, 1 to 20.

Required array length: 1 - 20 elements
Required string length: 1 - 80
bid
integer
required

The most you would pay for a click, in whole US dollars, 1 to 1000.

Required range: 1 <= x <= 1000
match
enum<string>

How closely a search must match the keywords. Default "exact".

Available options:
exact,
phrase,
broad
country
string

Two-letter country code to look up, e.g. "us". Default "us".

Pattern: ^[a-z]{2}$
language
string

Two-letter language code, e.g. "en". Default "en".

Pattern: ^[a-z]{2}$

Response

The result

clicks
number

Estimated clicks over the period.

cost
number

Estimated cost of those clicks, USD.

averageCpc
number

Estimated average cost per click, USD.

impressions
number

Estimated times the ads are shown.