Routes Preferred API is currently available only to select customers. Contact sales to learn more.

ComputeRoutesRequest

JSON representation

v1alpha.computeRoutes request message.

JSON representation

JSON representation
{ "origin": { object (`Waypoint`) }, "destination": { object (`Waypoint`) }, "intermediates": [ { object (`Waypoint`) } ], "travelMode": enum (`RouteTravelMode`), "routingPreference": enum (`RoutingPreference`), "polylineQuality": enum (`PolylineQuality`), "polylineEncoding": enum (`PolylineEncoding`), "departureTime": string, "computeAlternativeRoutes": boolean, "routeModifiers": { object (`RouteModifiers`) }, "languageCode": string, "units": enum (`Units`), "optimizeWaypointOrder": boolean }

{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean
}

Fields
`origin`	`object (Waypoint)` Required. Origin waypoint.
`destination`	`object (Waypoint)` Required. Destination waypoint.
`intermediates[]`	`object (Waypoint)` Optional. A set of waypoints along the route (excluding terminal points), for either stopping at or passing by. Up to 25 intermediate waypoints are supported.
`travelMode`	`enum (RouteTravelMode)` Optional. Specifies the mode of transportation.
`routingPreference`	`enum (RoutingPreference)` Optional. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, then an error is returned. In the future, we might implement a fallback mechanism to use a different option when the preferred option does not give a valid result. You can specify this option only when the `travelMode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
`polylineQuality`	`enum (PolylineQuality)` Optional. Specifies your preference for the quality of the polyline.
`polylineEncoding`	`enum (PolylineEncoding)` Optional. Specifies the preferred encoding for the polyline.
`departureTime`	`string (Timestamp format)` Optional. The departure time. If you don't set this value, then this value defaults to the time that you made the request. If you set this value to a time that has already occurred, then the request fails. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`computeAlternativeRoutes`	`boolean` Specifies whether to calculate alternate routes in addition to the route.
`routeModifiers`	`object (RouteModifiers)` Optional. A set of conditions to satisfy that affect the way routes are calculated.
`languageCode`	`string` Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the route request.
`units`	`enum (Units)` Optional. Specifies the units of measure for the display fields. This includes the `instruction` field in `NavigationInstruction`. The units of measure used for the route, leg, step distance, and duration are not affected by this value. If you don't provide this value, then the display units are inferred from the location of the request.
`optimizeWaypointOrder`	`boolean` If optimizeWaypointOrder is set to true, an attempt is made to re-order the specified intermediate waypoints to minimize the overall cost of the route. If any of the intermediate waypoints is via waypoint the request fails. Use ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index to find the new ordering. If routes.optimized_intermediate_waypoint_index is not requested in the `X-Goog-FieldMask` header, the request fails. If optimizeWaypointOrder is set to false, ComputeRoutesResponse.optimized_intermediate_waypoint_index is empty.