Geocoder

Classe Geocoder

Classe google.maps.Geocoder

Um serviço de conversão entre um endereço e uma LatLng.

Acesse chamando const {Geocoder} = await google.maps.importLibrary("geocoding"). Consulte Bibliotecas na API Maps JavaScript.
Geocoder
Geocoder()
Parâmetros: nenhum
Cria uma nova instância de um Geocoder que envia solicitações de geocodificação para os servidores do Google.
geocode
geocode(request[, callback])
Parâmetros: 
Valor de retorno:  Promise<GeocoderResponse>
Geocodifica uma solicitação.

GeocoderRequest.

Interface google.maps.GeocoderRequest

A especificação para uma solicitação de geocodificação a ser enviada ao Geocoder.
address optional
Tipo:  string optional
Endereço para geocodificação. É preciso fornecer apenas um entre address, location e placeId.
bounds optional
LatLngBounds em que a pesquisa será feita. Opcional.
componentRestrictions optional
Os componentes são usados para restringir os resultados a uma área específica. Um filtro consiste em um ou mais dos seguintes: route, locality, administrativeArea, postalCode, country. Somente resultados que correspondem a todos os filtros serão retornados. Os valores de filtro são compatíveis com os mesmos métodos de correção ortográfica e correspondência parcial de outras solicitações de geocodificação. Opcional.
BetaextraComputations optional
Tipo:  Array<ExtraGeocodeComputation> optional
Uma lista de cálculos extras que podem ser usados para concluir a solicitação. Observação: esses cálculos extras podem retornar campos extras na resposta.
fulfillOnZeroResults optional
Tipo:  boolean optional
Cumpra a promessa com um status ZERO_RESULT na resposta. Isso é ideal porque, mesmo sem resultados de geocodificação, ainda é possível retornar outros campos de nível de resposta.
language optional
Tipo:  string optional
Um identificador de idioma para o idioma em que os resultados devem ser retornados, quando possível. Consulte a lista de idiomas compatíveis.
location optional
Tipo:  LatLng|LatLngLiteral optional
LatLng (ou LatLngLiteral) em que pesquisar. O geocodificador executa uma geocodificação inversa. Consulte Geocodificação inversa para mais informações. É preciso fornecer apenas um entre address, location e placeId.
placeId optional
Tipo:  string optional
O ID de lugar associado ao local. IDs de lugares identificam um local de modo exclusivo no banco de dados do Google Places e no Google Maps. Saiba mais sobre IDs de lugar no guia do desenvolvedor da API Places. O geocodificador executa uma geocodificação inversa. Consulte Geocodificação inversa para mais informações. É preciso fornecer apenas um entre address, location e placeId.
region optional
Tipo:  string optional
Código de país usado para polarizar a pesquisa, especificado como uma subtag de região Unicode / identificador CLDR de dois caracteres (não numéricos). Opcional. Veja os detalhes da cobertura da Plataforma Google Maps para saber quais são as regiões disponíveis.

Interface GeocoderComponentRestrictions.

Interface google.maps.GeocoderComponentRestrictions

GeocoderComponentRestrictions representa um conjunto de filtros que se concentram em uma área específica. Para detalhes sobre como isso funciona, consulte Filtragem do componente de geocodificação.
administrativeArea optional
Tipo:  string optional
Corresponde a todos os administrative_area levels. Opcional.
country optional
Tipo:  string optional
Corresponde a um nome de país ou a um código de país ISO 3166-1 de duas letras. Opcional.
locality optional
Tipo:  string optional
Corresponde aos tipos locality e sublocality. Opcional.
postalCode optional
Tipo:  string optional
Corresponde a postal_code e postal_code_prefix. Opcional.
route optional
Tipo:  string optional
Corresponde ao nome longo ou curto de uma route. Opcional.

Constantes ExtraGeocodeComputation

Constantes google.maps.ExtraGeocodeComputation

Computações extras a serem realizadas ao concluir uma solicitação de geocodificação.

Acesse chamando const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding"). Consulte Bibliotecas na API Maps JavaScript.
ADDRESS_DESCRIPTORS Gere um descritor de endereço.

Constantes GeocoderStatus

Constantes google.maps.GeocoderStatus

O status retornado pelo Geocoder na conclusão de uma chamada para geocode(). Especifique-as por valor ou usando o nome da constante. Por exemplo, 'OK' ou google.maps.GeocoderStatus.OK.

