Skip to main content
POST
/
api
/
v1
/
google-ads
/
locations
/
lookup
Look up location details by IDs
curl --request POST \
  --url http://localhost:8000/api/v1/google-ads/locations/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "google_ads_customer_id": 123,
  "location_ids": [
    123
  ],
  "force_refresh": false
}
'
[
  {
    "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 lookup by IDs.

​
google_ads_customer_id
integer
required

Google Ads customer ID

​
location_ids
integer[]
required

List of location IDs to look up

Required array length: 1 - 100 elements
​
force_refresh
boolean
default:false

Force refresh from API, bypass cache

Response

Successful Response

​
id
integer
required

Location ID from GeoTargetConstant

​
name
string
required

Location name

​
canonical_name
string
required

Full canonical name (e.g., 'New York, NY, United States')

​
type
string
required

Location type (City, State, Country, Province)

​
country_code
string
required

Country code