vehicles.search
response message.
JSON representation |
---|
{
"matches": [
{
object ( |
Fields | |
---|---|
matches[] |
List of vehicles that match the |
VehicleMatch
Contains the vehicle and related estimates for a vehicle that match the points of active trips for the vehicle SearchVehiclesRequest
.
JSON representation |
---|
{ "vehicle": { object ( |
Fields | |
---|---|
vehicle |
Required. A vehicle that matches the request. |
vehiclePickupEta |
The vehicle's driving ETA to the pickup point specified in the request. An empty value indicates a failure in calculating ETA for the vehicle. If A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
vehiclePickupDistanceMeters |
The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance. |
vehiclePickupStraightLineDistanceMeters |
Required. The straight-line distance between the vehicle and the pickup point specified in the request. |
vehicleDropoffEta |
The complete vehicle's driving ETA to the drop off point specified in the request. The ETA includes stopping at any waypoints before the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
vehiclePickupToDropoffDistanceMeters |
The vehicle's driving distance (in meters) from the pickup point to the drop off point specified in the request. The distance is only between the two points and does not include the vehicle location or any other points that must be visited before the vehicle visits either the pickup point or dropoff point. The value will only be populated when a |
tripType |
Required. The trip type of the request that was used to calculate the ETA to the pickup point. |
vehicleTripsWaypoints[] |
The ordered list of waypoints used to calculate the ETA. The list includes vehicle location, the pickup points of active trips for the vehicle, and the pickup points provided in the request. An empty list indicates a failure in calculating ETA for the vehicle. |
vehicleMatchType |
Type of the vehicle match. |
requestedOrderedBy |
The order requested for sorting vehicle matches. |
orderedBy |
The actual order that was used for this vehicle. Normally this will match the 'orderBy' field from the request; however, in certain circumstances such as an internal server error, a different method may be used (such as |
Waypoint
Describes intermediate points along a route.
JSON representation |
---|
{
"latLng": {
object ( |
Fields | |
---|---|
latLng |
The location of this waypoint. |
eta |
The estimated time that the vehicle will arrive at this waypoint. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
VehicleMatchType
Type of vehicle match.
Enums | |
---|---|
UNKNOWN |
Unknown vehicle match type |
EXCLUSIVE |
The vehicle currently has no trip assigned to it and can proceed to the pickup point. |
BACK_TO_BACK |
The vehicle is currently assigned to a trip, but can proceed to the pickup point after completing the in-progress trip. ETA and distance calculations take the existing trip into account. |
CARPOOL |
The vehicle has sufficient capacity for a shared ride. |
CARPOOL_BACK_TO_BACK |
The vehicle will finish its current, active trip before proceeding to the pickup point. ETA and distance calculations take the existing trip into account. |