Package maps.fleetengine.v1

BatteryStatus

Status of the battery, whether full or charging etc.

PowerSource

Status of battery power source.

float

Current battery percentage [0-100].

SpeedReadingInterval

Traffic speed along the path from the previous waypoint to the current waypoint.

string

The path the driver is taking from the previous waypoint to the current waypoint. This path has landmarks in it so clients can show traffic markers along the path (see speed_reading_interval). Decoding is not yet supported.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

string

Required. Unique Trip ID. Subject to the following restrictions:

• Must be a valid Unicode string.
• Limited to a maximum length of 64 characters.
• Normalized according to Unicode Normalization Form C.
• May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.

Trip

Required. Trip entity to create.

When creating a Trip, the following fields are required:

• trip_type
• pickup_point

The following fields are used if you provide them:

• number_of_passengers
• vehicle_id
• dropoff_point
• intermediate_destinations
• vehicle_waypoints

All other Trip fields are ignored. For example, all trips start with a trip_status of NEW even if you pass in a trip_status of CANCELED in the creation request.

Only EXCLUSIVE trips support intermediate_destinations.

When vehicle_id is set for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints for the vehicle, otherwise the waypoint order will be undetermined.

When you specify Trip.vehicle_waypoints, the list must contain all the remaining waypoints of the vehicle's trips, with no extra waypoints. You must order these waypoints such that for a given trip, the pickup point is before intermediate destinations, and all intermediate destinations come before the drop-off point. An EXCLUSIVE trip's waypoints must not interleave with any other trips.

The trip_id, waypoint_type and location fields are used, and all other TripWaypoint fields in vehicle_waypoints are ignored.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

string

Required. Unique Vehicle ID. Subject to the following restrictions:

• Must be a valid Unicode string.
• Limited to a maximum length of 64 characters.
• Normalized according to Unicode Normalization Form C.
• May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.

Vehicle

Required. The Vehicle entity to create. When creating a Vehicle, the following fields are required:

• vehicleState
• supportedTripTypes
• maximumCapacity
• vehicleType

When creating a Vehicle, the following fields are ignored:

• name
• currentTrips
• availableCapacity
• current_route_segment
• current_route_segment_end_point
• current_route_segment_version
• current_route_segment_traffic
• route
• waypoints
• waypoints_version
• remaining_distance_meters
• remaining_time_seconds
• eta_to_next_waypoint
• navigation_status

All other fields are optional and used if provided.

LocationPowerSaveMode

How location features are set to behave on the device when battery saver is on.

bool

Whether the device is currently in power save mode.

bool

Whether the device is in an interactive state.

BatteryInfo

Information about the battery state.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}/trips/{trip}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

TripView

The subset of Trip fields that should be returned and their interpretation.

Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.route or Trip.current_route_segment data are retrieved. If route data are unchanged since this timestamp, the route field is not set in the response. If a minimum is unspecified, the route data are always retrieved.

Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints are retrieved. If they are unchanged since this timestamp, the remaining_waypoints are not set in the response. If this field is unspecified, remaining_waypoints is always retrieved.

PolylineFormatType

The returned current route format, LAT_LNG_LIST_TYPE (in Trip.route), or ENCODED_POLYLINE_TYPE (in Trip.current_route_segment). The default is LAT_LNG_LIST_TYPE.

Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.current_route_segment_traffic is retrieved. If traffic data are unchanged since this timestamp, the current_route_segment_traffic field is not set in the response. If a minimum is unspecified, the traffic data are always retrieved. Note that traffic is only available for On-Demand Rides and Deliveries Solution customers.

Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints.traffic_to_waypoint and Trip.remaining_waypoints.path_to_waypoint data are retrieved. If data are unchanged since this timestamp, the fields above are not set in the response. If remaining_waypoints_route_version is unspecified, traffic and path are always retrieved.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}/vehicles/{vehicle}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

Timestamp

Indicates the minimum timestamp (exclusive) for which Vehicle.current_route_segment is retrieved. If the route is unchanged since this timestamp, the current_route_segment field is not set in the response. If a minimum is unspecified, the current_route_segment is always retrieved.

