Classe Geocoder
Classe
google.maps.Geocoder
Um serviço para converter entre um endereço e um 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 aos servidores do Google. |
Métodos | |
---|---|
geocode |
geocode(request[, callback]) Parâmetros:
Valor de retorno:
Promise<GeocoderResponse> Geocodifica uma solicitação. |
Interface GeocoderRequest
Interface
google.maps.GeocoderRequest
A especificação de uma solicitação de geocodificação a ser enviada ao Geocoder
.
Propriedades | |
---|---|
address optional |
Tipo:
string optional Endereço para geocodificação. É necessário fornecer um e apenas um dos valores address , location e placeId . |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds em que pesquisar. 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. |
extraComputations optional |
Tipo:
Array<ExtraGeocodeComputation> optional Uma lista de cálculos extras que podem ser usados para concluir a solicitação. Observação: essas computações extras podem retornar campos extras na resposta. |
fulfillOnZeroResults optional |
Tipo:
boolean optional Cumpra a promessa em um status ZERO_RESULT na resposta. Isso pode ser necessário porque, mesmo sem resultados de geocodificação, ainda podem ser retornados outros campos de nível de resposta. |
language optional |
Tipo:
string optional Um identificador de idioma para o idioma em que os resultados precisam ser retornados, quando possível. Consulte a lista de idiomas compatíveis. |
location optional |
Tipo:
LatLng|LatLngLiteral optional LatLng (ou LatLngLiteral ) para pesquisar. O geocodificador executa uma geocodificação reversa. Consulte Geocodificação inversa para mais informações. É necessário fornecer um e apenas um dos valores address , location e placeId . |
placeId optional |
Tipo:
string optional O ID do 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. O geocodificador executa uma geocodificação reversa. Consulte Geocodificação inversa para mais informações. É necessário fornecer um e apenas um dos valores address , location e placeId . |
region optional |
Tipo:
string optional Código do país usado para enviesar a pesquisa, especificado como um identificador CLDR / subtag de região Unicode de dois caracteres (não numéricos). Opcional. Consulte os detalhes da cobertura da Plataforma Google Maps para conferir as regiões com suporte. |
Interface GeocoderComponentRestrictions
Interface
google.maps.GeocoderComponentRestrictions
GeocoderComponentRestrictions
representa um conjunto de filtros que são resolvidos em uma área específica. Para saber como isso funciona, consulte Filtragem de componentes 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 um route . Opcional. |
Constantes ExtraGeocodeComputation
Constantes
google.maps.ExtraGeocodeComputation
Outras computações 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.
Constantes | |
---|---|
ADDRESS_DESCRIPTORS |
Gere um descritor de endereço. |
Constantes GeocoderStatus
Constantes
google.maps.GeocoderStatus
O status retornado pela Geocoder
na conclusão de uma chamada para geocode()
. Especifique esses valores pelo 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 ao entrar em contato com os servidores do Google. |
INVALID_REQUEST |
O GeocoderRequest é 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 foi encontrado para este GeocoderRequest . |
Interface GeocoderResponse
Interface
google.maps.GeocoderResponse
Uma resposta do geocodificador retornada pelo Geocoder
que contém a lista de GeocoderResult
s.
Propriedades | |
---|---|
results |
Tipo:
Array<GeocoderResult> A lista de GeocoderResult s. |
address_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 o local de destino. 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. |
Interface 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. Embora esse resultado seja "semelhante a JSON", ele não é estritamente JSON, porque inclui indiretamente um objeto LatLng
.
Propriedades | |
---|---|
address_components |
Uma matriz de GeocoderAddressComponent s. |
formatted_address |
Tipo:
string Uma string que contém o endereço legível do local. |
geometry |
Tipo:
GeocoderGeometry Um objeto GeocoderGeometry |
place_id |
Tipo:
string O ID do 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 os 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 uma lista de strings possíveis, consulte a seção Tipos de componentes de endereço do guia para desenvolvedores. |
address_descriptor optional |
Tipo:
AddressDescriptor optional Uma descrição relacional do local associado a esse código geográfico. Inclui um conjunto classificado de pontos de referência próximos e as áreas que contêm o local de destino. Esse campo só será preenchido para solicitações de pesquisa de ID de lugar e geocodificação direta, somente quando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS estiver ativado e apenas para alguns 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 denota 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. |
Interface 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 o local de destino.
Propriedades | |
---|---|
areas |
Uma lista classificada de áreas adjacentes ou que contêm outras. As áreas mais úteis (reconhecíveis e precisas) são classificadas primeiro. |
landmarks |
Uma lista classificada de pontos de referência por perto. Os pontos de referência mais úteis (reconhecíveis e próximos) são classificados primeiro. |
Interface GeocoderAddressComponent
Interface
google.maps.GeocoderAddressComponent
Um único componente de endereço em um 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 indica o tipo desse componente de endereço. Confira 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 precisos dessa GeocoderResult , se aplicável |
Constantes GeocoderLocationType
Constantes
google.maps.GeocoderLocationType
Descreve o tipo de local retornado de um geocódigo. Especifique esses valores pelo 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. |
Interface Landmark
Interface
google.maps.Landmark
Um lugar que representa um ponto de referência para o endereço.
Propriedades | |
---|---|
display_name |
Tipo:
string O nome do ponto de referência. |
display_name_language_code |
Tipo:
string O idioma do nome do ponto de referência. |
place_id |
Tipo:
string O ID do lugar do estabelecimento que serve como marco. Pode ser usado para resolver mais informações sobre o ponto de referência com os detalhes do lugar ou a pesquisa de ID de lugar. |
spatial_relationship |
Tipo:
SpatialRelationship Define a relação espacial entre o local de destino e o marco. |
straight_line_distance_meters |
Tipo:
number A distância em linha reta entre o local de destino e o marco. |
types |
Tipo:
Array<string> Um ou mais valores que indicam o tipo do resultado retornado. Consulte Tipos para mais detalhes. |
travel_distance_meters optional |
Tipo:
number optional A distância de deslocamento ao longo da rede rodoviária entre o local de destino e o ponto de referência. Isso pode ser desativado se o marco estiver desconectado da parte da rede rodoviária mais próxima ao destino OU se o local de destino não for considerado como estando na rede rodoviária. |
Interface de área
Interface
google.maps.Area
Um lugar que é uma região pequena, como um bairro, uma sublocalidade ou um grande complexo que contém o local de destino.
Propriedades | |
---|---|
containment |
Tipo:
Containment Define a relação espacial entre o local de destino e a área. |
display_name |
Tipo:
string O nome da área. |
display_name_language_code |
Tipo:
string O idioma do nome da área. |
place_id |
Tipo:
string O ID do lugar da área. Pode ser usado para resolver mais informações sobre a área com os Detalhes do lugar ou a Pesquisa de ID de lugar. |
Constantes de contenção
Constantes
google.maps.Containment
Um tipo enumerado que representa a relação espacial entre a área e o local de destino.
Acesse chamando const {Containment} = await google.maps.importLibrary("geocoding")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
NEAR |
O local de destino está fora da área, mas por perto. |
OUTSKIRTS |
O local de destino está dentro da área, perto da borda. |
WITHIN |
O local de destino está dentro da região da área, próximo ao centro. |
Constantes SpatialRelationship
Constantes
google.maps.SpatialRelationship
Um tipo enumerado 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.
Constantes | |
---|---|
ACROSS_THE_ROAD |
O destino está diretamente oposto ao marco no outro lado da estrada. |
AROUND_THE_CORNER |
Não na mesma rota do ponto de referência, mas a uma única curva de distância. |
BEHIND |
Perto da estrutura do ponto turístico, mas mais distante do ponto de acesso. |
BESIDE |
O destino está diretamente ao lado do marco. |
DOWN_THE_ROAD |
Na mesma rota do ponto de referência, mas não ao lado ou em frente. |
NEAR |
Essa é a relação padrão quando nada mais específico abaixo se aplica. |
WITHIN |
O ponto de referência tem uma geometria espacial, e o alvo está dentro dos limites dele. |