Package maps.fleetengine.v1

Index

TripService

Trip management service.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Creates a trip in the Fleet Engine and returns the new trip.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Get information about a single trip.
ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Report billable trip usage.
SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

Get all the trips for a specific vehicle.
UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

Updates trip data.

VehicleService

Vehicle management service.

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Instantiates a new vehicle associated with an on-demand rideshare or deliveries provider. Each Vehicle must have a unique vehicle ID.

The following Vehicle fields are required when creating a Vehicle:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

The following Vehicle fields are ignored when creating a Vehicle:

  • 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.
GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Returns a vehicle from the Fleet Engine.
ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

Returns a paginated list of vehicles associated with a provider that match the request options.
SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Returns a list of vehicles that match the request options.
UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

Writes updated vehicle data to the Fleet Engine.

When updating a Vehicle, the following fields cannot be updated since they are managed by the server:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

The vehicle name also cannot be updated.

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.
UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

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 UpdateVehicle, where the whole attributes field will be replaced by the one in UpdateVehicleRequest, attributes not in the request would be removed.

BatteryInfo

Information about the device's battery.

Fields
battery_status

BatteryStatus

Status of the battery, whether full or charging etc.
power_source

PowerSource

Status of battery power source.
battery_percentage

float

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_reading_interval[]

SpeedReadingInterval

Traffic speed along the path from the previous waypoint to the current waypoint.
encoded_path_to_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.

CreateTripRequest

CreateTrip request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
parent

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.
trip_id

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

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.

CreateVehicleRequest

CreateVehicle request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
parent

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.
vehicle_id

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

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.

DeviceSettings

Information about various settings on the mobile device.

Fields
location_power_save_mode

LocationPowerSaveMode

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

bool

Whether the device is currently in power save mode.
is_interactive

bool

Whether the device is in an interactive state.
battery_info

BatteryInfo

Information about the battery state.

GetTripRequest

GetTrip request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
name

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.
view

TripView

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

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.
remaining_waypoints_version

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.
route_format_type

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.
current_route_segment_traffic_version

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.
remaining_waypoints_route_version

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.

GetVehicleRequest

GetVehicle request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
name

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.
current_route_segment_version

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.
waypoints_version

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.

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_code

string

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

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"

ListVehiclesRequest

ListVehicles request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
parent

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.
page_size

int32

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

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.
minimum_capacity

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.
trip_types[]

TripType

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

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.
vehicle_type_categories[]

Category

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

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".
required_one_of_attributes[]

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".
required_one_of_attribute_sets[]

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".
vehicle_state

VehicleState

Restricts the response to vehicles that have this vehicle state.
on_trip_only

bool

Only return the vehicles with current trip(s).
filter

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

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[]

Vehicle

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

string

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

int64

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.

The vehicle's navigation status.

Enums
UNKNOWN_NAVIGATION_STATUS Unspecified navigation status.
NO_GUIDANCE The Driver app's navigation is in FREE_NAV mode.
ENROUTE_TO_DESTINATION Turn-by-turn navigation is available and the Driver app navigation has entered GUIDED_NAV mode.
OFF_ROUTE The vehicle has gone off the suggested route.
ARRIVED_AT_DESTINATION The vehicle is within approximately 50m of the destination.

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

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.
country_code

string

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

BillingPlatformIdentifier

The platform upon which the request was issued.
related_ids[]

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.
solution_type

SolutionType

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

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_code

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.
region_code

string

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

string

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

string

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

string

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

SdkType

The type of SDK sending the request.
maps_sdk_version

string

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

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

Platform of the calling SDK.
manufacturer

string

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

int32

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

string

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

RequestHeader

The standard Fleet Engine request header.
parent

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.
vehicle_id

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
active_trips_only

bool

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

int32

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

string

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

Duration

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

SearchTripsResponse

SearchTrips response message.

Fields
trips[]

Trip

The list of trips for the requested vehicle.
next_page_token

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.

SearchVehiclesRequest

