Package google.maps.geocode.v4beta

Índice

GeocodeService

Um serviço para realizar geocodificação.

GeocodeAddress

rpc GeocodeAddress(GeocodeAddressRequest) returns (GeocodeAddressResponse)

Esse método realiza uma geocodificação de endereço, que mapeia um endereço para um LatLng. Ele também fornece informações estruturadas sobre o endereço.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.address
GeocodeLocation

rpc GeocodeLocation(GeocodeLocationRequest) returns (GeocodeLocationResponse)

Esse método realiza uma geocodificação de local, que mapeia um LatLng para um endereço. Ele também fornece informações estruturadas sobre o endereço.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.location
GeocodePlace

rpc GeocodePlace(GeocodePlaceRequest) returns (GeocodeResult)

Esse método realiza uma pesquisa de geocodificação usando um ID de lugar.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.place

GeocodeAddressRequest

Mensagem de solicitação para "GeocodeService.GeocodeAddress".

Campos
location_bias

GeocodeAddressRequest.LocationBias

Opcional. A região a ser pesquisada. Esse local serve como uma tendência, o que significa que resultados próximos ao local especificado podem ser retornados.

language_code

string

Opcional. Idioma em que os resultados precisam ser retornados.

region_code

string

Opcional. É o código da região. O código da região, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro afeta os resultados com base na legislação aplicável. Esse parâmetro também influencia, mas não restringe totalmente, os resultados do serviço.

Campo de união address_input. O endereço a ser geocodificado. address_input pode ser apenas de um dos tipos a seguir:
address_query

string

O endereço não estruturado a ser geocodificado.

address

PostalAddress

O endereço estruturado a ser geocodificado no formato de endereço postal.

LocationBias

A região a ser pesquisada. Esse local serve como uma tendência, o que significa que resultados próximos ao local especificado podem ser retornados.

Campos
Campo de união type. Tipos de viés de local. type pode ser apenas de um dos tipos a seguir:
rectangle

Viewport

Uma caixa retangular definida pelos cantos nordeste e sudoeste. rectangle.high() precisa ser o ponto nordeste da janela de visualização do retângulo. rectangle.low() precisa ser o ponto sudoeste da janela de visualização do retângulo. O campo rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso vai resultar em um intervalo de latitude vazio. Uma janela de visualização retangular não pode ter mais de 180 graus de largura.

GeocodeAddressResponse

Mensagem de resposta para GeocodeService.GeocodeAddress.

Campos
results[]

GeocodeResult

O resultado da geocodificação.

GeocodeLocationRequest

Mensagem de solicitação para "GeocodeService.GeocodeLocation".

Campos
language_code

string

Opcional. Idioma em que os resultados precisam ser retornados.

region_code

string

Opcional. É o código da região. O código da região, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro afeta os resultados com base na legislação aplicável.

types[]

string

Opcional. Um conjunto de tags de tipo para restringir os resultados. Os resultados que não têm nenhum dos tipos especificados são removidos.

Para conferir a lista completa de valores possíveis, consulte as tabelas A e B em https://developers.google.com/maps/documentation/places/web-service/place-types.

granularity[]

GeocodeResult.Granularity

Opcional. Um filtro de um ou mais enums de granularidade de local.

Campo de união location_input. O local a ser geocodificado. location_input pode ser apenas de um dos tipos a seguir:
location_query

string

O local no formato de string "lat,lng". Por exemplo, "64.7611872,-18.4705364".

location

LatLng

O local no formato estruturado.

GeocodeLocationResponse

Mensagem de resposta para GeocodeService.GeocodeLocation.

Campos
results[]

GeocodeResult

O resultado da geocodificação.

plus_code

PlusCode

Plus Code do local na solicitação.

GeocodePlaceRequest

Mensagem de solicitação para "GeocodeService.GeocodePlace".

Campos
place

string

Obrigatório. Identificador do lugar a ser geocodificado no formato places/{place}.

language_code

string

Opcional. Idioma em que os resultados precisam ser retornados.

region_code

string

Opcional. É o código da região. O código da região, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro afeta os resultados com base na legislação aplicável.

GeocodeResult

Um resultado de geocodificação contém informações geográficas sobre um lugar.

Campos
place

string

O identificador de lugar totalmente qualificado para este resultado. No formato "//places.googleapis.com/places/{placeID}". Consulte https://developers.google.com/maps/documentation/places/web-service/place-id para mais detalhes.

place_id

string

O ID do lugar para este resultado.

location

LatLng

O latlng deste endereço.

granularity

GeocodeResult.Granularity

A granularidade do local.

viewport

Viewport

Uma janela de visualização adequada para mostrar o resultado da geocodificação.

bounds

Viewport

Uma caixa delimitadora para o endereço.

formatted_address

string

O endereço formatado em uma linha.

postal_address

PostalAddress

O endereço no formato de endereço postal.

address_components[]

GeocodeResult.AddressComponent

Componentes repetidos para cada nível de localidade.

postal_code_localities[]

LocalizedText

Lista completa de localidades contidas no código postal.

Esse campo só é preenchido quando o resultado é do tipo "postal_code".

types[]

string

Um conjunto de tags de tipo para este resultado. Por exemplo, "political" e "administrative_area".

Para conferir a lista completa de valores possíveis, consulte as tabelas A e B em https://developers.google.com/maps/documentation/places/web-service/place-types.

plus_code

PlusCode

Plus Code do local nesta geocodificação.

AddressComponent

Os componentes estruturados que formam o endereço formatado, se essas informações estiverem disponíveis.

Campos
long_text

string

A descrição completa em texto ou o nome do componente do endereço. Por exemplo, um componente de endereço para o país Austrália pode ter o nome longo "Austrália".

short_text

string

Um nome abreviado, no formato de texto, para o componente de endereço, se estiver disponível. Por exemplo, um componente de endereço para o país Austrália pode ter o nome abreviado "AU".

types[]

string

Uma matriz que indica os tipos do componente de endereço.

Consulte https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types para mais detalhes.

language_code

string

A linguagem usada para formatar esses componentes, na notação CLDR.

Granularidade

A granularidade do local.

Enums
GRANULARITY_UNSPECIFIED Não use.
ROOFTOP O local não interpolado de um terreno real correspondente ao endereço encontrado.
RANGE_INTERPOLATED Interpolado de um intervalo de números de rua. Por exemplo, se soubermos que um trecho da Amphitheatre Pkwy contém os números 1600 a 1699, o número 1650 poderá ser colocado na metade entre os endpoints.
GEOMETRIC_CENTER O centro geométrico de um elemento para o qual temos dados poligonais.
APPROXIMATE Todo o resto.

PlusCode

O Plus Code (http://plus.codes) é uma referência de local com dois formatos: código global que define um retângulo de 14 m x 14 m (1/8000 de um grau) ou menor, e código composto, que substitui o prefixo por um local de referência.

Campos
global_code

string

Código global (completo) do lugar, como "9FWM33GV+HQ", que representa uma área de 1/8000 por 1/8000 de grau (~14 por 14 metros).

compound_code

string

O código composto do lugar, como "33GV+HQ, Ramberg, Noruega", que contém o sufixo do código global e substitui o prefixo por um nome formatado de uma entidade de referência.