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.
Construtor | |
---|---|
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. |
Métodos | |
---|---|
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
.
Propriedades | |
---|---|
address optional |
Tipo:
string optional Endereço para geocodificação. É preciso fornecer apenas um entre address , location e placeId . |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds em que a pesquisa será feita. Opcional. |
componentRestrictions optional |
Tipo:
GeocoderComponentRestrictions 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. |
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.
Propriedades | |
---|---|
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 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.
Constantes | |
---|---|
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 GeocoderResult
s.
Propriedades | |
---|---|
results |
Tipo:
Array<GeocoderResult> A lista de GeocoderResult s. |
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.
Propriedades | |
---|---|
address_components |
Tipo:
Array<GeocoderAddressComponent> Uma matriz de GeocoderAddressComponent s. |
formatted_address |
Tipo:
string Uma string contendo o endereço legível deste local. |
geometry |
Tipo:
GeocoderGeometry 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. |
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. |
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.
Propriedades | |
---|---|
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
Propriedades | |
---|---|
location |
Tipo:
LatLng As coordenadas de latitude/longitude deste resultado. |
location_type |
Tipo:
GeocoderLocationType 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.
Constantes | |
---|---|
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. |