Method: computeRoutes

{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "optimizedIntermediateWaypointIndex": [
    integer
  ],
  "localizedValues": {
    object (RouteLocalizedValues)
  },
  "routeToken": string
}

enum (RouteLabel)

Labels for the Route that are useful to identify specific properties of the route to compare against others.

object (RouteLeg)

A collection of legs (path segments between waypoints) that make up the route. Each leg corresponds to the trip between two non-via Waypoints. For example, a route with no intermediate waypoints has only one leg. A route that includes one non-via intermediate waypoint has two legs. A route that includes one via intermediate waypoint has one leg. The order of the legs matches the order of waypoints from origin to intermediates to destination.

integer

The travel distance of the route, in meters.

string (Duration format)

The length of time needed to navigate the route. If you set the routingPreference to TRAFFIC_UNAWARE, then this value is the same as staticDuration. If you set the routingPreference to either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL, then this value is calculated taking traffic conditions into account.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

string (Duration format)

The duration of travel through the route without taking traffic conditions into consideration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (Polyline)

The overall route polyline. This polyline is the combined polyline of all legs.

string

A description of the route.

string

An array of warnings to show when displaying the route.

object (Viewport)

The viewport bounding box of the polyline.

object (RouteTravelAdvisory)

Additional information about the route.

integer

If you set optimizeWaypointOrder to true, this field contains the optimized ordering of intermediate waypoints. Otherwise, this field is empty. For example, if you give an input of Origin: LA; Intermediate waypoints: Dallas, Bangor, Phoenix; Destination: New York; and the optimized intermediate waypoint order is Phoenix, Dallas, Bangor, then this field contains the values [2, 0, 1]. The index starts with 0 for the first intermediate waypoint provided in the input.

object (RouteLocalizedValues)

Text representations of properties of the Route.

string

A web-safe, base64-encoded route token that can be passed to the Navigation SDK, that allows the Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when you created the route by calling v2.computeRoutes. Customers should treat this token as an opaque blob. It is not meant for reading or mutating. NOTE: Route.route_token is only available for requests that have set ComputeRoutesRequest.routing_preference to TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL. Route.route_token is not supported for requests that have Via waypoints.

{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegLocalizedValues)
  },
  "stepsOverview": {
    object (StepsOverview)
  }
}

integer

The travel distance of the route leg, in meters.

string (Duration format)

The length of time needed to navigate the leg. If the route_preference is set to TRAFFIC_UNAWARE, then this value is the same as staticDuration. If the route_preference is either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL, then this value is calculated taking traffic conditions into account.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

string (Duration format)

The duration of travel through the leg, calculated without taking traffic conditions into consideration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (Polyline)

The overall polyline for this leg that includes each step's polyline.

object (Location)

The start location of this leg. This location might be different from the provided origin. For example, when the provided origin is not near a road, this is a point on the road.

object (Location)

The end location of this leg. This location might be different from the provided destination. For example, when the provided destination is not near a road, this is a point on the road.

object (RouteLegStep)

An array of steps denoting segments within this leg. Each step represents one navigation instruction.

object (RouteLegTravelAdvisory)

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a route leg.

object (RouteLegLocalizedValues)

Text representations of properties of the RouteLeg.

object (StepsOverview)

Overview information about the steps in this RouteLeg. This field is only populated for TRANSIT routes.

{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string,
  "geoJsonLinestring": {
    object
  }
  // End of list of possible types for union field polyline_type.
}

string

The string encoding of the polyline using the polyline encoding algorithm

object (Struct format)

Specifies a polyline using the GeoJSON LineString format.

{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelAdvisory": {
    object (RouteLegStepTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegStepLocalizedValues)
  },
  "transitDetails": {
    object (RouteLegStepTransitDetails)
  },
  "travelMode": enum (RouteTravelMode)
}

integer

The travel distance of this step, in meters. In some circumstances, this field might not have a value.

string (Duration format)

