Geocoder

Classe Geocoder

Classe google.maps.Geocoder

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

Acesse ligando para 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 aos servidores do Google.
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.
address optional
Tipo:string optional
Endereço para geocodificação. É necessário fornecer um, e apenas um, dos campos address, location e placeId.
bounds optional
LatLngBounds em que pesquisar. 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 itens: 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
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
Cumprir a promessa em um status ZERO_RESULT na resposta. Isso pode ser desejável porque, mesmo com zero resultados de geocodificação, ainda pode haver outros campos no nível da resposta retornados.
language optional
Tipo:string optional
Um identificador do 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) para pesquisar. O geocodificador executa uma geocodificação inversa. Consulte Geocodificação inversa para mais informações. É necessário fornecer um, e apenas um, dos campos 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 inversa. Consulte Geocodificação inversa para mais informações. É necessário fornecer um, e apenas um, dos campos address, location e placeId.
region optional
Tipo:string optional
Código do país usado para influenciar a pesquisa, especificado como uma subtag de região Unicode de dois caracteres (não numéricos) / identificador CLDR. Opcional. Consulte os detalhes da cobertura da Plataforma Google Maps para saber quais regiões são aceitas.

Interface GeocoderComponentRestrictions

Interface google.maps.GeocoderComponentRestrictions

GeocoderComponentRestrictions representa um conjunto de filtros que resolvem uma área específica. Para mais detalhes sobre como isso funciona, consulte Filtragem de componentes 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 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 de google.maps.ExtraGeocodeComputation

Cálculos extras a serem realizados ao concluir uma solicitação de geocodificação.

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

Constantes GeocoderStatus

Constantes de google.maps.GeocoderStatus

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

Acesse ligando para const {GeocoderStatus} = await google.maps.importLibrary("geocoding").
Consulte Bibliotecas na API Maps JavaScript.
ERROR Houve um problema ao entrar em contato com os servidores do 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 foi encontrado para este GeocoderRequest.

Interface GeocoderResponse

Interface google.maps.GeocoderResponse

Uma resposta do geocodificador retornada pelo Geocoder que contém 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 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, já que inclui indiretamente um objeto LatLng.
address_components
Uma matriz de GeocoderAddressComponents.
formatted_address
Tipo:string
Uma string que contém o endereço legível do local.
geometry
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 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 do desenvolvedor.
Betaaddress_descriptor optional
Tipo:AddressDescriptor optional
Uma descrição relacional do local associado a esse geocódigo. Inclui um conjunto classificado de pontos de referência próximos e as áreas que contêm o local de destino. Ele só será preenchido para solicitações de geocodificação direta e pesquisa de ID de lugar, apenas quando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS estiver ativado e apenas para determinados lugares localizados.
partial_match optional
Tipo:boolean optional
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.
areas
Tipo:Array<Area>
Uma lista classificada de áreas adjacentes ou que contêm o local. As áreas mais úteis (reconhecíveis e precisas) são classificadas primeiro.
landmarks
Uma lista classificada de pontos de referência próximos. 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.
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
location
Tipo:LatLng
As coordenadas de latitude/longitude deste resultado.
location_type
O tipo de local retornado em location
viewport
Os limites da janela de visualização recomendada para mostrar este GeocoderResult.
bounds optional
Tipo:LatLngBounds optional
Os limites precisos deste GeocoderResult, se aplicável

Constantes GeocoderLocationType

Constantes de google.maps.GeocoderLocationType

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

Acesse ligando para 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 lugar que representa um ponto de referência para o endereço.
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 ponto de referência. Pode ser usado para resolver mais informações sobre o ponto de referência usando os detalhes do lugar ou a pesquisa de ID do lugar.
spatial_relationship
Define a relação espacial entre o local 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 do resultado retornado. Consulte Tipos para mais detalhes.
travel_distance_meters optional
Tipo:number optional
A distância de viagem ao longo da rede viária entre o local de destino e o ponto de referência. Esse campo pode ficar vazio se o ponto de referência estiver desconectado da parte da rede viária mais próxima do destino OU se o local de destino não for considerado na rede viária.

Interface Area

Interface google.maps.Area

Um lugar que é uma pequena região, como um bairro, uma sublocalidade ou um grande complexo que contém o local de destino.
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 subjacente. Pode ser usado para resolver mais informações sobre a área usando os detalhes do lugar ou a pesquisa de ID de lugar.

Constantes de contenção

Constantes de google.maps.Containment

Uma enumeração que representa a relação espacial entre a área e o local de destino.

Acesse ligando para const {Containment} = await google.maps.importLibrary("geocoding").
Consulte Bibliotecas na API Maps JavaScript.
NEAR O local de destino está fora da região, mas perto dela.
OUTSKIRTS O local de destino está dentro da região da área, perto da borda.
WITHIN O local de destino está dentro da região da área, perto do centro.

Constantes SpatialRelationship

Constantes de google.maps.SpatialRelationship

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

Acesse ligando para const {SpatialRelationship} = await google.maps.importLibrary("geocoding").
Consulte Bibliotecas na API Maps JavaScript.
ACROSS_THE_ROAD O destino fica diretamente em frente ao ponto de referência, do outro lado da rua.
AROUND_THE_CORNER Não está na mesma rota que o ponto de referência, mas a uma única curva de distância.
BEHIND Próximo à estrutura do ponto de referência, mas mais distante do ponto de acesso.
BESIDE O destino está diretamente adjacente ao ponto de referência.
DOWN_THE_ROAD Na mesma via que o 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 destino está dentro dos limites dela.