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

Waypoint

JSON representation

Encapsulates a waypoint. Waypoints mark both the beginning and end of a route, and include intermediate stops along the route.

JSON representation

JSON representation
{ "via": boolean, "vehicleStopover": boolean, "sideOfRoad": boolean, // Union field `location_type` can be only one of the following: "location": { object (`Location`) }, "placeId": string // End of list of possible types for union field `location_type`. }

{
  "via": boolean,
  "vehicleStopover": boolean,
  "sideOfRoad": boolean,

  // Union field location_type can be only one of the following:
  "location": {
    object (Location)
  },
  "placeId": string
  // End of list of possible types for union field location_type.
}

Fields
`via`	`boolean` Marks this waypoint as a milestone rather a stopping point. For each non-via waypoint in the request, the response appends an entry to the `legs` array to provide the details for stopovers on that leg of the trip. Set this value to true when you want the route to pass through this waypoint without stopping over. Via waypoints don't cause an entry to be added to the `legs` array, but they do route the journey through the waypoint. You can only set this value on waypoints that are intermediates. The request fails if you set this field on terminal waypoints. If `ComputeRoutesRequest.optimize_waypoint_order` is set to true then this field cannot be set to true; otherwise, the request fails.
`vehicleStopover`	`boolean` Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off. When you set this value, the calculated route won't include non-`via` waypoints on roads that are unsuitable for pickup and drop-off. This option works only for `DRIVE` and `TWO_WHEELER` travel modes, and when the `locationType` is `location`.
`sideOfRoad`	`boolean` Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option works only for 'DRIVE' and 'TWO_WHEELER' travel modes.
Union field `location_type`. Different ways to represent a location. `location_type` can be only one of the following:
`location`	`object (Location)` A point specified using geographic coordinates, including an optional heading.
`placeId`	`string` The POI Place ID associated with the waypoint.