The duration of travel through this step without taking traffic conditions into consideration. In some circumstances, this field might not have a value.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (Polyline)

The polyline associated with this step.

object (Location)

The start location of this step.

object (Location)

The end location of this step.

object (NavigationInstruction)

Navigation instructions.

object (RouteLegStepTravelAdvisory)

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a leg step.

object (RouteLegStepLocalizedValues)

Text representations of properties of the RouteLegStep.

object (RouteLegStepTransitDetails)

Details pertaining to this step if the travel mode is TRANSIT.

enum (RouteTravelMode)

The travel mode used for this step.

{
  "maneuver": enum (Maneuver),
  "instructions": string
}

enum (Maneuver)

Encapsulates the navigation instructions for the current step (for example, turn left, merge, or straight). This field determines which icon to display.

string

Instructions for navigating this step.

{
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}

object (SpeedReadingInterval)

NOTE: This field is not currently populated.

{
  "distance": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}

object (LocalizedText)

Travel distance represented in text form.

object (LocalizedText)

Duration without taking traffic conditions into consideration, represented in text form.

{
  "stopDetails": {
    object (TransitStopDetails)
  },
  "localizedValues": {
    object (TransitDetailsLocalizedValues)
  },
  "headsign": string,
  "headway": string,
  "transitLine": {
    object (TransitLine)
  },
  "stopCount": integer,
  "tripShortText": string
}

object (TransitStopDetails)

Information about the arrival and departure stops for the step.

object (TransitDetailsLocalizedValues)

Text representations of properties of the RouteLegStepTransitDetails.

string

Specifies the direction in which to travel on this line as marked on the vehicle or at the departure stop. The direction is often the terminus station.

string (Duration format)

Specifies the expected time as a duration between departures from the same stop at this time. For example, with a headway seconds value of 600, you would expect a ten minute wait if you should miss your bus.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (TransitLine)

Information about the transit line used in this step.

integer

The number of stops from the departure to the arrival stop. This count includes the arrival stop, but excludes the departure stop. For example, if your route leaves from Stop A, passes through stops B and C, and arrives at stop D, stopCount will return 3.

string

The text that appears in schedules and sign boards to identify a transit trip to passengers. The text should uniquely identify a trip within a service day. For example, "538" is the tripShortText of the Amtrak train that leaves San Jose, CA at 15:10 on weekdays to Sacramento, CA.

{
  "arrivalStop": {
    object (TransitStop)
  },
  "arrivalTime": string,
  "departureStop": {
    object (TransitStop)
  },
  "departureTime": string
}

object (TransitStop)

Information about the arrival stop for the step.

string (Timestamp format)

The estimated time of arrival for the step.

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".

object (TransitStop)

Information about the departure stop for the step.

string (Timestamp format)

The estimated time of departure for the step.

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".

{
  "name": string,
  "location": {
    object (Location)
  }
}

string

The name of the transit stop.

object (Location)

The location of the stop expressed in latitude/longitude coordinates.

{
  "arrivalTime": {
    object (LocalizedTime)
  },
  "departureTime": {
    object (LocalizedTime)
  }
}

object (LocalizedTime)

Time in its formatted text representation with a corresponding time zone.

object (LocalizedTime)

Time in its formatted text representation with a corresponding time zone.

{
  "time": {
    object (LocalizedText)
  },
  "timeZone": string
}

object (LocalizedText)

The time specified as a string in a given time zone.

string

Contains the time zone. The value is the name of the time zone as defined in the IANA Time Zone Database, e.g. "America/New_York".

{
  "agencies": [
    {
      object (TransitAgency)
    }
  ],
  "name": string,
  "uri": string,
  "color": string,
  "iconUri": string,
  "nameShort": string,
  "textColor": string,
  "vehicle": {
    object (TransitVehicle)
  }
}

object (TransitAgency)

The transit agency (or agencies) that operates this transit line.

string

The full name of this transit line, For example, "8 Avenue Local".

string

the URI for this transit line as provided by the transit agency.

string