Timestamp

Indicates the minimum timestamp (exclusive) for which Vehicle.waypoints data is retrieved. If the waypoints are unchanged since this timestamp, the vehicle.waypoints data is not set in the response. If this field is unspecified, vehicle.waypoints is always retrieved.

string

Required. CLDR Country/Region Code. For example, US for United States, or IN for India.

string

The last digit of the license plate or "-1" to denote no numeric value is present in the license plate.

• "ABC 1234" -> "4"
• "AB 123 CD" -> "3"
• "ABCDEF" -> "-1"

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

int32

The maximum number of vehicles to return. Default value: 100.

string

The value of the next_page_token provided by a previous call to ListVehicles so that you can paginate through groups of vehicles. The value is undefined if the filter criteria of the request is not the same as the filter criteria for the previous call to ListVehicles.

Int32Value

Specifies the required minimum capacity of the vehicle. All vehicles returned will have a maximum_capacity greater than or equal to this value. If set, must be greater or equal to 0.

TripType

Restricts the response to vehicles that support at least one of the specified trip types.

Duration

Restricts the response to vehicles that have sent location updates to Fleet Engine within the specified duration. Stationary vehicles still transmitting their locations are not considered stale. If present, must be a valid positive duration.

Category

Required. Restricts the response to vehicles with one of the specified type categories. UNKNOWN is not allowed.

string

Callers can form complex logical operations using any combination of the required_attributes, required_one_of_attributes, and required_one_of_attribute_sets fields.

required_attributes is a list; required_one_of_attributes uses a message which allows a list of lists. In combination, the two fields allow the composition of this expression:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restricts the response to vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 required_attributes is allowed. This matches the maximum number of attributes allowed on a vehicle. Each repeated string should be of the format "key:value".

string

Restricts the response to vehicles with at least one of the specified attributes in each VehicleAttributeList. Within each list, a vehicle must match at least one of the attributes. This field is an inclusive disjunction/OR operation in each VehicleAttributeList and a conjunction/AND operation across the collection of VehicleAttributeList. Each repeated string should be of the format "key1:value1|key2:value2|key3:value3".

string

required_one_of_attribute_sets provides additional functionality.

Similar to required_one_of_attributes, required_one_of_attribute_sets uses a message which allows a list of lists, allowing expressions such as this one:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restricts the response to vehicles that match all the attributes in a VehicleAttributeList. Within each list, a vehicle must match all of the attributes. This field is a conjunction/AND operation in each VehicleAttributeList and inclusive disjunction/OR operation across the collection of VehicleAttributeList. Each repeated string should be of the format "key1:value1|key2:value2|key3:value3".

VehicleState

Restricts the response to vehicles that have this vehicle state.

bool

Only return the vehicles with current trip(s).

string

Optional. A filter query to apply when listing vehicles. See http://aip.dev/160 for examples of the filter syntax.

This field is designed to replace the required_attributes, required_one_of_attributes, and required_one_of_attributes_sets fields. If a non-empty value is specified here, the following fields must be empty: required_attributes, required_one_of_attributes, and required_one_of_attributes_sets.

This filter functions as an AND clause with other constraints, such as vehicle_state or on_trip_only.

Note that the only queries supported are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). The maximum number of restrictions allowed in a filter query is 50.

Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, attributes.<key> = "10" or attributes.<key> = "true").

Viewport

Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.

Vehicle

Vehicles matching the criteria in the request. The maximum number of vehicles returned is determined by the page_size field in the request.

string

Token to retrieve the next page of vehicles, or empty if there are no more vehicles that meet the request criteria.

int64

Required. Total number of vehicles matching the request criteria across all pages.

string

Required. Must be in the format providers/{provider}/billableTrips/{billable_trip}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

string

Required. Two letter country code of the country where the trip takes place. Price is defined according to country code.

BillingPlatformIdentifier

The platform upon which the request was issued.

string

The identifiers that are directly related to the trip being reported. These are usually IDs (for example, session IDs) of pre-booking operations done before the trip ID is available. The number of related_ids is limited to 50.

SolutionType

The type of GMP product solution (for example, ON_DEMAND_RIDESHARING_AND_DELIVERIES) used for the reported trip.

string

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. If none is specified, the response may be in any language, with a preference for English if such a name exists. Field value example: en-US.

string

Required. CLDR region code of the region where the request originates. Field value example: US.

string

Version of the calling SDK, if applicable. The version format is "major.minor.patch", example: 1.1.2.

string

Version of the operating system on which the calling SDK is running. Field value examples: 4.4.1, 12.1.

string

Model of the device on which the calling SDK is running. Field value examples: iPhone12,1, SM-G920F.

SdkType

The type of SDK sending the request.

string

Version of the MapSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 5.2.1.

string

Version of the NavSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 2.1.0.

Platform

Platform of the calling SDK.

string

Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs. Field value example: Samsung.

int32

Android API level of the calling SDK, only applicable for the Android SDKs. Field value example: 23.

string

Optional ID that can be provided for logging purposes in order to identify the request.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

string

The vehicle associated with the trips in the request. If unspecified, the returned trips do not contain:

• current_route_segment
• remaining_waypoints
• remaining_distance_meters
• eta_to_first_waypoint

bool

If set to true, the response includes Trips that influence a driver's route.

int32

If not set, the server decides the number of results to return.

string

Set this to a value previously returned in the SearchTripsResponse to continue from previous results.

Duration

If specified, returns the trips that have not been updated after the time (current - minimum_staleness).

Trip

The list of trips for the requested vehicle.

string

Pass this token in the SearchTripsRequest to page through list results. The API returns a trip list on each call, and when no more results remain the trip list is empty.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

TerminalLocation

Required. The pickup point to search near.

TerminalLocation

The customer's intended dropoff location. The field is required if trip_types contains TripType.SHARED.

int32

Required. Defines the vehicle search radius around the pickup point. Only vehicles within the search radius will be returned. Value must be between 400 and 10000 meters (inclusive).

int32

Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive).

int32

Required. Specifies the number of passengers being considered for a trip. The value must be greater than or equal to one. The driver is not considered in the capacity value.

TripType

Required. Represents the type of proposed trip. Must include exactly one type. UNKNOWN_TRIP_TYPE is not allowed. Restricts the search to only those vehicles that can support that trip type.

Duration

Restricts the search to only those vehicles that have sent location updates to Fleet Engine within the specified duration. Stationary vehicles still transmitting their locations are not considered stale. If this field is not set, the server uses five minutes as the default value.

VehicleType

Required. Restricts the search to vehicles with one of the specified types. At least one vehicle type must be specified. VehicleTypes with a category of UNKNOWN are not allowed.

VehicleAttribute

Callers can form complex logical operations using any combination of the required_attributes, required_one_of_attributes, and required_one_of_attribute_sets fields.

required_attributes is a list; required_one_of_attributes uses a message which allows a list of lists. In combination, the two fields allow the composition of this expression:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restricts the search to only those vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 required_attributes is allowed. This matches the maximum number of attributes allowed on a vehicle.

VehicleAttributeList

Restricts the search to only those vehicles with at least one of the specified attributes in each VehicleAttributeList. Within each list, a vehicle must match at least one of the attributes. This field is an inclusive disjunction/OR operation in each VehicleAttributeList and a conjunction/AND operation across the collection of VehicleAttributeList.

VehicleAttributeList

required_one_of_attribute_sets provides additional functionality.

Similar to required_one_of_attributes, required_one_of_attribute_sets uses a message which allows a list of lists, allowing expressions such as this one:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restricts the search to only those vehicles with all the attributes in a VehicleAttributeList. Within each list, a vehicle must match all of the attributes. This field is a conjunction/AND operation in each VehicleAttributeList and inclusive disjunction/OR operation across the collection of VehicleAttributeList.

VehicleMatchOrder

Required. Specifies the desired ordering criterion for results.

bool

This indicates if vehicles with a single active trip are eligible for this search. This field is only used when current_trips_present is unspecified. When current_trips_present is unspecified and this field is false, vehicles with assigned trips are excluded from the search results. When current_trips_present is unspecified and this field is true, search results can include vehicles with one active trip that has a status of ENROUTE_TO_DROPOFF. When current_trips_present is specified, this field cannot be set to true.

The default value is false.

string

Indicates the trip associated with this SearchVehicleRequest.

CurrentTripsPresent

This indicates if vehicles with active trips are eligible for this search. This must be set to something other than CURRENT_TRIPS_PRESENT_UNSPECIFIED if trip_type includes SHARED.

string

Optional. A filter query to apply when searching vehicles. See http://aip.dev/160 for examples of the filter syntax.

This field is designed to replace the required_attributes, required_one_of_attributes, and required_one_of_attributes_sets fields. If a non-empty value is specified here, the following fields must be empty: required_attributes, required_one_of_attributes, and required_one_of_attributes_sets.

This filter functions as an AND clause with other constraints, such as minimum_capacity or vehicle_types.

Note that the only queries supported are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). The maximum number of restrictions allowed in a filter query is 50.

Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, attributes.<key> = "10" or attributes.<key> = "true").

VehicleMatch

List of vehicles that match the SearchVehiclesRequest criteria, ordered according to SearchVehiclesRequest.order_by field.

int32

The starting index of this interval in the path. In JSON, when the index is 0, the field will appear to be unpopulated.

int32

The ending index of this interval in the path. In JSON, when the index is 0, the field will appear to be unpopulated.

Speed

Traffic speed in this interval.

LatLng

Required. Denotes the actual location.

Timestamp

Indicates when the stop happened.

Timestamp

Input only. Deprecated. Use the timestamp field.

LatLng

Required. Denotes the location of a trip waypoint.

TerminalPointId

ID of the terminal point.

string

Deprecated.

string

Deprecated.

WaypointType

Deprecated: Vehicle.waypoint will have this data.

string

Unique ID of the terminal point.

string

Deprecated.

string

Deprecated.

VisualTrafficReportPolylineRendering

A polyline rendering of how fast traffic is for all regions along one stretch of a customer ride.

string

Output only. In the format "providers/{provider}/trips/{trip}"

string

ID of the vehicle making this trip.

TripStatus

Current status of the trip.

TripType

The type of the trip.

TerminalLocation

Location where customer indicates they will be picked up.

StopLocation

Input only. The actual location when and where customer was picked up. This field is for provider to provide feedback on actual pickup information.

StopLocation

Input only. The actual time and location of the driver arrival at the pickup point. This field is for provider to provide feedback on actual arrival information at the pickup point.

Timestamp

Output only. Either the estimated future time when the rider(s) will be picked up, or the actual time when they were picked up.

TerminalLocation

Intermediate stops in order that the trip requests (in addition to pickup and dropoff). Initially this will not be supported for shared trips.

Timestamp

Indicates the last time the intermediate_destinations was modified. Your server should cache this value and pass it in UpdateTripRequest when update intermediate_destination_index to ensure the intermediate_destinations is not changed.

int32

When TripStatus is ENROUTE_TO_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle will cross next. When TripStatus is ARRIVED_AT_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle is at. The provider sets this value. If there are no intermediate_destinations, this field is ignored.

StopLocation

Input only. The actual time and location of the driver's arrival at an intermediate destination. This field is for provider to provide feedback on actual arrival information at intermediate destinations.

StopLocation

Input only. The actual time and location when and where the customer was picked up from an intermediate destination. This field is for provider to provide feedback on actual pickup information at intermediate destinations.

TerminalLocation

Location where customer indicates they will be dropped off.

StopLocation

Input only. The actual time and location when and where customer was dropped off. This field is for provider to provide feedback on actual dropoff information.

Timestamp

Output only. Either the estimated future time when the rider(s) will be dropped off at the final destination, or the actual time when they were dropped off.

TripWaypoint

Output only. The full path from the current location to the dropoff point, inclusive. This path could include waypoints from other trips.

TripWaypoint

