Clase Geocoder
Clase google.maps.Geocoder
Un servicio para la conversión entre una dirección y una LatLng
Para acceder, llama a const {Geocoder} = await google.maps.importLibrary("geocoding")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constructor | |
---|---|
Geocoder |
Geocoder() Parámetros: Ninguno
Crea una instancia nueva de un Geocoder que envía solicitudes de geocodificación a los servidores de Google. |
Métodos | |
---|---|
geocode |
geocode(request[, callback]) Parámetros:
Valor que se devuelve:
Promise<GeocoderResponse> Geocodifica una solicitud. |
Interfaz de GeocoderRequest
Interfaz de google.maps.GeocoderRequest
Es la especificación para que se envíe una solicitud de geocodificación a Geocoder
.
Propiedades | |
---|---|
address optional |
Tipo:
string optional Dirección para el geocódigo. Se debe proporcionar solo uno de los valores address , location y placeId . |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds para buscar. Opcional. |
componentRestrictions optional |
Tipo:
GeocoderComponentRestrictions optional Los componentes se usan para restringir los resultados a un área específica. Un filtro consta de uno o más de los siguientes elementos: route , locality , administrativeArea , postalCode y country . Solo se devolverán resultados que coincidan con todos los filtros. Los valores de filtros admiten los mismos métodos de corrección ortográfica y coincidencia parcial que otras solicitudes de geocodificación. Opcional. |
extraComputations optional |
Tipo:
Array<ExtraGeocodeComputation> optional Una lista de cálculos adicionales que se pueden usar para completar la solicitud. Nota: Estos cálculos adicionales pueden mostrar campos adicionales en la respuesta. |
fulfillOnZeroResults optional |
Tipo:
boolean optional Cumplir la promesa con un estado ZERO_RESULT en la respuesta. Esto se puede desear porque aún con cero resultados de geocodificación, puede haber campos de nivel de respuesta adicionales. |
language optional |
Tipo:
string optional Un identificador de idioma para el idioma en el que se deben mostrar los resultados, cuando sea posible. Consulta la lista de idiomas compatibles. |
location optional |
Tipo:
LatLng|LatLngLiteral optional LatLng (o LatLngLiteral ) para el que se buscará. El geocodificador ejecuta un geocódigo inverso. Consulta Geocodificación inversa para obtener más información. Se debe proporcionar solo uno de los valores address , location y placeId . |
placeId optional |
Tipo:
string optional Es el ID de lugar asociado con la ubicación. Los IDs de lugar identifican de forma exclusiva un sitio en la base de datos de Google Places y en Google Maps. Obtén más información sobre los IDs de lugar en la guía para desarrolladores de la API de Places. El geocodificador ejecuta un geocódigo inverso. Consulta Geocodificación inversa para obtener más información. Se debe proporcionar solo uno de los valores address , location y placeId . |
region optional |
Tipo:
string optional Es el código de país que se utiliza para personalizar la búsqueda, que se especifica como una subetiqueta regional Unicode de dos caracteres (no numérico) o identificador CLDR. Opcional. Consulta los Detalles de la cobertura de Google Maps Platform para conocer las regiones admitidas. |
GeocoderComponentRestrictions
Interfaz de google.maps.GeocoderComponentRestrictions
GeocoderComponentRestrictions
representa un conjunto de filtros que se resuelven en un área específica. Para obtener información detallada sobre cómo funciona, consulta Filtrado de componentes de geocodificación.
Propiedades | |
---|---|
administrativeArea optional |
Tipo:
string optional Coincide con todos los administrative_area levels . Opcional. |
country optional |
Tipo:
string optional Coincide con un nombre de país o con un código de país ISO 3166-1 de dos letras. Opcional. |
locality optional |
Tipo:
string optional Coincide con los tipos locality y sublocality . Opcional. |
postalCode optional |
Tipo:
string optional Coincide con postal_code y postal_code_prefix . Opcional. |
route optional |
Tipo:
string optional Coincide con el nombre largo o corto de un route . Opcional. |
Constantes ExtraGeocodeComputation
Constantes google.maps.ExtraGeocodeComputation
Cálculos adicionales para realizar mientras se completa una solicitud de geocodificación.
Para acceder, llama a const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
ADDRESS_DESCRIPTORS |
Genera un descriptor de dirección. |
Constantes GeocoderStatus
Constantes google.maps.GeocoderStatus
Es el estado que muestra Geocoder
cuando finaliza una llamada a geocode()
. Especifícalas por valor o con el nombre de la constante. Por ejemplo, 'OK'
o google.maps.GeocoderStatus.OK
.
Para acceder, llama a const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
ERROR |
se produjo un problema al contactar a los servidores de Google. |
INVALID_REQUEST |
Este GeocoderRequest no es válido. |
OK |
La respuesta contiene un GeocoderResponse válido. |
OVER_QUERY_LIMIT |
La página web excedió el límite de solicitudes en un período demasiado corto. |
REQUEST_DENIED |
La página web no puede usar el geocodificador. |
UNKNOWN_ERROR |
No se pudo procesar una solicitud de geocodificación debido a un error del servidor. La solicitud podría completarse si realizas un nuevo intento. |
ZERO_RESULTS |
No se encontraron resultados para esta GeocoderRequest . |
GeocoderResponse
Interfaz de google.maps.GeocoderResponse
Una respuesta de geocodificador que muestra Geocoder
y que contiene la lista de GeocoderResult
.
Propiedades | |
---|---|
results |
Tipo:
Array<GeocoderResult> Es la lista de elementos GeocoderResult . |
address_descriptor optional |
Tipo:
AddressDescriptor optional Es una descripción relacional de una ubicación. Incluye un conjunto clasificado de puntos de referencia cercanos y las áreas que contienen la ubicación objetivo. Solo se propaga para las solicitudes de geocodificación inversa y solo cuando se habilita ExtraGeocodeComputation.ADDRESS_DESCRIPTORS . |
plus_code optional |
Tipo:
PlacePlusCode optional El Plus Code asociado con la ubicación |
Interfaz de GeocoderResult
Interfaz de google.maps.GeocoderResult
Un solo resultado del geocodificador recuperado del servidor de geocódigos. Una solicitud de geocódigo puede mostrar varios objetos de resultado. Ten en cuenta que, aunque este resultado es “similar a JSON”, no es estrictamente JSON, ya que incluye de forma indirecta un objeto LatLng
.
Propiedades | |
---|---|
address_components |
Tipo:
Array<GeocoderAddressComponent> Un array de GeocoderAddressComponent |
formatted_address |
Tipo:
string Es una cadena que contiene la dirección legible por humanos de esta ubicación. |
geometry |
Tipo:
GeocoderGeometry Un objeto GeocoderGeometry |
place_id |
Tipo:
string Es el ID de lugar asociado con la ubicación. Los IDs de lugar identifican de forma exclusiva un sitio en la base de datos de Google Places y en Google Maps. Obtén más información sobre los IDs de lugar en la guía para desarrolladores de la API de Places. |
types |
Tipo:
Array<string> Array de cadenas que denota el tipo del elemento geocodificado que se muestra. Para obtener una lista de las cadenas posibles, consulta la sección Tipos de componentes de dirección de la guía para desarrolladores. |
address_descriptor optional |
Tipo:
AddressDescriptor optional Es una descripción relacional de la ubicación asociada con este geocódigo. Incluye un conjunto clasificado de puntos de referencia cercanos y las áreas que contienen la ubicación objetivo. Este campo solo se propagará para las solicitudes de búsqueda de IDs de lugar y geocodificación directa, solo cuando esté habilitado ExtraGeocodeComputation.ADDRESS_DESCRIPTORS , y solo para ciertos lugares localizados. |
partial_match optional |
Tipo:
boolean optional Indica si el geocodificador no mostró una coincidencia exacta para la solicitud original, aunque sí encontró una coincidencia parcial para la dirección solicitada. Si es una coincidencia exacta, el valor será undefined . |
plus_code optional |
Tipo:
PlacePlusCode optional El Plus Code asociado con la ubicación |
postcode_localities optional |
Tipo:
Array<string> optional Conjunto de cadenas que denotan todas las localidades incluidas en un código postal. Esto solo se presenta cuando el resultado es un código postal que contiene varias localidades. |
AddressDescriptor.
Interfaz de google.maps.AddressDescriptor
Es una descripción relacional de una ubicación. Incluye un conjunto clasificado de puntos de referencia cercanos y las áreas que contienen la ubicación objetivo.
Propiedades | |
---|---|
areas |
Una lista clasificada de áreas contenedoras o adyacentes. Las áreas más útiles (reconocibles y precisas) se clasifican primero. |
landmarks |
Una lista clasificada de puntos de referencia cercanos Los puntos de referencia más útiles (reconocibles y cercanos) aparecen primero. |
GeocoderAddressComponent
Interfaz de google.maps.GeocoderAddressComponent
Un solo componente de dirección dentro de un GeocoderResult
. Una dirección completa puede constar de varios componentes de dirección.
Propiedades | |
---|---|
long_name |
Tipo:
string El texto completo del componente de dirección |
short_name |
Tipo:
string El texto abreviado y breve del componente de dirección determinado |
types |
Tipo:
Array<string> Array de cadenas que denotan el tipo de este componente de la dirección. Aquí encontrará una lista de los tipos válidos. |
Interfaz de GeocoderGeometry
Interfaz de google.maps.GeocoderGeometry
Información de geometría sobre este GeocoderResult
Propiedades | |
---|---|
location |
Tipo:
LatLng Las coordenadas de latitud y longitud de este resultado |
location_type |
Tipo:
GeocoderLocationType El tipo de ubicación que se muestra en location |
viewport |
Tipo:
LatLngBounds Límites del viewport recomendado para mostrar este GeocoderResult |
bounds optional |
Tipo:
LatLngBounds optional Límites precisos de este GeocoderResult , si corresponde |
Constantes GeocoderLocationType
Constantes google.maps.GeocoderLocationType
Describe el tipo de ubicación que muestra un geocódigo. Especifícalas por valor o con el nombre de la constante. Por ejemplo, 'ROOFTOP'
o google.maps.GeocoderLocationType.ROOFTOP
.
Para acceder, llama a const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
APPROXIMATE |
El resultado que se muestra es aproximado. |
GEOMETRIC_CENTER |
El resultado que se muestra es el centro geométrico de un resultado como una línea (p.ej., calle) o un polígono (región). |
RANGE_INTERPOLATED |
El resultado devuelto refleja una aproximación (generalmente en una ruta) interpolada entre dos puntos precisos (como intersecciones). Generalmente se devuelven resultados interpolados cuando no se encuentran disponibles geocódigos exactos para una dirección. |
ROOFTOP |
El resultado que se muestra refleja un geocódigo preciso. |
Interfaz Landmark
Interfaz de google.maps.Landmark
Es un lugar que representa un punto de referencia para la dirección.
Propiedades | |
---|---|
display_name |
Tipo:
string Es el nombre del punto de referencia. |
display_name_language_code |
Tipo:
string Es el idioma del nombre del punto de referencia. |
place_id |
Tipo:
string El ID de lugar del establecimiento subyacente que funciona como punto de referencia. Se puede utilizar para resolver más información sobre el punto de referencia mediante Place Details o Place Id Lookup. |
spatial_relationship |
Tipo:
SpatialRelationship Define la relación espacial entre la ubicación de destino y el punto de referencia. |
straight_line_distance_meters |
Tipo:
number Distancia en línea recta entre la ubicación objetivo y el punto de referencia. |
types |
Tipo:
Array<string> Uno o más valores que indican el tipo del resultado devuelto. Consulta Tipos para obtener más información. |
travel_distance_meters optional |
Tipo:
number optional La distancia de viaje a lo largo de la red de rutas entre la ubicación objetivo y el punto de referencia. Este campo puede despropagarse si el punto de referencia está desconectado de la parte de la red de rutas a la que está más cerca, O si la ubicación objetivo no se consideró que estaba en la red de rutas. |
Interfaz Area
Interfaz de google.maps.Area
Es un lugar que es una región pequeña, como un vecindario, una sublocalidad o un complejo grande, que contiene la ubicación objetivo.
Propiedades | |
---|---|
containment |
Tipo:
Containment Define la relación espacial entre la ubicación de destino y el área. |
display_name |
Tipo:
string El nombre del área. |
display_name_language_code |
Tipo:
string Es el idioma del nombre del área. |
place_id |
Tipo:
string El ID de lugar del área subyacente. Se puede utilizar para resolver más información sobre el área a través de la búsqueda de Place Details o Place ID. |
Constantes de contención
Constantes google.maps.Containment
Una enumeración que representa la relación espacial entre el área y la ubicación de destino.
Para acceder, llama a const {Containment} = await google.maps.importLibrary("geocoding")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
NEAR |
La ubicación de segmentación se encuentra fuera de la región del área, pero cerca. |
OUTSKIRTS |
La ubicación de destino se encuentra dentro de la región del área, cerca del límite. |
WITHIN |
La ubicación de segmentación se encuentra dentro de la región del área, cerca del centro. |
Constantes de SpatialRelationship
Constantes google.maps.SpatialRelationship
Una enumeración que representa la relación en el espacio entre el punto de referencia y el objetivo.
Para acceder, llama a const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
ACROSS_THE_ROAD |
El objetivo se encuentra directamente opuesto al punto de referencia al otro lado de la ruta. |
AROUND_THE_CORNER |
No está en la misma ruta que el punto de referencia, sino en un solo giro. |
BEHIND |
Se encuentra cerca de la estructura del punto de referencia, pero más lejos de su punto de acceso. |
BESIDE |
El objetivo se encuentra justo al lado del punto de referencia. |
DOWN_THE_ROAD |
Está en la misma ruta que el punto de referencia, pero no al lado ni al otro lado. |
NEAR |
Esta es la relación predeterminada cuando no se aplica nada más específico a continuación. |
WITHIN |
El punto de referencia tiene una geometría espacial y el objetivo está dentro de sus límites. |