Geocoder

Clase Geocoder

google.maps.Geocoder clase
biblioteca "geocoding"

Es un servicio para convertir una dirección en un LatLng y viceversa.

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

Constructor
Geocoder	Geocoder() Parámetros: Ninguno Crea una nueva instancia de un Geocoder que envía solicitudes de geocodificación a los servidores de 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 una solicitud.

Interfaz GeocoderRequest

Interfaz google.maps.GeocoderRequest

Es la especificación de una solicitud de geocodificación que se enviará a Geocoder.

Propiedades
address opcional	Tipo: string optional Es la dirección que se geocodificará. Se debe proporcionar solo uno de los valores address, location y placeId.
bounds opcional	Tipo: LatLngBounds|LatLngBoundsLiteral optional LatLngBounds en el que se realizará la búsqueda. Opcional.
componentRestrictions opcional	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 opcional	Aviso: Solo está disponible en el canal beta. 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 opcional	Tipo: boolean optional Cumple la promesa en un estado ZERO_RESULT en la respuesta. Esto puede ser conveniente porque, incluso sin resultados de geocodificación, es posible que se devuelvan campos adicionales a nivel de la respuesta.
language opcional	Tipo: string optional Es un identificador del idioma en el que se deben devolver los resultados, cuando sea posible. Consulta la lista de idiomas compatibles.
location opcional	Tipo: LatLng|LatLngLiteral optional LatLng (o LatLngLiteral) que se buscará. El geocodificador realiza una geocodificación inversa. Consulta Geocodificación inversa para obtener más información. Se debe proporcionar solo uno de los valores address, location y placeId.
placeId opcional	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 realiza una geocodificación inversa. Consulta Geocodificación inversa para obtener más información. Se debe proporcionar solo uno de los valores address, location y placeId.
region opcional	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 de dos caracteres (no numéricos) o un identificador CLDR. Opcional. Consulta los detalles de cobertura de Google Maps Platform para conocer las regiones admitidas.

Interfaz GeocoderComponentRestrictions

Interfaz 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 opcional	Tipo: string optional Coincide con todos los administrative_area levels. Opcional.
country opcional	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 opcional	Tipo: string optional Establece coincidencias con los tipos locality y sublocality. Opcional.
postalCode opcional	Tipo: string optional Coincide con postal_code y postal_code_prefix. Opcional.
route opcional	Tipo: string optional Establece coincidencias con el nombre largo o corto de un route. Opcional.

Constantes de ExtraGeocodeComputation

google.maps.ExtraGeocodeComputation constantes biblioteca
"geocoding"

Aviso: Solo está disponible en el canal beta.

Son los cálculos adicionales que se deben realizar mientras se completa una solicitud de geocodificación.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo ExtraGeocodeComputationString.

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

Constantes
ADDRESS_DESCRIPTORS	Generar un descriptor de dirección

Constantes de GeocoderStatus

google.maps.GeocoderStatus constantes biblioteca
"geocoding"

Es el estado que devuelve 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.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo GeocoderStatusString.

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

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 encontraron resultados para GeocoderRequest.

Interfaz GeocoderResponse

Interfaz google.maps.GeocoderResponse

Es una respuesta de Geocoder que devuelve el Geocoder y que contiene la lista de GeocoderResult.

Propiedades
results	Tipo: Array<GeocoderResult> Es la lista de GeocoderResult.
address_descriptor opcional	Aviso: Solo está disponible en el canal beta. 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 de segmentación. Solo se propaga para las solicitudes de geocodificación inversa y solo cuando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS está habilitado.
plus_code opcional	Tipo: PlacePlusCode optional Es el Plus Code asociado con la ubicación.

Interfaz GeocoderResult

Interfaz google.maps.GeocoderResult

