Clase DistanceMatrixService
Clase google.maps.DistanceMatrixService
Un servicio para calcular distancias entre varios orígenes y destinos.
Para acceder, llama a const {DistanceMatrixService} = await google.maps.importLibrary("routes")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constructor | |
---|---|
DistanceMatrixService |
DistanceMatrixService() Parámetros: Ninguno
Crea una nueva instancia de un DistanceMatrixService que envía consultas de matrices de distancia a los servidores de Google. |
Métodos | |
---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback]) Parámetros:
Valor que se devuelve:
Promise<DistanceMatrixResponse> Emite una solicitud de Distance Matrix. |
Interfaz de DistanceMatrixRequest
Interfaz de google.maps.DistanceMatrixRequest
Una consulta de matriz de distancia enviada por DistanceMatrixService
que contiene arrays de ubicaciones de origen y destino, y varias opciones para calcular métricas.
Propiedades | |
---|---|
destinations |
Tipo:
Array<string|LatLng|LatLngLiteral|Place> Un array que contiene strings de dirección de destino, o bien objetos LatLng o Place , a los que se calcula la distancia y el tiempo. Obligatorio. |
origins |
Tipo:
Array<string|LatLng|LatLngLiteral|Place> Un array que contiene strings de dirección de origen, o bien objetos LatLng o Place , desde los que se calcula la distancia y el tiempo. Obligatorio. |
travelMode |
Tipo:
TravelMode Tipo de enrutamiento solicitado. Obligatorio. |
avoidFerries optional |
Tipo:
boolean optional Si el valor es true , le indica al servicio Distance Matrix que evite los transbordadores siempre que sea posible. Opcional. |
avoidHighways optional |
Tipo:
boolean optional Si el valor es true , le indica al servicio Distance Matrix que evite las autopistas siempre que sea posible. Opcional. |
avoidTolls optional |
Tipo:
boolean optional Si el valor es true , le indica al servicio Distance Matrix que evite las rutas con peaje siempre que sea posible. Opcional. |
drivingOptions optional |
Tipo:
DrivingOptions optional Configuración que se aplica solo a las solicitudes en las que travelMode es DRIVING . Este objeto no tendrá efecto en otros medios de transporte. |
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. |
region optional |
Tipo:
string optional Es el código de región que se usa como personalización para las solicitudes de geocodificación. El código de región acepta un valor de ccTLD ("dominio de nivel superior") de dos caracteres. La mayoría de los códigos ccTLD son idénticos a los códigos ISO 3166-1, con algunas excepciones notables. Por ejemplo, el ccTLD del Reino Unido es "uk" ( .co.uk ), mientras que su código ISO 3166-1 es "gb" (técnicamente para la entidad del "Reino Unido de Gran Bretaña e Irlanda del Norte"). |
transitOptions optional |
Tipo:
TransitOptions optional Configuración que se aplica solo a las solicitudes en las que travelMode es TRANSIT. Este objeto no tendrá efecto en otros medios de transporte. |
unitSystem optional |
Tipo:
UnitSystem optional Sistema de unidades preferido que se debe usar para mostrar la distancia. Opcional; el valor predeterminado es la métrica. |
DistanceMatrixResponse
Interfaz de google.maps.DistanceMatrixResponse
Es la respuesta a una solicitud DistanceMatrixService
, que consta de las direcciones de origen y destino con formato, y una secuencia de DistanceMatrixResponseRow
, una para cada dirección de origen correspondiente.
Propiedades | |
---|---|
destinationAddresses |
Tipo:
Array<string> Son las direcciones de destino con formato. |
originAddresses |
Tipo:
Array<string> Las direcciones de origen con formato. |
rows |
Tipo:
Array<DistanceMatrixResponseRow> Las filas de la matriz correspondientes a las direcciones de origen. |
Interfaz de DistanceMatrixResponseRow
Interfaz de google.maps.DistanceMatrixResponseRow
Es una fila de la respuesta a una solicitud de DistanceMatrixService
, que consta de una secuencia de DistanceMatrixResponseElement
, una para cada dirección de destino correspondiente.
Propiedades | |
---|---|
elements |
Los elementos de la fila que corresponden a las direcciones de destino. |
DistanceMatrixResponseElement
Interfaz de google.maps.DistanceMatrixResponseElement
Un único elemento de una respuesta a una solicitud DistanceMatrixService
, que contiene la duración y la distancia de un origen a un destino.
Propiedades | |
---|---|
distance |
Tipo:
Distance La distancia para esta vinculación de origen y destino. Es posible que esta propiedad no esté definida porque se desconoce la distancia. |
duration |
Tipo:
Duration Es la duración de esta vinculación de origen y destino. Es posible que esta propiedad no esté definida, ya que se desconoce la duración. |
duration_in_traffic |
Tipo:
Duration Es la duración de esta vinculación de origen y destino, teniendo en cuenta las condiciones de tráfico que indica la propiedad trafficModel . Esta propiedad puede ser undefined , ya que se desconoce la duración. Solo está disponible para los clientes del plan Premium cuando se define drivingOptions en la solicitud. |
fare |
Tipo:
TransitFare La tarifa total de esta vinculación de origen y destino. Solo se aplica a las solicitudes de transporte público. |
status |
El estado de esta vinculación de origen-destino en particular. |
Constantes de DistanceMatrixStatus
Constantes google.maps.DistanceMatrixStatus
Es el estado de nivel superior de la solicitud en general que muestra DistanceMatrixService
cuando se completa una solicitud de Distance Matrix. Especifícalas por valor o con el nombre de la constante. Por ejemplo, 'OK'
o google.maps.DistanceMatrixStatus.OK
.
Para acceder, llama a const {DistanceMatrixStatus} = await google.maps.importLibrary("routes")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
INVALID_REQUEST |
La solicitud proporcionada no es válida. |
MAX_DIMENSIONS_EXCEEDED |
La solicitud contiene más de 25 orígenes o más de 25 destinos. |
MAX_ELEMENTS_EXCEEDED |
El producto de orígenes y destinos supera el límite por consulta. |
OK |
la respuesta contiene un resultado válido. |
OVER_QUERY_LIMIT |
Se solicitaron demasiados elementos durante el período permitido. La solicitud debería completarse con éxito si realizas un nuevo intento después de un tiempo. |
REQUEST_DENIED |
El servicio rechazó el uso del servicio Distance Matrix en tu página web. |
UNKNOWN_ERROR |
No se pudo procesar una solicitud de Distance Matrix debido a un error del servidor. La solicitud podría completarse si realizas un nuevo intento. |
Constantes de DistanceMatrixElementStatus
Constantes google.maps.DistanceMatrixElementStatus
El estado a nivel de elemento sobre una vinculación de origen-destino en particular que muestra DistanceMatrixService
cuando se completa una solicitud de matriz de distancia. Estos valores se especifican como cadenas, por ejemplo, 'OK'
.
Para acceder, llama a const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
NOT_FOUND |
No se pudo geocodificar el origen o el destino de este par. |
OK |
la respuesta contiene un resultado válido. |
ZERO_RESULTS |
No se encontró ninguna ruta entre el origen y el destino. |