Clase Geocoder
Clase google.maps.Geocoder
Es un servicio para convertir entre una dirección y un LatLng
.
Llama al const {Geocoder} = await google.maps.importLibrary("geocoding")
para acceder.
Consulta Bibliotecas en 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 de devolución:
Promise<GeocoderResponse> Geocodifica una solicitud. |
Interfaz de GeocoderRequest
Interfaz de google.maps.GeocoderRequest
Es la especificación de una solicitud de geocodificación que se enviará al Geocoder
.
Propiedades | |
---|---|
address optional |
Tipo:
string optional Dirección para geocodificar. Se debe proporcionar uno, y solo uno, de los valores address , location y placeId . |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds en el que se realizará la búsqueda. 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 , 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. |
|
Tipo:
Array<ExtraGeocodeComputation> optional Es una lista de cálculos adicionales que se pueden usar para completar la solicitud. Nota: Estos cálculos adicionales pueden devolver campos adicionales en la respuesta. |
fulfillOnZeroResults optional |
Tipo:
boolean optional Cumple la promesa con un estado ZERO_RESULT en la respuesta. Esto puede ser conveniente porque, incluso con cero resultados de geocodificación, es posible que se devuelvan campos adicionales a nivel de la respuesta. |
language optional |
Tipo:
string optional Es un identificador del 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 buscar. El geocodificador realiza una geocodificación inversa. Consulta Geocodificación inversa para obtener más información. Se debe proporcionar uno, y solo uno, de los valores address , location y placeId . |
placeId optional |
Tipo:
string optional Es el ID de lugar asociado a 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 realiza una geocodificación inversa. Consulta Geocodificación inversa para obtener más información. Se debe proporcionar uno, y solo uno, de los valores address , location y placeId . |
region optional |
Tipo:
string optional Es el código de país que se usa para sesgar la búsqueda, especificado como una subetiqueta de región Unicode o un identificador CLDR de dos caracteres (no numéricos). Opcional. Consulta los Detalles de la cobertura de Google Maps Platform para conocer las regiones admitidas. |
Interfaz de GeocoderComponentRestrictions
Interfaz de google.maps.GeocoderComponentRestrictions
GeocoderComponentRestrictions
representa un conjunto de filtros que se resuelven en un área específica. Para obtener detalles 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 Establece coincidencias 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 Establece coincidencias 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 Establece coincidencias con el nombre largo o corto de una route . Opcional. |
Constantes de ExtraGeocodeComputation
Constantes de google.maps.ExtraGeocodeComputation
Son cálculos adicionales que se deben realizar al completar una solicitud de codificación geográfica.
Llama al const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
ADDRESS_DESCRIPTORS |
Genera un descriptor de dirección. |
Constantes de GeocoderStatus
Constantes de google.maps.GeocoderStatus
Es el estado que muestra Geocoder
cuando se completa una llamada a geocode()
. Puedes especificarlos por valor o con el nombre de la constante. Por ejemplo, 'OK'
o google.maps.GeocoderStatus.OK
.
Llama al const {GeocoderStatus} = await google.maps.importLibrary("geocoding")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
ERROR |
se produjo un problema al contactar a los servidores de Google. |
INVALID_REQUEST |
Este GeocoderRequest no era válido. |
OK |
La respuesta contiene un GeocoderResponse válido. |
OVER_QUERY_LIMIT |
La página web superó el límite de solicitudes en un período demasiado corto. |
REQUEST_DENIED |
La página web no tiene permiso para 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 este GeocoderRequest . |
Interfaz GeocoderResponse
Interfaz de google.maps.GeocoderResponse
Es una respuesta del geocodificador que devuelve el Geocoder
y que contiene la lista de GeocoderResult
.
Propiedades | |
---|---|
results |
Tipo:
Array<GeocoderResult> Es la lista de GeocoderResult s. |
|
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 ExtraGeocodeComputation.ADDRESS_DESCRIPTORS está habilitado. |
plus_code optional |
Tipo:
PlacePlusCode optional Es el código Plus asociado a la ubicación. |
Interfaz GeocoderResult
Interfaz de google.maps.GeocoderResult
Es un solo resultado del geocodificador recuperado del servidor de geocodificación. Una solicitud de geocódigo puede devolver varios objetos de resultado. Ten en cuenta que, si bien este resultado es similar a JSON, no es estrictamente JSON, ya que incluye indirectamente un objeto LatLng
.
Propiedades | |
---|---|
address_components |
Tipo:
Array<GeocoderAddressComponent> Un array de GeocoderAddressComponent s |
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 a 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> Es un array de cadenas que denota el tipo del elemento geocodificado que se devolvió. Para obtener una lista de las cadenas posibles, consulta la sección Tipos de componentes de dirección de la Guía para desarrolladores. |
|
Tipo:
AddressDescriptor optional Es una descripción relacional de la ubicación asociada con esta geocodificación. Incluye un conjunto clasificado de puntos de referencia cercanos y las áreas que contienen la ubicación objetivo. Este campo solo se completará para las solicitudes de búsqueda de ID de lugar y geocodificación directa, solo cuando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS esté habilitado y solo para ciertos lugares localizados. |
partial_match optional |
Tipo:
boolean optional Indica si el geocodificador no devolvió una coincidencia exacta para la solicitud original, aunque sí encontró una coincidencia parcial para la dirección solicitada. Si hay una coincidencia exacta, el valor será undefined . |
plus_code optional |
Tipo:
PlacePlusCode optional Es el código Plus asociado a la ubicación. |
postcode_localities optional |
Tipo:
Array<string> optional Es un array de cadenas que denota 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. |
Interfaz 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 |
Es una lista clasificada de áreas adyacentes o que contienen el área buscada. Las áreas más útiles (reconocibles y precisas) se clasifican primero. |
landmarks |
Es una lista clasificada de puntos de referencia cercanos. Los puntos de referencia más útiles (reconocibles y cercanos) se clasifican primero. |
Interfaz GeocoderAddressComponent
Interfaz de google.maps.GeocoderAddressComponent
Es 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 Es el texto completo del componente de dirección. |
short_name |
Tipo:
string Texto abreviado del componente de dirección determinado |
types |
Tipo:
Array<string> Es un array de cadenas que denota el tipo de este componente de dirección. Puedes encontrar una lista de tipos válidos aquí. |
Interfaz 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 Es 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 Los límites precisos de este GeocoderResult , si corresponde |
Constantes de GeocoderLocationType
Constantes de google.maps.GeocoderLocationType
Describe el tipo de ubicación que se muestra a partir de una geocodificación. Puedes especificarlos por valor o con el nombre de la constante. Por ejemplo, 'ROOFTOP'
o google.maps.GeocoderLocationType.ROOFTOP
.
Llama al const {GeocoderLocationType} = await google.maps.importLibrary("geocoding")
para acceder.
Consulta Bibliotecas en 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., una calle) o un polígono (región). |
RANGE_INTERPOLATED |
El resultado que se muestra 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 de 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 Idioma del nombre del punto de referencia. |
place_id |
Tipo:
string Es el ID de Place del establecimiento subyacente que sirve como punto de referencia. Se puede usar para resolver más información sobre el punto de referencia a través de Place Details o Place ID Lookup. |
spatial_relationship |
Tipo:
SpatialRelationship Define la relación espacial entre la ubicación objetivo y el punto de referencia. |
straight_line_distance_meters |
Tipo:
number Es la 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 que se devolvió. Consulta Tipos para obtener más detalles. |
travel_distance_meters optional |
Tipo:
number optional Es 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 estar vacío si el punto de referencia está desconectado de la parte de la red de rutas más cercana al objetivo O si la ubicación objetivo no se consideró realmente que estaba en la red de rutas. |
Interfaz de 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 objetivo y el área. |
display_name |
Tipo:
string Es el nombre del área. |
display_name_language_code |
Tipo:
string Es el idioma del nombre del área. |
place_id |
Tipo:
string Es el ID de lugar del área subyacente. Se puede usar para resolver más información sobre el área a través de Place Details o Place ID Lookup. |
Constantes de contención
Constantes de google.maps.Containment
Es una enumeración que representa la relación espacial entre el área y la ubicación objetivo.
Llama al const {Containment} = await google.maps.importLibrary("geocoding")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
NEAR |
La ubicación de destino está 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 borde. |
WITHIN |
La ubicación objetivo se encuentra dentro de la región del área, cerca del centro. |
Constantes de SpatialRelationship
Constantes de google.maps.SpatialRelationship
Es una enumeración que representa la relación espacial entre el punto de referencia y el objetivo.
Llama al const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
ACROSS_THE_ROAD |
El destino se encuentra directamente frente al punto de referencia, del otro lado de la ruta. |
AROUND_THE_CORNER |
No está en la misma ruta que el punto de referencia, pero se encuentra a un solo giro de distancia. |
BEHIND |
Cerca de la estructura del punto de referencia, pero más lejos de su punto de acceso |
BESIDE |
El destino se encuentra directamente junto al punto de referencia. |
DOWN_THE_ROAD |
En la misma ruta que el punto de referencia, pero no al lado ni enfrente |
NEAR |
Esta es la relación predeterminada cuando no se aplica ninguna otra más específica a continuación. |
WITHIN |
El punto de referencia tiene una geometría espacial y el objetivo se encuentra dentro de sus límites. |