Index
TripService
(interface)VehicleService
(interface)BatteryInfo
(message)BatteryStatus
(enum)BillingPlatformIdentifier
(enum)ConsumableTrafficPolyline
(message)CreateTripRequest
(message)CreateVehicleRequest
(message)DeviceSettings
(message)GetTripRequest
(message)GetVehicleRequest
(message)LicensePlate
(message)ListVehiclesRequest
(message)ListVehiclesResponse
(message)LocationPowerSaveMode
(enum)LocationSensor
(enum)NavigationStatus
(enum)PolylineFormatType
(enum)PowerSource
(enum)ReportBillableTripRequest
(message)ReportBillableTripRequest.SolutionType
(enum)RequestHeader
(message)RequestHeader.Platform
(enum)RequestHeader.SdkType
(enum)SearchTripsRequest
(message)SearchTripsResponse
(message)SearchVehiclesRequest
(message)SearchVehiclesRequest.CurrentTripsPresent
(enum)SearchVehiclesRequest.VehicleMatchOrder
(enum)SearchVehiclesResponse
(message)SpeedReadingInterval
(message)SpeedReadingInterval.Speed
(enum)StopLocation
(message)TerminalLocation
(message)TerminalPointId
(message) (deprecated)TrafficPolylineData
(message)Trip
(message)TripStatus
(enum)TripType
(enum)TripView
(enum)TripWaypoint
(message)UpdateTripRequest
(message)UpdateVehicleAttributesRequest
(message)UpdateVehicleAttributesResponse
(message)UpdateVehicleRequest
(message)Vehicle
(message)Vehicle.VehicleType
(message)Vehicle.VehicleType.Category
(enum)VehicleAttribute
(message)VehicleAttributeList
(message)VehicleLocation
(message)VehicleMatch
(message)VehicleMatch.VehicleMatchType
(enum)VehicleState
(enum)VisualTrafficReportPolylineRendering
(message)VisualTrafficReportPolylineRendering.RoadStretch
(message)VisualTrafficReportPolylineRendering.RoadStretch.Style
(enum)Waypoint
(message)WaypointType
(enum)
TripService
Trip management service.
CreateTrip |
---|
Creates a trip in the Fleet Engine and returns the new trip. |
GetTrip |
---|
Get information about a single trip. |
ReportBillableTrip |
---|
Report billable trip usage. |
SearchTrips |
---|
Get all the trips for a specific vehicle. |
UpdateTrip |
---|
Updates trip data. |
VehicleService
Vehicle management service.
CreateVehicle |
---|
Instantiates a new vehicle associated with an on-demand rideshare or deliveries provider. Each The following
The following
All other fields are optional and used if provided. |
GetVehicle |
---|
Returns a vehicle from the Fleet Engine. |
ListVehicles |
---|
Returns a paginated list of vehicles associated with a provider that match the request options. |
SearchVehicles |
---|
Returns a list of vehicles that match the request options. |
UpdateVehicle |
---|
Writes updated vehicle data to the Fleet Engine. When updating a
The vehicle If the |
UpdateVehicleAttributes |
---|
Partially updates a vehicle's attributes. Only the attributes mentioned in the request will be updated, other attributes will NOT be altered. Note: this is different in |
BatteryInfo
Information about the device's battery.
Fields | |
---|---|
battery_ |
Status of the battery, whether full or charging etc. |
power_ |
Status of battery power source. |
battery_ |
Current battery percentage [0-100]. |
BatteryStatus
Status of the battery, whether full or charging etc.
Enums | |
---|---|
UNKNOWN_BATTERY_STATUS |
Battery status unknown. |
BATTERY_STATUS_CHARGING |
Battery is being charged. |
BATTERY_STATUS_DISCHARGING |
Battery is discharging. |
BATTERY_STATUS_FULL |
Battery is full. |
BATTERY_STATUS_NOT_CHARGING |
Battery is not charging. |
BATTERY_STATUS_POWER_LOW |
Battery is low on power. |
BillingPlatformIdentifier
A set of values that indicate upon which platform the request was issued.
Enums | |
---|---|
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED |
Default. Used for unspecified platforms. |
SERVER |
The platform is a client server. |
WEB |
The platform is a web browser. |
ANDROID |
The platform is an Android mobile device. |
IOS |
The platform is an IOS mobile device. |
OTHERS |
Other platforms that are not listed in this enumeration. |
ConsumableTrafficPolyline
Traffic density along a Vehicle's path.
Fields | |
---|---|
speed_ |
Traffic speed along the path from the previous waypoint to the current waypoint. |
encoded_ |
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 |
CreateTripRequest
CreateTrip request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
parent |
Required. Must be in the format |
trip_ |
Required. Unique Trip ID. Subject to the following restrictions:
|
trip |
Required. Trip entity to create. When creating a Trip, the following fields are required:
The following fields are used if you provide them:
All other Trip fields are ignored. For example, all trips start with a Only When When you specify The |
CreateVehicleRequest
CreateVehicle
request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
parent |
Required. Must be in the format |
vehicle_ |
Required. Unique Vehicle ID. Subject to the following restrictions:
|
vehicle |
Required. The Vehicle entity to create. When creating a Vehicle, the following fields are required:
When creating a Vehicle, the following fields are ignored:
All other fields are optional and used if provided. |
DeviceSettings
Information about various settings on the mobile device.
Fields | |
---|---|
location_ |
How location features are set to behave on the device when battery saver is on. |
is_ |
Whether the device is currently in power save mode. |
is_ |
Whether the device is in an interactive state. |
battery_ |
Information about the battery state. |
GetTripRequest
GetTrip request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
name |
Required. Must be in the format |
view |
The subset of Trip fields that should be returned and their interpretation. |
current_ |
Indicates the minimum timestamp (exclusive) for which |
remaining_ |
Indicates the minimum timestamp (exclusive) for which |
route_ |
The returned current route format, |
current_ |
Indicates the minimum timestamp (exclusive) for which |
remaining_ |
Indicates the minimum timestamp (exclusive) for which |
GetVehicleRequest
GetVehicle
request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
name |
Required. Must be in the format |
current_ |
Indicates the minimum timestamp (exclusive) for which |
waypoints_ |
Indicates the minimum timestamp (exclusive) for which |
LicensePlate
The license plate information of the Vehicle. To avoid storing personally-identifiable information, only the minimum information about the license plate is stored as part of the entity.
Fields | |
---|---|
country_ |
Required. CLDR Country/Region Code. For example, |
last_ |
The last digit of the license plate or "-1" to denote no numeric value is present in the license plate.
|
ListVehiclesRequest
ListVehicles
request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
parent |
Required. Must be in the format |
page_ |
The maximum number of vehicles to return. Default value: 100. |
page_ |
The value of the |
minimum_ |
Specifies the required minimum capacity of the vehicle. All vehicles returned will have a |
trip_ |
Restricts the response to vehicles that support at least one of the specified trip types. |
maximum_ |
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. |
vehicle_ |
Required. Restricts the response to vehicles with one of the specified type categories. |
required_ |
Callers can form complex logical operations using any combination of the
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". |
required_ |
Restricts the response to vehicles with at least one of the specified attributes in each |
required_ |
Similar to
Restricts the response to vehicles that match all the attributes in a |
vehicle_ |
Restricts the response to vehicles that have this vehicle state. |
on_ |
Only return the vehicles with current trip(s). |
filter |
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 This filter functions as an AND clause with other constraints, such as Note that the only queries supported are on vehicle attributes (for example, 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, |
viewport |
Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport. |
ListVehiclesResponse
ListVehicles
response message.
Fields | |
---|---|
vehicles[] |
Vehicles matching the criteria in the request. The maximum number of vehicles returned is determined by the |
next_ |
Token to retrieve the next page of vehicles, or empty if there are no more vehicles that meet the request criteria. |
total_ |
Required. Total number of vehicles matching the request criteria across all pages. |
LocationPowerSaveMode
How location features are configured to behave on the mobile device when the devices "battery saver" feature is on. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())
Enums | |
---|---|
UNKNOWN_LOCATION_POWER_SAVE_MODE |
Undefined LocationPowerSaveMode |
LOCATION_MODE_NO_CHANGE |
Either the location providers shouldn't be affected by battery saver, or battery saver is off. |
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF |
The GPS based location provider should be disabled when battery saver is on and the device is non-interactive. |
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF |
All location providers should be disabled when battery saver is on and the device is non-interactive. |
LOCATION_MODE_FOREGROUND_ONLY |
All the location providers will be kept available, but location fixes should only be provided to foreground apps. |
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF |
Location will not be turned off, but LocationManager will throttle all requests to providers when the device is non-interactive. |
LocationSensor
The sensor or methodology used to determine the location.
Enums | |
---|---|
UNKNOWN_SENSOR |
The sensor is unspecified or unknown. |
GPS |
GPS or Assisted GPS. |
NETWORK |
Assisted GPS, cell tower ID, or WiFi access point. |
PASSIVE |
Cell tower ID or WiFi access point. |
ROAD_SNAPPED_LOCATION_PROVIDER |
A location determined by the mobile device to be the most likely road position. |
CUSTOMER_SUPPLIED_LOCATION |
A customer-supplied location from an independent source. Typically, this value is used for a location provided from sources other than the mobile device running Driver SDK. If the original source is described by one of the other enum values, use that value. Locations marked CUSTOMER_SUPPLIED_LOCATION are typically provided via a Vehicle's last_location.supplemental_location_sensor . |
FLEET_ENGINE_LOCATION |
A location calculated by Fleet Engine based on the signals available to it. Output only. This value will be rejected if it is received in a request. |
FUSED_LOCATION_PROVIDER |
Android's Fused Location Provider. |
CORE_LOCATION |
The location provider on Apple operating systems. |
PolylineFormatType
The type of polyline format.
Enums | |
---|---|
UNKNOWN_FORMAT_TYPE |
The format is unspecified or unknown. |
LAT_LNG_LIST_TYPE |
A list of google.type.LatLng . |
ENCODED_POLYLINE_TYPE |
A polyline encoded with a polyline compression algorithm. Decoding is not yet supported. |
PowerSource
Type of the charger being used to charge the battery.
Enums | |
---|---|
UNKNOWN_POWER_SOURCE |
Power source unknown. |
POWER_SOURCE_AC |
Power source is an AC charger. |
POWER_SOURCE_USB |
Power source is a USB port. |
POWER_SOURCE_WIRELESS |
Power source is wireless. |
POWER_SOURCE_UNPLUGGED |
Battery is unplugged. |
ReportBillableTripRequest
ReportBillableTrip request message.
Fields | |
---|---|
name |
Required. Must be in the format |
country_ |
Required. Two letter country code of the country where the trip takes place. Price is defined according to country code. |
platform |
The platform upon which the request was issued. |
related_ |
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 |
solution_ |
The type of GMP product solution (for example, |
SolutionType
Selector for different solution types of a reported trip.
Enums | |
---|---|
SOLUTION_TYPE_UNSPECIFIED |
The default value. For backwards-compatibility, the API will use ON_DEMAND_RIDESHARING_AND_DELIVERIES by default which is the first supported solution type. |
ON_DEMAND_RIDESHARING_AND_DELIVERIES |
The solution is an on-demand ridesharing and deliveries trip. |
RequestHeader
A RequestHeader contains fields common to all Fleet Engine RPC requests.
Fields | |
---|---|
language_ |
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: |
region_ |
Required. CLDR region code of the region where the request originates. Field value example: |
sdk_ |
Version of the calling SDK, if applicable. The version format is "major.minor.patch", example: |
os_ |
Version of the operating system on which the calling SDK is running. Field value examples: |
device_ |
Model of the device on which the calling SDK is running. Field value examples: |
sdk_ |
The type of SDK sending the request. |
maps_ |
Version of the MapSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: |
nav_ |
Version of the NavSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: |
platform |
Platform of the calling SDK. |
manufacturer |
Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs. Field value example: |
android_ |
Android API level of the calling SDK, only applicable for the Android SDKs. Field value example: |
trace_ |
Optional ID that can be provided for logging purposes in order to identify the request. |
Platform
The platform of the calling SDK.
Enums | |
---|---|
PLATFORM_UNSPECIFIED |
The default value. This value is used if the platform is omitted. |
ANDROID |
The request is coming from Android. |
IOS |
The request is coming from iOS. |
WEB |
The request is coming from the web. |
SdkType
Possible types of SDK.
Enums | |
---|---|
SDK_TYPE_UNSPECIFIED |
The default value. This value is used if the sdk_type is omitted. |
CONSUMER |
The calling SDK is Consumer. |
DRIVER |
The calling SDK is Driver. |
JAVASCRIPT |
The calling SDK is JavaScript. |
SearchTripsRequest
SearchTrips request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
parent |
Required. Must be in the format |
vehicle_ |
The vehicle associated with the trips in the request. If unspecified, the returned trips do not contain:
|
active_ |
If set to true, the response includes Trips that influence a driver's route. |
page_ |
If not set, the server decides the number of results to return. |
page_ |
Set this to a value previously returned in the |
minimum_ |
If specified, returns the trips that have not been updated after the time |
SearchTripsResponse
SearchTrips response message.
Fields | |
---|---|
trips[] |
The list of trips for the requested vehicle. |
next_ |
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. |
SearchVehiclesRequest
SearchVehicles
request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
parent |
Required. Must be in the format |
pickup_ |
Required. The pickup point to search near. |
dropoff_ |
The customer's intended dropoff location. The field is required if |
pickup_ |
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). |
count |
Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive). |
minimum_ |
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. |
trip_ |
Required. Represents the type of proposed trip. Must include exactly one type. |
maximum_ |
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. |
vehicle_ |
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 |
required_ |
Callers can form complex logical operations using any combination of the
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. |
required_ |
Restricts the search to only those vehicles with at least one of the specified attributes in each |
required_ |
Similar to
Restricts the search to only those vehicles with all the attributes in a |
order_ |
Required. Specifies the desired ordering criterion for results. |
include_ |
This indicates if vehicles with a single active trip are eligible for this search. This field is only used when The default value is |
trip_ |
Indicates the trip associated with this |
current_ |
This indicates if vehicles with active trips are eligible for this search. This must be set to something other than |
filter |
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 This filter functions as an AND clause with other constraints, such as Note that the only queries supported are on vehicle attributes (for example, 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, |
CurrentTripsPresent
Specifies the types of restrictions on a vehicle's current trips.
Enums | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
The availability of vehicles with trips present is governed by the include_back_to_back field. |
NONE |
Vehicles without trips can appear in search results. When this value is used, include_back_to_back cannot be true . |
ANY |
Vehicles with at most 5 current trips and 10 waypoints are included in the search results. When this value is used, include_back_to_back cannot be true . |
VehicleMatchOrder
Specifies the order of the vehicle matches in the response.
Enums | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Default, used for unspecified or unrecognized vehicle matches order. |
PICKUP_POINT_ETA |
Ascending order by vehicle driving time to the pickup point. |
PICKUP_POINT_DISTANCE |
Ascending order by vehicle driving distance to the pickup point. |
DROPOFF_POINT_ETA |
Ascending order by vehicle driving time to the dropoff point. This order can only be used if the dropoff point is specified in the request. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Ascending order by straight-line distance from the vehicle's last reported location to the pickup point. |
COST |
Ascending order by the configured match cost. Match cost is defined as a weighted calculation between straight-line distance and ETA. Weights are set with default values and can be modified per customer. Please contact Google support if these weights need to be modified for your project. |
SearchVehiclesResponse
SearchVehicles
response message.
Fields | |
---|---|
matches[] |
List of vehicles that match the |
SpeedReadingInterval
Traffic density indicator on a contiguous segment of a path. Given a path with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval defines an interval and describes its traffic using the following categories.
Fields | |
---|---|
start_ |
The starting index of this interval in the path. In JSON, when the index is 0, the field will appear to be unpopulated. |
end_ |
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. |
Speed
The classification of polyline speed based on traffic data.
Enums | |
---|---|
SPEED_UNSPECIFIED |
Default value. This value is unused. |
NORMAL |
Normal speed, no slowdown is detected. |
SLOW |
Slowdown detected, but no traffic jam formed. |
TRAFFIC_JAM |
Traffic jam detected. |
StopLocation
The actual location where a stop (pickup/dropoff) happened.
Fields | |
---|---|
point |
Required. Denotes the actual location. |
timestamp |
Indicates when the stop happened. |
stop_time |
Input only. Deprecated. Use the timestamp field. |
TerminalLocation
Describes the location of a waypoint.
Fields | |
---|---|
point |
Required. Denotes the location of a trip waypoint. |
terminal_point_id |
Deprecated: Specify the |
access_point_id |
Deprecated: Specify the |
trip_id |
Deprecated. |
terminal_location_type |
Deprecated: |
TerminalPointId
Deprecated: TerminalPoints are no longer supported in Fleet Engine. Use TerminalLocation.point
instead.
Fields | |
---|---|
value |
Deprecated. |
Union field Id . Deprecated. Id can be only one of the following: |
|
place_id |
Deprecated. |
generated_id |
Deprecated. |
TrafficPolylineData
Traffic conditions along the expected vehicle route.
Fields | |
---|---|
traffic_ |
A polyline rendering of how fast traffic is for all regions along one stretch of a customer ride. |
Trip
Trip metadata.
Fields | |
---|---|
name |
Output only. In the format "providers/{provider}/trips/{trip}" |
vehicle_ |
ID of the vehicle making this trip. |
trip_ |
Current status of the trip. |
trip_ |
The type of the trip. |
pickup_ |
Location where customer indicates they will be picked up. |
actual_ |
Input only. The actual location when and where customer was picked up. This field is for provider to provide feedback on actual pickup information. |
actual_ |
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. |
pickup_ |
Output only. Either the estimated future time when the rider(s) will be picked up, or the actual time when they were picked up. |
intermediate_ |
Intermediate stops in order that the trip requests (in addition to pickup and dropoff). Initially this will not be supported for shared trips. |
intermediate_ |
Indicates the last time the |
intermediate_ |
When |
actual_ |
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. |
actual_ |
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. |
dropoff_ |
Location where customer indicates they will be dropped off. |
actual_ |
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. |
dropoff_ |
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. |
remaining_ |
Output only. The full path from the current location to the dropoff point, inclusive. This path could include waypoints from other trips. |
vehicle_ |
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 |
route[] |
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. |
current_ |
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. |
current_ |
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. |
current_ |
Output only. Indicates the traffic conditions along the Note: This field is intended only for use by the Driver SDK and Consumer SDK. |
current_ |
Output only. Indicates the last time the Note: This field is intended only for use by the Driver SDK and Consumer SDK. |
current_ |
Output only. The waypoint where |
remaining_ |
Output only. The remaining driving distance in the |
eta_ |
Output only. The ETA to the next waypoint (the first entry in the |
remaining_ |
Output only. The duration from when the Trip data is returned to the time in |
remaining_ |
Output only. Indicates the last time that |
remaining_ |
Output only. Indicates the last time the |
number_ |
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 |
last_ |
Output only. Indicates the last reported location of the vehicle along the route. |
last_ |
Output only. Indicates whether the vehicle's |
view |
The subset of Trip fields that are populated and how they should be interpreted. |
TripStatus
The status of a trip indicating its progression.
Enums | |
---|---|
UNKNOWN_TRIP_STATUS |
Default, used for unspecified or unrecognized trip status. |
NEW |
Newly created trip. |
ENROUTE_TO_PICKUP |
The driver is on their way to the pickup point. |
ARRIVED_AT_PICKUP |
The driver has arrived at the pickup point. |
ARRIVED_AT_INTERMEDIATE_DESTINATION |
The driver has arrived at an intermediate destination and is waiting for the rider. |
ENROUTE_TO_INTERMEDIATE_DESTINATION |
The driver is on their way to an intermediate destination (not the dropoff point). |
ENROUTE_TO_DROPOFF |
The driver has picked up the rider and is on their way to the next destination. |
COMPLETE |
The rider has been dropped off and the trip is complete. |
CANCELED |
The trip was canceled prior to pickup by the driver, rider, or rideshare provider. |
TripType
The type of a trip.
Enums | |
---|---|
UNKNOWN_TRIP_TYPE |
Default, used for unspecified or unrecognized trip types. |
SHARED |
The trip may share a vehicle with other trips. |
EXCLUSIVE |
The trip is exclusive to a vehicle. |
TripView
Selector for different sets of Trip fields in a GetTrip
response. See AIP-157 for context. Additional views are likely to be added.
Enums | |
---|---|
TRIP_VIEW_UNSPECIFIED |
The default value. For backwards-compatibility, the API will default to an SDK view. To ensure stability and support, customers are advised to select a TripView other than SDK . |
SDK |
Includes fields that may not be interpretable or supportable using publicly available libraries. |
JOURNEY_SHARING_V1S |
Trip fields are populated for the Journey Sharing use case. This view is intended for server-to-server communications. |
TripWaypoint
Describes a stopping point on a vehicle's route or an ending point on a vehicle's trip.
Fields | |
---|---|
location |
The location of this waypoint. |
trip_ |
The trip associated with this waypoint. |
waypoint_ |
The role this waypoint plays in this trip, such as pickup or dropoff. |
path_ |
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. |
encoded_ |
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. |
traffic_ |
The traffic conditions along the path to this waypoint. Note that traffic is only available for Google Map Platform Rides and Deliveries Solution customers. |
distance_ |
The path distance from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list. |
eta |
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. |
UpdateTripRequest
UpdateTrip request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
name |
Required. Must be in the format |
trip |
Required. The Trip associated with the update. The following fields are maintained by the Fleet Engine. Do not update them using Trip.update.
When you update the When you specify To avoid a race condition for trips with multiple destinations, you should provide |
update_ |
Required. The field mask indicating which fields in Trip to update. The |
UpdateVehicleAttributesRequest
UpdateVehicleAttributes
request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
name |
Required. Must be in the format |
attributes[] |
Required. The vehicle attributes to update. Unmentioned attributes are not altered or removed. |
UpdateVehicleAttributesResponse
UpdateVehicleAttributes
response message.
Fields | |
---|---|
attributes[] |
Required. The updated full list of vehicle attributes, including new, altered, and untouched attributes. |
UpdateVehicleRequest
`UpdateVehicle request message.
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
name |
Required. Must be in the format |
vehicle |
Required. The
If the Likewise, the |
update_ |
Required. A field mask indicating which fields of the |
Vehicle
Vehicle metadata.
Fields | |
---|---|
name |
Output only. The unique name for this vehicle. The format is |
vehicle_ |
The vehicle state. |
supported_ |
Trip types supported by this vehicle. |
current_ |
Output only. List of |
last_ |
Last reported location of the vehicle. |
maximum_ |
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. |
attributes[] |
List of vehicle attributes. A vehicle can have at most 100 attributes, and each attribute must have a unique key. |
vehicle_ |
Required. The type of this vehicle. Can be used to filter vehicles in |
license_ |
License plate information for the vehicle. |
route[] |
Deprecated: Use |
current_ |
The polyline specifying the route the driver app intends to take to the next waypoint. This list is also returned in Note: This field is intended only for use by the Driver SDK. Decoding is not yet supported. |
current_ |
Input only. Fleet Engine uses this information to improve journey sharing. Note: This field is intended only for use by the Driver SDK. |
current_ |
Output only. Time when |
current_ |
The waypoint where |
remaining_ |
The remaining driving distance for the |
eta_ |
The ETA to the first entry in the When updating a vehicle, |
remaining_ |
Input only. The remaining driving time for the When updating a vehicle, |
waypoints[] |
The remaining waypoints assigned to this Vehicle. |
waypoints_ |
Output only. Last time the |
back_ |
Indicates if the driver accepts back-to-back trips. If |
navigation_ |
The vehicle's navigation status. |
device_ |
Input only. Information about settings in the mobile device being used by the driver. |
VehicleType
The type of vehicle.
Fields | |
---|---|
category |
Vehicle type category |
Category
Vehicle type categories
Enums | |
---|---|
UNKNOWN |
Default, used for unspecified or unrecognized vehicle categories. |
AUTO |
An automobile. |
TAXI |
Any vehicle that acts as a taxi (typically licensed or regulated). |
TRUCK |
Generally, a vehicle with a large storage capacity. |
TWO_WHEELER |
A motorcycle, moped, or other two-wheeled vehicle |
BICYCLE |
Human-powered transport. |
PEDESTRIAN |
A human transporter, typically walking or running, traveling along pedestrian pathways. |
VehicleAttribute
Describes a vehicle attribute as a key-value pair. The "key:value" string length cannot exceed 256 characters.
Fields | |
---|---|
key |
The attribute's key. Keys may not contain the colon character (:). |
value |
The attribute's value. |
Union field vehicle_attribute_value . The attribute's value, can be in string, bool, or double type. vehicle_attribute_value can be only one of the following: |
|
string_ |
String typed attribute value. Note: This is identical to the |
bool_ |
Boolean typed attribute value. |
number_ |
Double typed attribute value. |
VehicleAttributeList
A list-of-lists datatype for vehicle attributes.
Fields | |
---|---|
attributes[] |
A list of attributes in this collection. |
VehicleLocation
The location, speed, and heading of a vehicle at a point in time.
Fields | |
---|---|
location |
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 |
horizontal_accuracy |
Deprecated: Use |
latlng_ |
Accuracy of |
heading |
Direction the vehicle is moving in degrees. 0 represents North. The valid range is [0,360). |
bearing_accuracy |
Deprecated: Use |
heading_ |
Accuracy of |
altitude |
Altitude in meters above WGS84. |
vertical_accuracy |
Deprecated: Use |
altitude_ |
Accuracy of |
speed_kmph |
Speed of the vehicle in kilometers per hour. Deprecated: Use |
speed |
Speed of the vehicle in meters/second |
speed_ |
Accuracy of |
update_ |
The time when |
server_ |
Output only. The time when the server received the location information. |
location_ |
Provider of location data (for example, |
is_ |
Whether |
is_ |
Input only. Indicates whether the GPS sensor is enabled on the mobile device. |
time_ |
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. |
num_stale_updates |
Input only. Deprecated: Other signals are now used to determine if a location is stale. |
raw_ |
Raw vehicle location (unprocessed by road-snapper). |
raw_ |
Timestamp associated with the raw location. |
raw_ |
Source of the raw location. Defaults to |
raw_ |
Accuracy of |
supplemental_ |
Supplemental location provided by the integrating app. |
supplemental_ |
Timestamp associated with the supplemental location. |
supplemental_ |
Source of the supplemental location. Defaults to |
supplemental_ |
Accuracy of |
road_snapped |
Deprecated: Use |
VehicleMatch
Contains the vehicle and related estimates for a vehicle that match the points of active trips for the vehicle SearchVehiclesRequest
.
Fields | |
---|---|
vehicle |
Required. A vehicle that matches the request. |
vehicle_ |
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 |
vehicle_ |
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. |
vehicle_ |
Required. The straight-line distance between the vehicle and the pickup point specified in the request. |
vehicle_ |
The complete vehicle's driving ETA to the drop off point specified in the request. The ETA includes stopping at any waypoints before the |
vehicle_ |
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 |
trip_ |
Required. The trip type of the request that was used to calculate the ETA to the pickup point. |
vehicle_ |
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. |
vehicle_ |
Type of the vehicle match. |
requested_ |
The order requested for sorting vehicle matches. Equivalent to |
ordered_ |
The order requested for sorting vehicle matches. Equivalent to |
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. |
VehicleState
The state of a Vehicle
.
Enums | |
---|---|
UNKNOWN_VEHICLE_STATE |
Default, used for unspecified or unrecognized vehicle states. |
OFFLINE |
The vehicle is not accepting new trips. Note: the vehicle may continue to operate in this state while completing a trip assigned to it. |
ONLINE |
The vehicle is accepting new trips. |
VisualTrafficReportPolylineRendering
Describes how clients should color one portion of the polyline along the route.
Fields | |
---|---|
road_ |
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. |
RoadStretch
One road stretch that should be rendered.
Fields | |
---|---|
style |
Required. The style to apply. |
offset_ |
Required. The style should be applied between |
length_ |
Required. The length of the path where to apply the style. |
Style
The traffic style, indicating traffic speed.
Enums | |
---|---|
STYLE_UNSPECIFIED |
No style selected. |
SLOWER_TRAFFIC |
Traffic is slowing down. |
TRAFFIC_JAM |
There is a traffic jam. |
Waypoint
Describes intermediate points along a route for a VehicleMatch
in a SearchVehiclesResponse
. This concept is represented as a TripWaypoint
in all other endpoints.
Fields | |
---|---|
lat_ |
The location of this waypoint. |
eta |
The estimated time that the vehicle will arrive at this waypoint. |
WaypointType
The type of waypoint.
Enums | |
---|---|
UNKNOWN_WAYPOINT_TYPE |
Unknown or unspecified waypoint type. |
PICKUP_WAYPOINT_TYPE |
Waypoints for picking up riders or items. |
DROP_OFF_WAYPOINT_TYPE |
Waypoints for dropping off riders or items. |
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE |
Waypoints for intermediate destinations in a multi-destination trip. |