Method: computeRoutes

Devuelve la ruta principal entre el origen y el destino solicitados para el medio de transporte solicitado.

Solicitud HTTP

POST https://mapstools.googleapis.com/v1alpha:computeRoutes

La URL usa la sintaxis de la transcodificación de gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "travelMode": enum (RouteTravelMode),
  "intermediateWaypoints": [
    {
      object (Waypoint)
    }
  ],
  "routingPreference": enum (RoutingPreference),
  "locationBias": {
    object (LatLng)
  },
  "includePolyline": boolean,
  "computeAlternativeRoutes": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "departureTime": string,
  "arrivalTime": string
  // End of mutually exclusive fields.
}
Campos
origin

object (Waypoint)

Obligatorio. Es el punto de referencia de origen.

destination

object (Waypoint)

Obligatorio. Es el punto de referencia de destino.

travelMode

enum (RouteTravelMode)

Opcional. Especifica el medio de transporte.

intermediateWaypoints[]

object (Waypoint)

Opcional. Son las paradas intermedias entre el origen y el destino por las que se debe pasar en orden. Se admiten hasta 25 puntos de referencia intermedios.

Si especificas más de 10 puntos de referencia intermedios, se generarán costos y latencia más altos. No se admiten puntos de referencia intermedios cuando travelMode es TRANSIT.

routingPreference

enum (RoutingPreference)

Opcional. Determina cómo se usan los datos de tráfico para calcular la ruta. ROUTING_PREFERENCE_TRAFFIC_AWARE_OPTIMAL no se admite cuando travelMode es WALK o BICYCLE. En el caso de TRANSIT, habilita los datos de transporte público en tiempo real, como retrasos y cancelaciones.

locationBias

object (LatLng)

Opcional. Es una ubicación para sesgar los resultados de la búsqueda, por ejemplo, para eliminar la ambigüedad de las búsquedas de texto de puntos de referencia.

includePolyline

boolean

Opcional. Indica si se debe incluir la polilínea codificada en las rutas de respuesta. La configuración predeterminada es false. Cuando se establece en true, se devuelve Route.encoded_polyline.

computeAlternativeRoutes

boolean

Opcional. Indica si se deben calcular rutas alternativas además de la ruta recomendada. El valor predeterminado es falso, en cuyo caso solo se devuelve la ruta recomendada. Cuando se establece en verdadero, se devuelven todas las rutas disponibles, aunque es posible que no haya alternativas para cada solicitud.

Especifica cuándo salir del origen o llegar al punto de referencia final. Si no se especifica, el valor predeterminado es la hora actual. Para TRANSIT, la hora debe ser como máximo 7 días en el pasado y 100 días en el futuro. Para otros medios de transporte, la hora no debe ser en el pasado y debe ser, como máximo, 365 días en el futuro. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
departureTime

string (Timestamp format)

Opcional. Indica que la ruta se debe calcular en función de la hora de salida.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

arrivalTime

string (Timestamp format)

Opcional. Indica que la ruta se debe calcular en función de la hora de llegada.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Fin de los campos mutuamente excluyentes.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ComputeRoutesResponse.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/maps-platform.mapstools