Es un solo resultado del geocodificador que se recuperó 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 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> Es un array de cadenas que indica el tipo del elemento geocodificado que se devuelve. 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 opcional	Aviso: Solo está disponible en el canal beta. 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 de segmentación. Este campo solo se completará para las solicitudes de geocodificación directa y de búsqueda de ID de lugar, solo cuando ExtraGeocodeComputation.ADDRESS_DESCRIPTORS esté habilitado y solo para ciertos lugares localizados.
partial_match opcional	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 se trata de una coincidencia exacta, el valor será undefined.
plus_code opcional	Tipo: PlacePlusCode optional Es el Plus Code asociado con la ubicación.
postcode_localities opcional	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 google.maps.AddressDescriptor

Aviso: Solo está disponible en el canal beta.

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 de segmentación.

Propiedades
areas	Tipo: Array<Area> Es una lista clasificada de áreas contenidas o adyacentes. Las áreas más útiles (reconocibles y precisas) se clasifican primero.
landmarks	Tipo: Array<Landmark> 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 google.maps.GeocoderAddressComponent

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 breve y abreviado del componente de dirección determinado.
types	Tipo: Array<string> Es un array de cadenas que indica el tipo de este componente de dirección. Puedes encontrar una lista de tipos válidos aquí.

Interfaz GeocoderGeometry

Interfaz google.maps.GeocoderGeometry

Información de geometría sobre este GeocoderResult

Propiedades
location	Tipo: LatLng Son las coordenadas de latitud y longitud de este resultado.
location_type	Tipo: GeocoderLocationType Es el tipo de ubicación que se devuelve en location.
viewport	Tipo: LatLngBounds Son los límites del viewport recomendado para mostrar este GeocoderResult.
bounds opcional	Tipo: LatLngBounds optional Son los límites precisos de este GeocoderResult, si corresponde.

Constantes GeocoderLocationType

google.maps.GeocoderLocationType constantes biblioteca
"geocoding"

Describe el tipo de ubicación que se devuelve de un geocódigo. Especifica estos valores por valor o con el nombre de la constante. Por ejemplo, 'ROOFTOP' o google.maps.GeocoderLocationType.ROOFTOP.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo GeocoderLocationTypeString.

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

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 Landmark

Interfaz google.maps.Landmark

Aviso: Solo está disponible en el canal beta.

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 lugar del establecimiento subyacente que sirve como punto de referencia. Se puede usar para obtener más información sobre el punto de referencia a través de Place Details o ID de lugar 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 segmentación 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 opcional	Tipo: number optional Es la distancia de viaje por la red de rutas entre la ubicación de destino 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 a la ubicación de segmentación O BIEN si la ubicación de segmentación no se consideró como parte de la red de rutas.

Interfaz Area

Interfaz google.maps.Area

Aviso: Solo está disponible en el canal beta.

Un lugar que es una región pequeña, como un vecindario, una sublocalidad o un complejo grande que contiene la ubicación de segmentación.

Propiedades
containment	Tipo: Containment Define la relación espacial entre la ubicación de segmentación 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 obtener más información sobre el área a través de Place Details o la búsqueda de ID de lugar.

Constantes de contención

google.maps.Containment constantes biblioteca
"geocoding"

Aviso: Solo está disponible en el canal beta.

Es un enum que representa la relación espacial entre el área y la ubicación de segmentación.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo ContainmentString.

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

Constantes
NEAR	La ubicación de segmentación está fuera de la región del área, pero cerca.
OUTSKIRTS	La ubicación de segmentación se encuentra dentro de la región del área, cerca del borde.
WITHIN	La ubicación de segmentación se encuentra dentro de la región del área, cerca del centro.

Constantes de SpatialRelationship

google.maps.SpatialRelationship constantes biblioteca
"geocoding"

Aviso: Solo está disponible en el canal beta.

Es una enumeración que representa la relación en el espacio entre el punto de referencia y el objetivo.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo SpatialRelationshipString.

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

Constantes
ACROSS_THE_ROAD	El destino se encuentra justo enfrente del punto de referencia, del otro lado de la ruta.
AROUND_THE_CORNER	No está en la misma ruta que el punto de referencia, sino 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 objetivo está 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 de las opciones más específicas que se indican a continuación.
WITHIN	La referencia tiene una geometría espacial y el objetivo está dentro de sus límites.