SearchVehicles request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
parent

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.
pickup_point

TerminalLocation

Required. The pickup point to search near.
dropoff_point

TerminalLocation

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

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).
count

int32

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

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.
trip_types[]

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.
maximum_staleness

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.
vehicle_types[]

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.
required_attributes[]

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.
required_one_of_attributes[]

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.
required_one_of_attribute_sets[]

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.
order_by

VehicleMatchOrder

Required. Specifies the desired ordering criterion for results.
include_back_to_back

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.
trip_id

string

Indicates the trip associated with this SearchVehicleRequest.
current_trips_present

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.
filter

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").

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[]

VehicleMatch

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

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_polyline_point_index

int32

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

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

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

LatLng

Required. Denotes the actual location.
timestamp

Timestamp

Indicates when the stop happened.
stop_time
(deprecated)

Timestamp

Input only. Deprecated. Use the timestamp field.

TerminalLocation

Describes the location of a waypoint.

Fields
point

LatLng

Required. Denotes the location of a trip waypoint.
terminal_point_id
(deprecated)

TerminalPointId

Deprecated: Specify the point field instead.
access_point_id
(deprecated)

string

Deprecated: Specify the point field instead.
trip_id
(deprecated)

string

Deprecated.
terminal_location_type
(deprecated)

WaypointType

Deprecated: Vehicle.waypoint will have this data.

TerminalPointId

Deprecated: TerminalPoints are no longer supported in Fleet Engine. Use TerminalLocation.point instead.

Fields
value
(deprecated)

string

Deprecated.
Union field Id. Deprecated. Id can be only one of the following:
place_id
(deprecated)

string

Deprecated.
generated_id
(deprecated)

string

Deprecated.

TrafficPolylineData

Traffic conditions along the expected vehicle route.

Fields
traffic_rendering

VisualTrafficReportPolylineRendering

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

Trip

Trip metadata.

Fields
name

string

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

string

ID of the vehicle making this trip.
trip_status

TripStatus

Current status of the trip.
trip_type

TripType

The type of the trip.
pickup_point

TerminalLocation

Location where customer indicates they will be picked up.
actual_pickup_point

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.
actual_pickup_arrival_point

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.
pickup_time

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.
intermediate_destinations[]

TerminalLocation

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

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.
intermediate_destination_index

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.
actual_intermediate_destination_arrival_points[]

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.
actual_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.
dropoff_point

TerminalLocation

Location where customer indicates they will be dropped off.
actual_dropoff_point

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.
dropoff_time

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.
remaining_waypoints[]

TripWaypoint

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

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.
route[]

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.
current_route_segment

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.
current_route_segment_version

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.
current_route_segment_traffic

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.
current_route_segment_traffic_version

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.
current_route_segment_end_point

TripWaypoint

Output only. The waypoint where current_route_segment ends.
remaining_distance_meters

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.
eta_to_first_waypoint

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).
remaining_time_to_first_waypoint

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).
remaining_waypoints_version

Timestamp

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

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.
number_of_passengers

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.
last_location

VehicleLocation

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

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.
view

TripView

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

TerminalLocation

The location of this waypoint.
trip_id

string

The trip associated with this waypoint.
waypoint_type

WaypointType

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

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.
encoded_path_to_waypoint

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.
traffic_to_waypoint

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.
distance_meters

Int32Value

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

Timestamp

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

Duration

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

UpdateTripRequest

UpdateTrip request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
name

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

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.
update_mask

FieldMask

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

UpdateVehicleAttributesRequest

UpdateVehicleAttributes request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
name

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.
attributes[]

VehicleAttribute

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

UpdateVehicleAttributesResponse

UpdateVehicleAttributes response message.

Fields
attributes[]

VehicleAttribute

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

UpdateVehicleRequest