Acesse chamando const {GeocoderStatus} = await google.maps.importLibrary("geocoding"). Consulte Bibliotecas na API Maps JavaScript.
ERROR houve um problema no contato com os servidores da Google.
INVALID_REQUEST Este GeocoderRequest era inválido.
OK A resposta contém um GeocoderResponse válido.
OVER_QUERY_LIMIT A página web ultrapassou o limite de solicitações em um período muito curto.
REQUEST_DENIED A página web não tem permissão para usar o geocodificador.
UNKNOWN_ERROR Não foi possível processar uma solicitação de geocodificação devido a um erro no servidor. Se você tentar novamente, a solicitação poderá dar certo.
ZERO_RESULTS Nenhum resultado encontrado para GeocoderRequest.

GeocoderResponse

Interface google.maps.GeocoderResponse

Uma resposta do geocodificador retornada pelo Geocoder contendo a lista de GeocoderResults.
results
A lista de GeocoderResults.
Betaaddress_descriptor optional
Tipo:  AddressDescriptor optional
Uma descrição relacional de um local. Inclui um conjunto classificado de pontos de referência próximos e as áreas que contêm a região de segmentação. Ele só é preenchido para solicitações de geocodificação reversa e apenas quando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS está ativado.
plus_code optional
Tipo:  PlacePlusCode optional
O Plus Code associado ao local.

GeocoderResult.

Interface google.maps.GeocoderResult

Um único resultado do geocodificador recuperado do servidor do geocódigo. Uma solicitação do geocódigo pode retornar diversos objetos de resultado. Apesar de esse resultado ser do tipo "JSON", ele não é estritamente JSON, já que inclui um objeto LatLng indiretamente.
address_components
Uma matriz de GeocoderAddressComponents.
formatted_address
Tipo:  string
Uma string contendo o endereço legível deste local.
geometry
Um objeto GeocoderGeometry.
place_id
Tipo:  string
O ID de lugar associado ao local. IDs de lugares identificam um local de modo exclusivo no banco de dados do Google Places e no Google Maps. Saiba mais sobre IDs de lugar no guia para desenvolvedores da API Places.
types
Tipo:  Array<string>
Uma matriz de strings que denotam o tipo do elemento geocodificado retornado. Para obter uma lista das possíveis strings, consulte a seção Tipos de componentes de endereço do Guia do desenvolvedor.
Betaaddress_descriptor optional
Tipo:  AddressDescriptor optional
Uma descrição relacional do local associado a este geocódigo. Inclui um conjunto classificado de pontos de referência próximos e as áreas que contêm a região de segmentação. Isso só será preenchido para solicitações de geocodificação direta e busca de ID de lugar, apenas quando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS estiver ativado e somente para determinados lugares localizados.
partial_match optional
Tipo:  boolean optional
Indica se o geocodificador não retornou uma correspondência exata para a solicitação original, mas conseguiu corresponder parte do endereço solicitado. Se for uma correspondência exata, o valor será undefined.
plus_code optional
Tipo:  PlacePlusCode optional
O Plus Code associado ao local.
postcode_localities optional
Tipo:  Array<string> optional
Uma matriz de strings que denotam todas as localidades contidas em um código postal. Esse elemento só está presente quando o resultado é um código postal que contém várias localidades.

AddressDescriptor

Interface google.maps.AddressDescriptor

Uma descrição relacional de um local. Inclui um conjunto classificado de pontos de referência próximos e as áreas que contêm a região de segmentação.
areas
Tipo:  Array<Area>
Uma lista de classificação de áreas contendo ou adjacentes. As áreas mais úteis (reconhecíveis e precisas) são classificadas primeiro.
landmarks
Tipo:  Array<Landmark>
Uma lista de classificação de pontos de referência próximos. Os pontos de referência mais úteis (reconhecíveis e próximos) são classificados primeiro.

GeocoderAddressComponent.

Interface google.maps.GeocoderAddressComponent

Um único componente de endereço em uma GeocoderResult. Um endereço completo pode ser composto de vários componentes de endereço.
long_name
Tipo:  string
O texto completo do componente de endereço.
short_name
Tipo:  string
O texto curto, abreviado, do componente de endereço especificado.
types
Tipo:  Array<string>
Uma matriz de strings que denota o tipo desse componente de endereço. Veja uma lista de tipos válidos aqui.

Interface GeocoderGeometry.

Interface google.maps.GeocoderGeometry

