Geocoder

Classe Geocoder

google.maps.Geocoder classe
biblioteca "geocoding"

Um serviço para converter um endereço em um LatLng e vice-versa.

const {Geocoder} = await google.maps.importLibrary("geocoding");

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: request: GeocoderRequest callback: function(Array<GeocoderResult> optional, GeocoderStatus): void optional 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 para o Geocoder.

Propriedades
address opcional	Tipo: string optional Endereço para geocodificação. É necessário fornecer apenas um dos seguintes: address, location ou placeId.
bounds opcional	Tipo: LatLngBounds|LatLngBoundsLiteral optional LatLngBounds em que a pesquisa será feita. Opcional.
componentRestrictions opcional	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 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.
extraComputations opcional	Aviso: disponível apenas no canal v=beta. 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 adicionais na resposta.
fulfillOnZeroResults opcional	Tipo: boolean optional Atenda à promessa em um status ZERO_RESULT na resposta. Isso pode ser útil porque, mesmo com zero resultados de geocodificação, ainda pode haver outros campos de nível de resposta retornados.
language opcional	Tipo: string optional Um identificador do idioma em que os resultados precisam ser retornados, quando possível. Consulte a lista de idiomas compatíveis.
location opcional	Tipo: LatLng|LatLngLiteral optional LatLng (ou LatLngLiteral) a ser pesquisado. O geocodificador executa uma geocodificação inversa. Consulte Geocodificação inversa para mais informações. É necessário fornecer apenas um dos seguintes: address, location ou placeId.
placeId opcional	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 os 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 apenas um dos seguintes: address, location ou placeId.
region opcional	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 de cobertura da Plataforma Google Maps para ver as regiões com disponibilidade.

Interface GeocoderComponentRestrictions

Interface google.maps.GeocoderComponentRestrictions

GeocoderComponentRestrictions representa um conjunto de filtros que se resolvem em uma área específica. Para saber mais sobre como isso funciona, consulte Filtragem de componentes de geocodificação.

Propriedades
administrativeArea opcional	Tipo: string optional Corresponde a todos os administrative_area levels. Opcional.
country opcional	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 opcional	Tipo: string optional Corresponde aos tipos locality e sublocality. Opcional.
postalCode opcional	Tipo: string optional Corresponde a postal_code e postal_code_prefix. Opcional.
route opcional	Tipo: string optional Corresponde ao nome longo ou nome curto de um route. Opcional.

Constantes ExtraGeocodeComputation

google.maps.ExtraGeocodeComputation biblioteca de constantes
"geocoding"

Aviso: disponível apenas no canal v=beta.

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

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo ExtraGeocodeComputationString.

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");

Constantes
ADDRESS_DESCRIPTORS	Gerar um descritor de endereço.

Constantes de GeocoderStatus

google.maps.GeocoderStatus biblioteca de constantes
"geocoding"

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.

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo GeocoderStatusString.

const {GeocoderStatus} = await google.maps.importLibrary("geocoding");

Constantes
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 encontrado para GeocoderRequest.

Interface GeocoderResponse

Interface google.maps.GeocoderResponse

Uma resposta do Geocoder retornada pelo Geocoder que contém a lista de GeocoderResults.

Propriedades
results	Tipo: Array<GeocoderResult> A lista de GeocoderResults.
address_descriptor opcional	Aviso: disponível apenas no canal v=beta. 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 é preenchido apenas para solicitações de geocodificação reversa e somente quando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS está ativado.
plus_code opcional	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 ao JSON", ele não é estritamente JSON, porque inclui indiretamente um objeto LatLng.

Propriedades
address_components	Tipo: Array<GeocoderAddressComponent> Uma matriz de GeocoderAddressComponents.
formatted_address	Tipo: string Uma string que contém o endereço legível por humanos 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 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 ver uma lista de strings possíveis, consulte a seção Tipos de componentes de endereço do Guia para desenvolvedores.
address_descriptor opcional	Aviso: disponível apenas no canal v=beta. 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 a região de segmentação. Isso só será preenchido para solicitações de geocodificação direta e de pesquisa de ID de lugar, apenas quando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS estiver ativado e somente para determinados lugares localizados.
partial_match opcional	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 houver uma correspondência exata, o valor será undefined.
plus_code opcional	Tipo: PlacePlusCode optional O Plus Code associado ao local.
postcode_localities opcional	Tipo: Array<string> optional Uma matriz de strings que indica 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

Aviso: disponível apenas no canal v=beta.

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.

Propriedades
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	Tipo: Array<Landmark> 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.

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 mostrar esse GeocoderResult.
bounds opcional	Tipo: LatLngBounds optional Os limites precisos deste GeocoderResult, se aplicável.

Constantes GeocoderLocationType

google.maps.GeocoderLocationType biblioteca de constantes
"geocoding"

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.

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo GeocoderLocationTypeString.

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");

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

Aviso: disponível apenas no canal v=beta.

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 de lugar do estabelecimento subjacente que serve como ponto de referência. Pode ser usado para resolver mais informações sobre o ponto de referência usando o Place Details ou a Pesquisa de ID de lugar.
spatial_relationship	Tipo: SpatialRelationship Define a relação espacial entre a região de segmentação e o ponto de referência.
straight_line_distance_meters	Tipo: number A distância em linha reta entre a região de segmentação 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 opcional	Tipo: number optional A distância de viagem ao longo da rede de estradas entre a região de segmentação e o ponto de referência. Esse campo pode ficar em branco se o ponto de referência estiver desconectado da parte da rede viária mais próxima da região de segmentação OU se a região de segmentação não tiver sido considerada como parte da rede viária.

Interface de área

Interface google.maps.Area

Aviso: disponível apenas no canal v=beta.

Um lugar que é uma região pequena, como um bairro, uma sublocalidade ou um grande complexo que contém a região de segmentação.

Propriedades
containment	Tipo: Containment Define a relação espacial entre a região de segmentação 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 de lugar da área em questão. Pode ser usado para resolver mais informações sobre a área usando o Place Details ou a Pesquisa de ID de lugar.

Constantes de contenção

google.maps.Containment biblioteca de constantes
"geocoding"

Aviso: disponível apenas no canal v=beta.

Um tipo enumerado que representa a relação espacial entre a área e a região de segmentação.

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo ContainmentString.

const {Containment} = await google.maps.importLibrary("geocoding");

Constantes
NEAR	A região de segmentação está fora da área, mas perto dela.
OUTSKIRTS	A região de segmentação está dentro da região da área, perto da borda.
WITHIN	A região de segmentação está dentro da área, perto do centro.

Constantes SpatialRelationship

google.maps.SpatialRelationship biblioteca de constantes
"geocoding"

Aviso: disponível apenas no canal v=beta.

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

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo SpatialRelationshipString.

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");

Constantes
ACROSS_THE_ROAD	O destino fica exatamente em frente ao ponto de referência, do outro lado da rua.
AROUND_THE_CORNER	Não está no mesmo trajeto que o ponto de referência, mas 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 destino fica ao lado do ponto de referência.
DOWN_THE_ROAD	Na mesma rota que o ponto de referência, mas não ao lado ou do outro lado.
NEAR	Essa é a relação padrão quando nenhuma outra mais específica abaixo se aplica.
WITHIN	O ponto de referência tem uma geometria espacial, e o destino está dentro dos limites dele.