The color commonly used in signage for this line. Represented in hexadecimal.

string

The URI for the icon associated with this line.

string

The short name of this transit line. This name will normally be a line number, such as "M7" or "355".

string

The color commonly used in text on signage for this line. Represented in hexadecimal.

object (TransitVehicle)

The type of vehicle that operates on this transit line.

{
  "name": string,
  "phoneNumber": string,
  "uri": string
}

string

The name of this transit agency.

string

The transit agency's locale-specific formatted phone number.

string

The transit agency's URI.

{
  "name": {
    object (LocalizedText)
  },
  "type": enum (TransitVehicleType),
  "iconUri": string,
  "localIconUri": string
}

object (LocalizedText)

The name of this vehicle, capitalized.

enum (TransitVehicleType)

The type of vehicle used.

string

The URI for an icon associated with this vehicle type.

string

The URI for the icon associated with this vehicle type, based on the local transport signage.

{
  "tollInfo": {
    object (TollInfo)
  },
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}

object (TollInfo)

Contains information about tolls on the specific RouteLeg. This field is only populated if we expect there are tolls on the RouteLeg. If this field is set but the estimatedPrice subfield is not populated, we expect that road contains tolls but we do not know an estimated price. If this field does not exist, then there is no toll on the RouteLeg.

object (SpeedReadingInterval)

Speed reading intervals detailing traffic density. Applicable in case of TRAFFIC_AWARE and TRAFFIC_AWARE_OPTIMAL routing preferences. The intervals cover the entire polyline of the RouteLeg without overlap. The start point of a specified interval is the same as the end point of the preceding interval.

Example:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G).

{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}

object (LocalizedText)

Travel distance represented in text form.

object (LocalizedText)

Duration taking traffic conditions into consideration represented in text form. Note: If you did not request traffic information, this value will be the same value as staticDuration.

object (LocalizedText)

Duration without taking traffic conditions into consideration, represented in text form.

{
  "multiModalSegments": [
    {
      object (MultiModalSegment)
    }
  ]
}

object (MultiModalSegment)

Summarized information about different multi-modal segments of the RouteLeg.steps. This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

{
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelMode": enum (RouteTravelMode),
  "stepStartIndex": integer,
  "stepEndIndex": integer
}

object (NavigationInstruction)

NavigationInstruction for the multi-modal segment.

enum (RouteTravelMode)

The travel mode of the multi-modal segment.

integer

The corresponding RouteLegStep index that is the start of a multi-modal segment.

integer

The corresponding RouteLegStep index that is the end of a multi-modal segment.

{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}

object (LatLng)

Required. The low point of the viewport.

object (LatLng)

Required. The high point of the viewport.

{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}

object (LocalizedText)

Travel distance represented in text form.

object (LocalizedText)

Duration taking traffic conditions into consideration, represented in text form. Note: If you did not request traffic information, this value will be the same value as staticDuration.

object (LocalizedText)

Duration without taking traffic conditions into consideration, represented in text form.

object (LocalizedText)

Transit fare represented in text form.

{
  "origin": {
    object (GeocodedWaypoint)
  },
  "destination": {
    object (GeocodedWaypoint)
  },
  "intermediates": [
    {
      object (GeocodedWaypoint)
    }
  ]
}

object (GeocodedWaypoint)

Origin geocoded waypoint.

object (GeocodedWaypoint)

Destination geocoded waypoint.

object (GeocodedWaypoint)

A list of intermediate geocoded waypoints each containing an index field that corresponds to the zero-based position of the waypoint in the order they were specified in the request.

{
  "geocoderStatus": {
    object (Status)
  },
  "type": [
    string
  ],
  "partialMatch": boolean,
  "placeId": string,
  "intermediateWaypointRequestIndex": integer
}

object (Status)

Indicates the status code resulting from the geocoding operation.

string

The type(s) of the result, in the form of zero or more type tags. Supported types: Address types and address component types.

boolean

Indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address.

string

The place ID for this result.

integer

The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint.