Clase Geocoder
Clase google.maps.Geocoder
Es un servicio para convertir entre una dirección y un LatLng
.
Para acceder, llama a const {Geocoder} = await google.maps.importLibrary("geocoding")
. Consulta 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 geocódigo a los servidores de Google. |
Métodos | |
---|---|
geocode |
geocode(request[, callback]) Parámetros:
Valor que se muestra:
Promise<GeocoderResponse> Geocodifica una solicitud. |
Interfaz GeocoderRequest
Interfaz de google.maps.GeocoderRequest
Es la especificación de una solicitud de geocodificación que se enviará a Geocoder
.
Propiedades | |
---|---|
address optional |
Tipo:
string optional Es la dirección que se geocodificará. Se debe proporcionar uno, y solo uno, de address , location y placeId . |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional LatLngBounds en el que 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 , 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 Es 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 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 Un identificador de idioma para el idioma en el que se deben mostrar los resultados, siempre que sea posible. Consulta la lista de idiomas compatibles. |
location optional |
Tipo:
LatLng|LatLngLiteral optional LatLng (o LatLngLiteral ) para el que se debe realizar la búsqueda. 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 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 lugares 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 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 un identificador CLDR o una subetiqueta de región Unicode de dos caracteres (no numéricos). Opcional. Consulta los detalles de cobertura de Google Maps Platform para conocer las regiones admitidas. |
Interfaz GeocoderComponentRestrictions
Interfaz de google.maps.GeocoderComponentRestrictions
GeocoderComponentRestrictions
representa un conjunto de filtros que se resuelven en un área específica. Para obtener más información 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 de ExtraGeocodeComputation
Constantes de google.maps.ExtraGeocodeComputation
Cálculos adicionales que se deben realizar mientras se completa una solicitud de geocodificación.
Para acceder, llama a const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding")
. Consulta Bibliotecas de 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()
. Especifica estos valores 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 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 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 permitido 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 encontró ningún resultado para este GeocoderRequest . |
Interfaz GeocoderResponse
Interfaz de google.maps.GeocoderResponse
Una respuesta del geocodificador que muestra Geocoder
y que contiene la lista de GeocoderResult
.
Propiedades | |
---|---|
results |
Tipo:
Array<GeocoderResult> La lista de GeocoderResult . |
address_descriptor optional |
Tipo:
AddressDescriptor optional Es una descripción relacional de una ubicación. Incluye un conjunto clasificado de lugares de interés cercanos y las áreas que contienen la ubicación de destino. 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 con la ubicación. |
Interfaz GeocoderResult
Interfaz de google.maps.GeocoderResult
Un solo resultado del geocodificador recuperado del servidor de geocodificación. 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 indirectamente 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 Place en la guía para desarrolladores de la API de Places. |
types |
Tipo:
Array<string> Es un array de cadenas que indica el tipo del elemento geocodificado que se muestra. Para obtener una lista de 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 lugares de interés cercanos y las áreas que contienen la ubicación de destino. Solo se propagará para las solicitudes de geocodificación directa y de búsqueda de ID de lugar, solo cuando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS esté habilitada y solo para ciertos lugares localizados. |
partial_match optional |
Tipo:
boolean optional Indica si el geocodificador no mostró una concordancia exacta para la solicitud original, aunque sí encontró una coincidencia parcial para la dirección solicitada. Si es una concordancia exacta, el valor será undefined . |
plus_code optional |
Tipo:
PlacePlusCode optional Es el código plus asociado con 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 lugares de interés cercanos y las áreas que contienen la ubicación de destino.
Propiedades | |
---|---|
areas |
Es una lista clasificada de áreas adyacentes o que contienen el área de interés. Las áreas más útiles (reconocibles y precisas) se clasifican primero. |
landmarks |
Una lista clasificada de lugares de interés cercanos. Los lugares de interés 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.
Propiedades | |
---|---|
long_name |
Tipo:
string Es el texto completo del componente de la dirección. |
short_name |
Tipo:
string Es el texto abreviado y breve del componente de la dirección determinado. |
types |
Tipo:
Array<string> Es un array de cadenas que indican el tipo de este componente de dirección. Puedes encontrar una lista de los tipos válidos aquí. |
Interfaz GeocoderGeometry
Interfaz de google.maps.GeocoderGeometry
Información geométrica 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 Los 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 un geocódigo. Especifica estos valores 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 Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
APPROXIMATE |
El resultado que se muestra es aproximado. |
GEOMETRIC_CENTER |
El resultado que se muestra refleja 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 lugares de interés
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 Es el ID de Place del establecimiento subyacente que funciona como punto de referencia. Se puede usar para obtener más información sobre el lugar de interés a través de 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 Es la distancia en línea recta entre la ubicación de destino y el punto de referencia. |
types |
Tipo:
Array<string> Uno o más valores que indican el tipo de resultado que se muestra. 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 de destino y el punto de referencia. Este valor puede no propagarse si el punto de referencia está desconectado de la parte de la red de rutas a la que está más cerca el destino O si la ubicación de destino no se consideró en la red de rutas. |
Interfaz de Area
Interfaz de google.maps.Area
Un lugar que es una región pequeña, como un vecindario, una sublocalidad o un complejo grande que contiene la ubicación de destino.
Propiedades | |
---|---|
containment |
Tipo:
Containment Define la relación espacial entre la ubicación de destino 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 El ID de Place de la zona subyacente Se puede usar para obtener 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 de destino.
Para acceder, llama a const {Containment} = await google.maps.importLibrary("geocoding")
. Consulta Bibliotecas de 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 objetivo está dentro de la región del área, cerca del borde. |
WITHIN |
La ubicación objetivo está 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 en el espacio entre el punto de referencia y el objetivo.
Para acceder, llama a const {SpatialRelationship} = await google.maps.importLibrary("geocoding")
. Consulta Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
ACROSS_THE_ROAD |
El destino está directamente enfrente del punto de referencia, al otro lado de la ruta. |
AROUND_THE_CORNER |
No está en la misma ruta que el punto de referencia, pero está a una sola vuelta de distancia. |
BEHIND |
Cerca de la estructura del lugar de interés, pero más lejos de su punto de acceso |
BESIDE |
El objetivo está directamente junto al punto de referencia. |
DOWN_THE_ROAD |
En la misma ruta que el punto de referencia, pero no al lado o 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. |