Skip to main content
POST
/
api
/
v1
/
google-ads
/
locations
/
search
Search for location suggestions
curl --request POST \
  --url http://localhost:8000/api/v1/google-ads/locations/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "google_ads_customer_id": 123,
  "query": "<string>",
  "limit": 20,
  "force_refresh": false
}
'
{
  "suggestions": [
    {
      "id": 123,
      "name": "<string>",
      "canonical_name": "<string>",
      "type": "<string>",
      "country_code": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

token_id
integer | null

Optional specific Token ID

Body

application/json

Request schema for location search.

google_ads_customer_id
integer
required

Google Ads customer ID

query
string
required

Search query for locations

Required string length: 1 - 100
limit
integer
default:20

Maximum number of results

Required range: 1 <= x <= 50
force_refresh
boolean
default:false

Force refresh from API, bypass cache

Response

Successful Response

Response schema for location search.

suggestions
LocationSuggestionSchema · object[]
required

List of location suggestions