Method: geographicalRegions.search

Pesquisar todos os GeographicalRegions disponíveis por regionCode e title. A lista de resultados da pesquisa está organizada por title.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
titleSubstring

string

Pesquise todos os GeographicalRegions em que titleSubstring é uma substring que não diferencia maiúsculas de minúsculas de title ou localTitle. Por exemplo, { regionCode: 'US', titleSubstring: 'york' } retornará registros, incluindo:

[{
 title: 'New York',
 localTitle: 'New York City',
 administrativeAreaTitle: 'New York',
 regionCode: 'US',
 type: 'LOCALITY'
},
{
 title: 'York',
 administrativeAreaTitle: 'Maine',
 regionCode: 'US',
 type: 'LOCALITY'
},
{
 title: 'Yorkana',
 administrativeAreaTitle: 'Pennsylvania',
 regionCode: 'US',
 type: 'LOCALITY'
},
{
 title: 'Jefferson Valley',
 localTitle: 'Jefferson Valley-Yorktown',
 administrativeAreaTitle: 'New York',
 regionCode: 'US',
 type: 'LOCALITY'
}]
regionCode

string

Obrigatório. O código de região GeographicalRegion. Somente GeographicalRegions deste regionCode são retornados. Códigos de região CLDR Unicode (list).
pageSize

integer

O número máximo de GeographicalRegions a ser retornado. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornados no máximo 50 GeographicalRegion. O valor máximo é 1.000. Valores maiores são convertidos para 1.000.
pageToken

string

Um token de página recebido de uma chamada geographicalRegions.search anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para geographicalRegions.search precisam corresponder à chamada que forneceu o token da página.

O token expira e não tem garantia de funcionar indefinidamente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "geographicalRegions": [
    {
      object (GeographicalRegion)
    }
  ],
  "nextPageToken": string
}
Campos
geographicalRegions[]

object (GeographicalRegion)

Os recursos GeographicalRegion da conta especificada.
nextPageToken

string

Um token que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.