This field supports manual ordering of the waypoints for the trip. It contains all of the remaining waypoints for the assigned vehicle, as well as the pickup and drop-off waypoints for this trip. If the trip hasn't been assigned to a vehicle, then Fleet Engine ignores this field. For privacy reasons, this field is only populated by the server on UpdateTrip and CreateTrip calls, NOT on GetTrip calls.

LatLng

Output only. Anticipated route for this trip to the first entry in remaining_waypoints. Note that the first waypoint may belong to a different trip.

string

Output only. An encoded path to the next waypoint.

Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.

Timestamp

Output only. Indicates the last time the route was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

ConsumableTrafficPolyline

Output only. Indicates the traffic conditions along the current_route_segment when they're available.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Timestamp

Output only. Indicates the last time the current_route_segment_traffic was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

TripWaypoint

Output only. The waypoint where current_route_segment ends.

Int32Value

Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.

Timestamp

Output only. The ETA to the next waypoint (the first entry in the remaining_waypoints field). The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Duration

Output only. The duration from when the Trip data is returned to the time in Trip.eta_to_first_waypoint. The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Timestamp

Output only. Indicates the last time that remaining_waypoints was changed (a waypoint was added, removed, or changed).

Timestamp

Output only. Indicates the last time the remaining_waypoints.path_to_waypoint and remaining_waypoints.traffic_to_waypoint were modified. Your client app should cache this value and pass it in GetTripRequest to ensure the paths and traffic for remaining_waypoints are only returned if updated.

int32

Immutable. Indicates the number of passengers on this trip and does not include the driver. A vehicle must have available capacity to be returned in a SearchVehicles response.

VehicleLocation

Output only. Indicates the last reported location of the vehicle along the route.

bool

Output only. Indicates whether the vehicle's last_location can be snapped to the current_route_segment. False if last_location or current_route_segment doesn't exist. It is computed by Fleet Engine. Any update from clients will be ignored.

TripView

The subset of Trip fields that are populated and how they should be interpreted.

TerminalLocation

The location of this waypoint.

string

The trip associated with this waypoint.

WaypointType

The role this waypoint plays in this trip, such as pickup or dropoff.

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.

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.

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.

Int32Value

The path distance from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list.

Timestamp

The estimated time of arrival at this waypoint. Undefined for the first waypoint in a list.

Duration

The travel time from previous waypoint to this point. Undefined for the first waypoint in a list.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}/trips/{trip}. The provider must be the Project ID (for example, sample-consumer-project) of the Google Cloud Project of which the service account making this call is a member.

Trip

Required. The Trip associated with the update.

The following fields are maintained by the Fleet Engine. Do not update them using Trip.update.

• current_route_segment
• current_route_segment_end_point
• current_route_segment_traffic
• current_route_segment_traffic_version
• current_route_segment_version
• dropoff_time
• eta_to_next_waypoint
• intermediate_destinations_version
• last_location
• name
• number_of_passengers
• pickup_time
• remaining_distance_meters
• remaining_time_to_first_waypoint
• remaining_waypoints
• remaining_waypoints_version
• route

When you update the Trip.vehicle_id for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints, otherwise the order will be undetermined.

When you specify Trip.vehicle_waypoints, the list must contain all the remaining waypoints of the vehicle's trips, with no extra waypoints. You must order these waypoints such that for a given trip, the pickup point is before intermediate destinations, and all intermediate destinations come before the drop-off point. An EXCLUSIVE trip's waypoints must not interleave with any other trips. The trip_id, waypoint_type and location fields are used, and all other TripWaypoint fields in vehicle_waypoints are ignored.

To avoid a race condition for trips with multiple destinations, you should provide Trip.intermediate_destinations_version when updating the trip status to ENROUTE_TO_INTERMEDIATE_DESTINATION. The Trip.intermediate_destinations_version passed must be consistent with Fleet Engine's version. If it isn't, the request fails.

FieldMask

Required. The field mask indicating which fields in Trip to update. The update_mask must contain at least one field.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}/vehicles/{vehicle}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

VehicleAttribute

Required. The vehicle attributes to update. Unmentioned attributes are not altered or removed.

VehicleAttribute

Required. The updated full list of vehicle attributes, including new, altered, and untouched attributes.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}/vehicles/{vehicle}. The {provider} must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

VehicleLocation

Required. The vehicle's most recent location. The location and update_time subfields are required.

VehicleState

Set the vehicle's state to either ONLINE or OFFLINE. If set to UNKNOWN_VEHICLE_STATE, the vehicle's state will not be altered.

RequestHeader

The standard Fleet Engine request header.

string

Required. Must be in the format providers/{provider}/vehicles/{vehicle}. The {provider} must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

Vehicle

Required. The Vehicle entity values to apply. When updating a Vehicle, the following fields may not be updated as they are managed by the server.

• available_capacity
• current_route_segment_version
• current_trips
• name
• waypoints_version

If the attributes field is updated, all the vehicle's attributes are replaced with the attributes provided in the request. If you want to update only some attributes, see the UpdateVehicleAttributes method.

Likewise, the waypoints field can be updated, but must contain all the waypoints currently on the vehicle, and no other waypoints.

FieldMask

Required. A field mask indicating which fields of the Vehicle to update. At least one field name must be provided.

string

Output only. The unique name for this vehicle. The format is providers/{provider}/vehicles/{vehicle}.

VehicleState

The vehicle state.

TripType

Trip types supported by this vehicle.

string

Output only. List of trip_id's for trips currently assigned to this vehicle.

VehicleLocation

Last reported location of the vehicle.

int32

The total numbers of riders this vehicle can carry. The driver is not considered in this value. This value must be greater than or equal to one.

VehicleAttribute

List of vehicle attributes. A vehicle can have at most 100 attributes, and each attribute must have a unique key.

VehicleType

Required. The type of this vehicle. Can be used to filter vehicles in SearchVehicles results. Also influences ETA and route calculations.

LicensePlate

License plate information for the vehicle.

TerminalLocation

Deprecated: Use Vehicle.waypoints instead.

string

The polyline specifying the route the driver app intends to take to the next waypoint. This list is also returned in Trip.current_route_segment for all active trips assigned to the vehicle.

Note: This field is intended only for use by the Driver SDK. Decoding is not yet supported.

TrafficPolylineData

Input only. Fleet Engine uses this information to improve journey sharing. Note: This field is intended only for use by the Driver SDK.

Timestamp

Output only. Time when current_route_segment was set. It can be stored by the client and passed in future GetVehicle requests to prevent returning routes that haven't changed.

TripWaypoint

The waypoint where current_route_segment ends. This can be supplied by drivers on UpdateVehicle calls either as a full trip waypoint, a waypoint LatLng, or as the last LatLng of the current_route_segment. Fleet Engine will then do its best to interpolate to an actual waypoint if it is not fully specified. This field is ignored in UpdateVehicle calls unless current_route_segment is also specified.

Int32Value

The remaining driving distance for the current_route_segment. This value is also returned in Trip.remaining_distance_meters for all active trips assigned to the vehicle. The value is unspecified if the current_route_segment field is empty.

Timestamp

The ETA to the first entry in the waypoints field. The value is unspecified if the waypoints field is empty or the Vehicle.current_route_segment field is empty.

When updating a vehicle, remaining_time_seconds takes precedence over eta_to_first_waypoint in the same request.

Int32Value

Input only. The remaining driving time for the current_route_segment. The value is unspecified if the waypoints field is empty or the Vehicle.current_route_segment field is empty. This value should match eta_to_first_waypoint - current_time if all parties are using the same clock.

When updating a vehicle, remaining_time_seconds takes precedence over eta_to_first_waypoint in the same request.

TripWaypoint

The remaining waypoints assigned to this Vehicle.

Timestamp

Output only. Last time the waypoints field was updated. Clients should cache this value and pass it in GetVehicleRequest to ensure the waypoints field is only returned if it is updated.

bool

Indicates if the driver accepts back-to-back trips. If true, SearchVehicles may include the vehicle even if it is currently assigned to a trip. The default value is false.

NavigationStatus

The vehicle's navigation status.

DeviceSettings

Input only. Information about settings in the mobile device being used by the driver.

