Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: listPlannableLocations

Returns the list of plannable locations (for example, countries).

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v10:listPlannableLocations

The URL uses gRPC Transcoding syntax.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The list of plannable locations.

JSON representation 
{
  "plannableLocations": [
    {
      object (PlannableLocation)
    }
  ]
}
Fields
plannableLocations[]

object (PlannableLocation)

The list of locations available for planning. See https://developers.google.com/google-ads/api/reference/data/geotargets for sample locations.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PlannableLocation

A plannable location: country, metro region, province, etc.

JSON representation 
{
  "id": string,
  "name": string,
  "parentCountryId": string,
  "countryCode": string,
  "locationType": string
}
Fields
id

string

The location identifier.
name

string

The unique location name in English.
parentCountryId

string (int64 format)

The parent country (not present if location is a country). If present, will always be a GeoTargetConstant ID. Additional information such as country name is provided by ReachPlanService.ListPlannableLocations or [GoogleAdsService.Search/googleAds.searchStream][].
countryCode

string

The ISO-3166-1 alpha-2 country code that is associated with the location.
locationType

string

The location's type. Location types correspond to targetType returned by searching location type in [GoogleAdsService.Search/googleAds.searchStream][].