Informações de geometria sobre este GeocoderResult
location
Tipo:  LatLng
As coordenadas de latitude/longitude deste resultado.
location_type
O tipo de local retornado em location
viewport
Tipo:  LatLngBounds
Os limites da janela de visualização recomendada para exibir este GeocoderResult
bounds optional
Tipo:  LatLngBounds optional
Os limites exatos desta GeocoderResult, se aplicável

Constantes GeocoderLocationType

Constantes google.maps.GeocoderLocationType

Descreve o tipo de local retornado de um geocódigo. Especifique-as por valor ou usando o nome da constante. Por exemplo, 'ROOFTOP' ou google.maps.GeocoderLocationType.ROOFTOP.

Acesse chamando const {GeocoderLocationType} = await google.maps.importLibrary("geocoding"). Consulte Bibliotecas na API Maps JavaScript.
APPROXIMATE O resultado retornado é aproximado.
GEOMETRIC_CENTER O resultado retornado é o centro geométrico de um resultado, como uma linha (por exemplo, uma rua) ou polígono (região).
RANGE_INTERPOLATED O resultado retornado reflete uma aproximação (normalmente em uma estrada) interpolada entre dois pontos precisos (como interseções). Resultados interpolados geralmente são retornados quando códigos geográficos de rooftop não estão disponíveis para um endereço.
ROOFTOP O resultado retornado reflete um geocódigo preciso.

Interface Landmark

Interface google.maps.Landmark

Um local que representa um ponto de referência do endereço.
display_name
Tipo:  string
O nome do ponto de referência.
display_name_language_code
Tipo:  string
Idioma do nome do ponto de referência.
place_id
Tipo:  string
O ID do lugar do estabelecimento subjacente que serve como ponto de referência. Pode ser usada para resolver mais informações sobre o ponto de referência usando o Place Details ou a Place Id Lookup.
spatial_relationship
Define a relação espacial entre a localização de destino e o ponto de referência.
straight_line_distance_meters
Tipo:  number
A distância em linha reta entre o local de destino e o ponto de referência.
types
Tipo:  Array<string>
Um ou mais valores que indicam o tipo de resultado retornado. Consulte Tipos para mais detalhes.
travel_distance_meters optional
Tipo:  number optional
A distância de viagem pela malha rodoviária entre o local de destino e o ponto de referência. Esse ponto poderá não ser preenchido se o ponto de referência estiver desconectado da parte da malha rodoviária da qual o destino está mais próximo OU se o local de destino não foi considerado como parte da malha rodoviária.

Interface Area

Interface google.maps.Area

Um lugar que é uma região pequena, como um bairro, uma sublocalidade ou um grande complexo que contém a localização de destino.
containment
Tipo:  Containment
Define a relação espacial entre a área e a localização segmentada.
display_name
Tipo:  string
Nome da área.
display_name_language_code
Tipo:  string
Idioma do nome da área.
place_id
Tipo:  string
O ID do lugar da área subjacente. Pode ser usado para resolver mais informações sobre a área com o Place Details ou a Place ID Lookup.

Constantes de contenção

Constantes google.maps.Containment

Um enum que representa a relação espacial entre a área e a localização de destino.

Acesse chamando const {Containment} = await google.maps.importLibrary("geocoding"). Consulte Bibliotecas na API Maps JavaScript.
NEAR O local de destino está fora da região, mas próximo.
OUTSKIRTS O local de destino está dentro da região da área, perto da borda.
WITHIN O local de destino fica dentro da região da área, próxima ao centro.

Constantes SpatialRelationship

Constantes google.maps.SpatialRelationship

Um enum que representa a relação no espaço entre o ponto de referência e o destino.

Acesse chamando const {SpatialRelationship} = await google.maps.importLibrary("geocoding"). Consulte Bibliotecas na API Maps JavaScript.
ACROSS_THE_ROAD O destino está diretamente em frente ao ponto de referência do outro lado da estrada.
AROUND_THE_CORNER Não no mesmo trajeto que o ponto turístico, mas está a uma única curva de distância.
BEHIND Perto da estrutura do ponto de referência, mas mais longe do ponto de acesso.
BESIDE O alvo está diretamente adjacente ao ponto de referência.
DOWN_THE_ROAD No mesmo trajeto do ponto de referência, mas não ao lado ou do outro lado.
NEAR Essa é a relação padrão quando nada mais específico se aplica abaixo.
WITHIN O ponto de referência tem uma geometria espacial e o destino está dentro dos limites.