`UpdateVehicle request message.

Fields
header

RequestHeader

The standard Fleet Engine request header.
name

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

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.
update_mask

FieldMask

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

Vehicle

Vehicle metadata.

Fields
name

string

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

VehicleState

The vehicle state.
supported_trip_types[]

TripType

Trip types supported by this vehicle.
current_trips[]

string

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

VehicleLocation

Last reported location of the vehicle.
maximum_capacity

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.
attributes[]

VehicleAttribute

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

VehicleType

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

LicensePlate

License plate information for the vehicle.
route[]
(deprecated)

TerminalLocation

Deprecated: Use Vehicle.waypoints instead.
current_route_segment

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.
current_route_segment_traffic

TrafficPolylineData

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

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.
current_route_segment_end_point

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.
remaining_distance_meters

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.
eta_to_first_waypoint

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.
remaining_time_seconds

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.
waypoints[]

TripWaypoint

The remaining waypoints assigned to this Vehicle.
waypoints_version

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.
back_to_back_enabled

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.
navigation_status

NavigationStatus

The vehicle's navigation status.
device_settings

DeviceSettings

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

VehicleType

The type of vehicle.

Fields
category

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

string

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

string

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_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_value

bool

Boolean typed attribute value.
number_value

double

Double typed attribute value.

VehicleAttributeList

A list-of-lists datatype for vehicle attributes.

Fields
attributes[]

VehicleAttribute

A list of attributes in this collection.

VehicleLocation

The location, speed, and heading of a vehicle at a point in time.

Fields
location

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.
horizontal_accuracy
(deprecated)

DoubleValue

Deprecated: Use latlng_accuracy instead.
latlng_accuracy

DoubleValue

Accuracy of location in meters as a radius.
heading

Int32Value

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

DoubleValue

Deprecated: Use heading_accuracy instead.
heading_accuracy

DoubleValue

Accuracy of heading in degrees.
altitude

DoubleValue

Altitude in meters above WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Deprecated: Use altitude_accuracy instead.
altitude_accuracy

DoubleValue

Accuracy of altitude in meters.
speed_kmph
(deprecated)

Int32Value

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

DoubleValue

Speed of the vehicle in meters/second
speed_accuracy

DoubleValue

Accuracy of speed in meters/second.
update_time

Timestamp

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

Timestamp

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

LocationSensor

Provider of location data (for example, GPS).
is_road_snapped

BoolValue

Whether location is snapped to a road.
is_gps_sensor_enabled

BoolValue

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

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.
num_stale_updates
(deprecated)

Int32Value

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

LatLng

Raw vehicle location (unprocessed by road-snapper).
raw_location_time

Timestamp

Timestamp associated with the raw location.
raw_location_sensor

LocationSensor

Source of the raw location. Defaults to GPS.
raw_location_accuracy

DoubleValue

Accuracy of raw_location as a radius, in meters.
supplemental_location

LatLng

Supplemental location provided by the integrating app.
supplemental_location_time

Timestamp

Timestamp associated with the supplemental location.
supplemental_location_sensor

LocationSensor

Source of the supplemental location. Defaults to CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Accuracy of supplemental_location as a radius, in meters.
road_snapped
(deprecated)

bool

Deprecated: Use is_road_snapped instead.

VehicleMatch

Contains the vehicle and related estimates for a vehicle that match the points of active trips for the vehicle SearchVehiclesRequest.

Fields
vehicle

Vehicle

Required. A vehicle that matches the request.
vehicle_pickup_eta

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.
vehicle_pickup_distance_meters

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.
vehicle_pickup_straight_line_distance_meters

Int32Value

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

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.
vehicle_pickup_to_dropoff_distance_meters

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.
trip_type

TripType

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

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.
vehicle_match_type

VehicleMatchType

Type of the vehicle match.
requested_ordered_by

VehicleMatchOrder

The order requested for sorting vehicle matches.
ordered_by

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).

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_stretch[]

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.

RoadStretch

One road stretch that should be rendered.

Fields
style

Style

Required. The style to apply.
offset_meters

int32

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

int32

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_lng

LatLng

The location of this waypoint.
eta

Timestamp

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.