Method: geographicalRegions

Search all available GeographicalRegions by regionCode and title. Search result list is ordered by title.

HTTP request

GET https://ads.wazeapis.com/v1/geographicalRegions

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
titleSubstring

string

Search all GeographicalRegions where titleSubstring is a case-insensitive substring of their title. For example, { regionCode: 'US', titleSubstring: 'york' } will return records including:

[{
 title: 'New York',
 localTitle: 'New York City',
 administrativeAreaTitle: 'New York',
 regionCode: 'US',
 type: 'City'
},
{
 title: 'York',
 administrativeAreaTitle: 'Maine',
 regionCode: 'US',
 type: 'City'
},
{
 title: 'Yorkana',
 administrativeAreaTitle: 'Pennsylvania',
 regionCode: 'US',
 type: 'City'
}]
regionCode

string

Required. The GeographicalRegion region code. Only GeographicalRegions from this regionCode will be provided. Unicode CLDR region codes (list).

pageSize

integer

The maximum number of GeographicalRegions to return. The service might return fewer than this value. If unspecified, at most 50 GeographicalRegion are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

pageToken

string

A page token, received from a previous ListGeographicalRegions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to v1.geographicalRegions must match the call that provided the page token.

The token will expire and is not guaranteed to work indefinitely.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "geographicalRegions": [
    {
      object (GeographicalRegion)
    }
  ],
  "nextPageToken": string
}
Fields
geographicalRegions[]

object (GeographicalRegion)

The GeographicalRegion resources from the specified account.

nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.