Category

Vehicle type category

string

The attribute's key. Keys may not contain the colon character (:).

string

The attribute's value.

string

String typed attribute value.

Note: This is identical to the value field which will eventually be deprecated. For create or update methods, either field can be used, but it's strongly recommended to use string_value. If both string_value and value are set, they must be identical or an error will be thrown. Both fields are populated in responses.

bool

Boolean typed attribute value.

double

Double typed attribute value.

VehicleAttribute

A list of attributes in this collection.

LatLng

The location of the vehicle. When it is sent to Fleet Engine, the vehicle's location is a GPS location. When you receive it in a response, the vehicle's location can be either a GPS location, a supplemental location, or some other estimated location. The source is specified in location_sensor.

DoubleValue

Deprecated: Use latlng_accuracy instead.

DoubleValue

Accuracy of location in meters as a radius.

Int32Value

Direction the vehicle is moving in degrees. 0 represents North. The valid range is [0,360).

DoubleValue

Deprecated: Use heading_accuracy instead.

DoubleValue

Accuracy of heading in degrees.

DoubleValue

Altitude in meters above WGS84.

DoubleValue

Deprecated: Use altitude_accuracy instead.

DoubleValue

Accuracy of altitude in meters.

Int32Value

Speed of the vehicle in kilometers per hour. Deprecated: Use speed instead.

DoubleValue

Speed of the vehicle in meters/second

DoubleValue

Accuracy of speed in meters/second.

Timestamp

The time when location was reported by the sensor according to the sensor's clock.

Timestamp

Output only. The time when the server received the location information.

LocationSensor

Provider of location data (for example, GPS).

BoolValue

Whether location is snapped to a road.

BoolValue

Input only. Indicates whether the GPS sensor is enabled on the mobile device.

Int32Value

Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

Int32Value

Input only. Deprecated: Other signals are now used to determine if a location is stale.

LatLng

Raw vehicle location (unprocessed by road-snapper).

Timestamp

Timestamp associated with the raw location.

LocationSensor

Source of the raw location. Defaults to GPS.

DoubleValue

Accuracy of raw_location as a radius, in meters.

LatLng

Supplemental location provided by the integrating app.

Timestamp

Timestamp associated with the supplemental location.

LocationSensor

Source of the supplemental location. Defaults to CUSTOMER_SUPPLIED_LOCATION.

DoubleValue

Accuracy of supplemental_location as a radius, in meters.

bool

Deprecated: Use is_road_snapped instead.

Vehicle

Required. A vehicle that matches the request.

Timestamp

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 SearchVehiclesRequest.include_back_to_back was true and this vehicle has an active trip, vehicle_pickup_eta includes the time required to complete the current active trip.

Int32Value

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.

Int32Value

Required. The straight-line distance between the vehicle and the pickup point specified in the request.

Timestamp

The complete vehicle's driving ETA to the drop off point specified in the request. The ETA includes stopping at any waypoints before the dropoff_point specified in the request. The value will only be populated when a drop off point is specified in the request. An empty value indicates an error calculating the ETA.

Int32Value

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 dropoff_point is specified in the request. An empty value indicates a failure in calculating the distance from the pickup to drop off point specified in the request.

TripType

Required. The trip type of the request that was used to calculate the ETA to the pickup point.

Waypoint

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.

VehicleMatchOrder

The order requested for sorting vehicle matches.

VehicleMatchOrder

The actual order that was used for this vehicle. Normally this will match the 'order_by' field from the request; however, in certain circumstances such as an internal server error, a different method may be used (such as PICKUP_POINT_STRAIGHT_DISTANCE).

RoadStretch

Optional. Road stretches that should be rendered along the polyline. Stretches are guaranteed to not overlap, and do not necessarily span the full route.

In the absence of a road stretch to style, the client should apply the default for the route.

Style

Required. The style to apply.

int32

Required. The style should be applied between [offset_meters, offset_meters + length_meters).

int32

Required. The length of the path where to apply the style.

LatLng

The location of this waypoint.

Timestamp

The estimated time that the vehicle will arrive at this waypoint.