TripWaypoint
Stay organized with collections
Save and categorize content based on your preferences.
Describes a stopping point on a vehicle's route or an ending point on a vehicle's trip.
| JSON representation |
{
"location": {
object (TerminalLocation)
},
"tripId": string,
"waypointType": enum (WaypointType),
"pathToWaypoint": [
{
object (LatLng)
}
],
"encodedPathToWaypoint": string,
"trafficToWaypoint": {
object (ConsumableTrafficPolyline)
},
"distanceMeters": integer,
"eta": string,
"duration": string
} |
| Fields |
location |
object (TerminalLocation)
The location of this waypoint.
|
tripId |
string
The trip associated with this waypoint.
|
waypointType |
enum (WaypointType)
The role this waypoint plays in this trip, such as pickup or dropoff.
|
pathToWaypoint[] |
object (LatLng)
The path from the previous waypoint to the current waypoint. If this is the first waypoint, the path is from the vehicle's current location to the waypoint. This field is only populated when requested.
|
encodedPathToWaypoint |
string
The encoded path from the previous waypoint to the current waypoint. Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.
|
trafficToWaypoint |
object (ConsumableTrafficPolyline)
The traffic conditions along the path to this waypoint. Note that traffic is only available for Google Map Platform Rides and Deliveries Solution customers.
|
distanceMeters |
integer
The path distance from the previous waypoint to the current waypoint. If this is the first waypoint, the path distance is from the vehicle's current location to the waypoint.
|
eta |
string (Timestamp format)
The estimated time of arrival at this waypoint. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
|
duration |
string (Duration format)
The travel time from previous waypoint to this waypoint. If this is the first waypoint, the travel time is from the vehicle's current location to the waypoint. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-21 UTC."],[[["\u003cp\u003eWaypoints represent stopping points or ending points on a vehicle's route or trip.\u003c/p\u003e\n"],["\u003cp\u003eEach waypoint includes information like location, trip ID, type (pickup, dropoff), path, and estimated arrival time.\u003c/p\u003e\n"],["\u003cp\u003eWaypoints can optionally include details about the path to the waypoint, traffic conditions, and distance.\u003c/p\u003e\n"],["\u003cp\u003eThe ETA and duration fields provide estimates for arrival time and travel time to the waypoint.\u003c/p\u003e\n"]]],["This data represents a waypoint, a stopping or ending point in a vehicle's trip. Key information includes the `location`, the associated `tripId`, and the `waypointType` (e.g., pickup, dropoff). It also provides path details like `pathToWaypoint`, `encodedPathToWaypoint`, and `trafficToWaypoint`, alongside metrics such as `distanceMeters`, `eta` (estimated time of arrival), and `duration` (travel time). Some data, like path details and time-related metrics, are undefined for the initial waypoint.\n"],null,["- [JSON representation](#SCHEMA_REPRESENTATION)\n\nDescribes a stopping point on a vehicle's route or an ending point on a vehicle's trip.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"location\": { object (/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/TerminalLocation) }, \"tripId\": string, \"waypointType\": enum (/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/WaypointType), \"pathToWaypoint\": [ { object (/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/LatLng) } ], \"encodedPathToWaypoint\": string, \"trafficToWaypoint\": { object (/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/ConsumableTrafficPolyline) }, \"distanceMeters\": integer, \"eta\": string, \"duration\": string } ``` |\n\n| Fields ||\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `location` | `object (`[TerminalLocation](/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/TerminalLocation)`)` The location of this waypoint. |\n| `tripId` | `string` The trip associated with this waypoint. |\n| `waypointType` | `enum (`[WaypointType](/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/WaypointType)`)` The role this waypoint plays in this trip, such as pickup or dropoff. |\n| `pathToWaypoint[]` | `object (`[LatLng](/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/LatLng)`)` The path from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list. This field is only populated when requested. |\n| `encodedPathToWaypoint` | `string` The encoded path from the previous waypoint to the current waypoint. \u003cbr /\u003e Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported. |\n| `trafficToWaypoint` | `object (`[ConsumableTrafficPolyline](/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/ConsumableTrafficPolyline)`)` The traffic conditions along the path to this waypoint. Note that traffic is only available for Google Map Platform Rides and Deliveries Solution customers. |\n| `distanceMeters` | `integer` The path distance from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list. |\n| `eta` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` The estimated time of arrival at this waypoint. Undefined for the first waypoint in a list. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `duration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` The travel time from previous waypoint to this point. Undefined for the first waypoint in a list. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |"]]
