索引
TripService
(界面)VehicleService
(界面)BatteryInfo
(消息)BatteryStatus
(枚举)BillingPlatformIdentifier
(枚举)ConsumableTrafficPolyline
(消息)CreateTripRequest
(消息)CreateVehicleRequest
(消息)DeviceSettings
(消息)GetTripRequest
(消息)GetVehicleRequest
(消息)LicensePlate
(消息)ListVehiclesRequest
(消息)ListVehiclesResponse
(消息)LocationPowerSaveMode
(枚举)LocationSensor
(枚举)NavigationStatus
(枚举)PolylineFormatType
(枚举)PowerSource
(枚举)ReportBillableTripRequest
(消息)ReportBillableTripRequest.SolutionType
(枚举)RequestHeader
(消息)RequestHeader.Platform
(枚举)RequestHeader.SdkType
(枚举)SearchTripsRequest
(消息)SearchTripsResponse
(消息)SearchVehiclesRequest
(消息)SearchVehiclesRequest.CurrentTripsPresent
(枚举)SearchVehiclesRequest.VehicleMatchOrder
(枚举)SearchVehiclesResponse
(消息)SpeedReadingInterval
(消息)SpeedReadingInterval.Speed
(枚举)StopLocation
(消息)TerminalLocation
(消息)TerminalPointId
(消息)(已弃用)TrafficPolylineData
(消息)Trip
(消息)TripStatus
(枚举)TripType
(枚举)TripView
(枚举)TripWaypoint
(消息)UpdateTripRequest
(消息)UpdateVehicleAttributesRequest
(消息)UpdateVehicleAttributesResponse
(消息)UpdateVehicleRequest
(消息)Vehicle
(消息)Vehicle.VehicleType
(消息)Vehicle.VehicleType.Category
(枚举)VehicleAttribute
(消息)VehicleAttributeList
(消息)VehicleLocation
(消息)VehicleMatch
(消息)VehicleMatch.VehicleMatchType
(枚举)VehicleState
(枚举)VisualTrafficReportPolylineRendering
(消息)VisualTrafficReportPolylineRendering.RoadStretch
(消息)VisualTrafficReportPolylineRendering.RoadStretch.Style
(枚举)Waypoint
(消息)WaypointType
(枚举)
TripService
行程管理服务。
CreateTrip |
---|
在 Fleet Engine 中创建行程并返回新行程。 |
GetTrip |
---|
获取单个行程的相关信息。 |
ReportBillableTrip |
---|
报告计费行程使用情况。 |
SearchTrips |
---|
获取特定车辆的所有行程信息。 |
UpdateTrip |
---|
更新行程数据。 |
VehicleService
车辆管理服务。
CreateVehicle |
---|
实例化与按需拼车或配送服务提供商关联的新车。每个 创建
创建
其他所有字段均为选填字段,如果提供,则会使用这些字段。 |
GetVehicle |
---|
从 Fleet Engine 中退回车辆。 |
ListVehicles |
---|
返回与提供商关联的与请求选项匹配的车辆的分页列表。 |
SearchVehicles |
---|
返回与请求选项匹配的车辆列表。 |
UpdateVehicle |
---|
将更新后的车辆数据写入 Fleet Engine。 更新
车辆“ 如果 |
UpdateVehicleAttributes |
---|
部分更新车辆的属性。只有请求中提到的属性才会更新,其他属性不会有任何改变。注意:这与 |
BatteryInfo
设备电池的相关信息。
字段 | |
---|---|
battery_status |
电池状态,是已充满还是正在充电等 |
power_source |
电池电源状态。 |
battery_percentage |
当前电池电量百分比 [0-100]。 |
BatteryStatus
电池状态,是已充满还是正在充电等
枚举 | |
---|---|
UNKNOWN_BATTERY_STATUS |
电池状态未知。 |
BATTERY_STATUS_CHARGING |
电池正在充电。 |
BATTERY_STATUS_DISCHARGING |
电池正在放电。 |
BATTERY_STATUS_FULL |
电池电量已满。 |
BATTERY_STATUS_NOT_CHARGING |
电池未在充电。 |
BATTERY_STATUS_POWER_LOW |
电池电量低。 |
BillingPlatformIdentifier
一组值,用于指明发出请求的平台。
枚举 | |
---|---|
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED |
默认。用于未指定的平台。 |
SERVER |
该平台是客户端服务器。 |
WEB |
该平台是一个网络浏览器。 |
ANDROID |
平台是 Android 移动设备。 |
IOS |
该平台是 iOS 移动设备。 |
OTHERS |
此枚举中未列出的其他平台。 |
ConsumableTrafficPolyline
车辆行驶路线沿途的交通密度。
字段 | |
---|---|
speed_reading_interval[] |
从上一个航点到当前航点的路径上的交通速度。 |
encoded_path_to_waypoint |
驾驶员从上一个航点到当前航点的路径。此路径中包含地标,以便客户端可以显示路径上的交通标记(请参阅 |
CreateTripRequest
CreateTrip 请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
parent |
必需。必须采用 |
trip_id |
必需。唯一行程 ID。需遵循以下限制:
|
trip |
必需。要创建的行程实体。 创建行程时,以下字段是必填字段:
如果您提供以下字段,系统会使用它们:
所有其他“行程”字段均会被忽略。例如,即使您在创建请求中传入的 只有 为共享行程设置 如果您指定 系统会使用 |
CreateVehicleRequest
CreateVehicle
请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
parent |
必需。必须采用 |
vehicle_id |
必需。唯一车辆 ID。需遵循以下限制:
|
vehicle |
必需。要创建的 Vehicle 实体。创建车辆时,必须填写以下字段:
创建车辆时,系统会忽略以下字段:
其他所有字段均为选填字段,如果提供,则会使用这些字段。 |
DeviceSettings
与移动设备上各种设置相关的信息。
字段 | |
---|---|
location_power_save_mode |
确定在省电模式开启时,位置信息功能在设备上的运作方式。 |
is_power_save_mode |
设备当前是否处于节能模式。 |
is_interactive |
设备是否处于交互状态。 |
battery_info |
关于电池状态的信息。 |
GetTripRequest
GetTrip 请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
view |
应返回的“行程”字段的子集及其解释。 |
current_route_segment_version |
指示检索 |
remaining_waypoints_version |
表示检索 |
route_format_type |
返回的当前路线格式,即 |
current_route_segment_traffic_version |
表示检索 |
remaining_waypoints_route_version |
指示检索 |
GetVehicleRequest
GetVehicle
请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
current_route_segment_version |
表示检索 |
waypoints_version |
指示检索 |
LicensePlate
车辆的车牌信息。为避免存储个人身份信息,实体中只会存储关于车牌的最少信息。
字段 | |
---|---|
country_code |
必需。CLDR 国家/地区代码。例如, |
last_character |
车牌的最后一位数或“-1”表示车牌中没有数值。
|
ListVehiclesRequest
ListVehicles
请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
parent |
必需。必须采用 |
page_size |
要退回的车辆数量上限。默认值:100。 |
page_token |
之前对 |
minimum_capacity |
指定所需的最小车辆容量。所有返回车辆的 |
trip_types[] |
将响应限制为至少支持一种指定行程类型的车辆。 |
maximum_staleness |
将响应限制为在指定时长内向 Fleet Engine 发送位置信息更新的车辆。仍在传输位置信息的静止车辆不会被视为过时。如果存在,必须为有效的正时长。 |
vehicle_type_categories[] |
必需。将响应限制为某个指定类型类别的车辆。不允许 |
required_attributes[] |
调用方可以使用
将响应限制为具有指定属性的车辆。此字段是结合/AND 运算。最多允许 50 个 required_attributes。这与车辆允许的属性数量上限一致。每个重复的字符串都应采用“key:value”格式。 |
required_one_of_attributes[] |
将响应限制为在每个 |
required_one_of_attribute_sets[] |
与
将响应限制为与 |
vehicle_state |
将响应限制为具有此车辆状态的车辆。 |
on_trip_only |
仅归还当前行程的车辆。 |
filter |
可选。列出车辆时要应用的过滤查询。如需查看过滤器语法的示例,请参阅 http://aip.dev/160。 此字段旨在替换 此过滤条件充当具有其他约束条件(例如 请注意,仅支持针对车辆属性(例如 此外,所有属性均存储为字符串,因此唯一支持的属性比较是字符串比较。若要与数字或布尔值进行比较,必须明确用引号将这些值括起来,才能被视为字符串(例如 |
viewport |
可选。此过滤器可将返回的车辆限制为最近一次已知位置位于视口定义的矩形区域内的车辆。 |
ListVehiclesResponse
ListVehicles
响应消息。
字段 | |
---|---|
vehicles[] |
与请求中的条件相符的车辆。返回的车辆数量上限由请求中的 |
next_page_token |
用于检索下一页车辆的令牌。如果不再有符合请求条件的车辆,则为空。 |
total_size |
必需。所有页面中符合请求条件的车辆总数。 |
LocationPowerSaveMode
当设备处于“省电模式”时,位置信息功能在移动设备上的运行方式功能已开启。(https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())
枚举 | |
---|---|
UNKNOWN_LOCATION_POWER_SAVE_MODE |
未定义的 LocationPowerSaveMode |
LOCATION_MODE_NO_CHANGE |
位置信息提供程序应该不受省电模式的影响,或者省电模式已关闭。 |
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF |
当省电模式开启且设备处于非交互状态时,应停用基于 GPS 的位置信息提供程序。 |
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF |
当省电模式开启且设备处于非互动状态时,应停用所有位置信息提供程序。 |
LOCATION_MODE_FOREGROUND_ONLY |
所有位置信息提供程序都将保持可用,但只能对前台应用提供位置信息修复。 |
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF |
位置信息服务不会关闭,但当设备处于非互动状态时,LocationManager 会限制向提供程序发出的所有请求。 |
LocationSensor
用于确定位置的传感器或方法。
枚举 | |
---|---|
UNKNOWN_SENSOR |
传感器不明或未知。 |
GPS |
GPS 或辅助 GPS。 |
NETWORK |
辅助 GPS、手机基站 ID 或 WiFi 接入点。 |
PASSIVE |
基站 ID 或 WiFi 接入点。 |
ROAD_SNAPPED_LOCATION_PROVIDER |
由移动设备确定为最可能道路位置的位置。 |
CUSTOMER_SUPPLIED_LOCATION |
由独立来源提供的由客户提供的位置。通常,此值用于通过非运行驱动程序 SDK 的移动设备提供的位置。如果其他枚举值描述原始来源,请使用该值。标有 CUSTOMER_SUPPLIED_LOCATION 的位置通常通过车辆的 last_location.supplemental_location_sensor 提供。 |
FLEET_ENGINE_LOCATION |
Fleet Engine 根据可用的信号计算出的位置。仅限输出。如果请求中包含此值,则该值将被拒绝。 |
FUSED_LOCATION_PROVIDER |
Android 的一体化位置信息提供程序。 |
CORE_LOCATION |
Apple 操作系统上的位置信息提供程序。 |
PolylineFormatType
多段线格式的类型。
枚举 | |
---|---|
UNKNOWN_FORMAT_TYPE |
格式未指定或未知。 |
LAT_LNG_LIST_TYPE |
google.type.LatLng 的列表。 |
ENCODED_POLYLINE_TYPE |
使用多段线压缩算法编码的多段线。尚不支持解码。 |
PowerSource
为电池充电的充电器类型。
枚举 | |
---|---|
UNKNOWN_POWER_SOURCE |
电源未知。 |
POWER_SOURCE_AC |
电源是交流电源充电器。 |
POWER_SOURCE_USB |
电源是 USB 端口。 |
POWER_SOURCE_WIRELESS |
电源为无线电源。 |
POWER_SOURCE_UNPLUGGED |
电池已拔出。 |
ReportBillableTripRequest
ReportBillableTrip 请求消息。
字段 | |
---|---|
name |
必需。必须采用 |
country_code |
必需。出发地所在国家/地区的双字母国家/地区代码。价格根据国家/地区代码定义。 |
platform |
发出请求的平台。 |
related_ids[] |
与所报告的行程直接相关的标识符。这些通常是在提供行程 ID 之前完成的预订操作的 ID(例如会话 ID)。 |
solution_type |
用于报告的行程的 GMP 产品解决方案类型(例如 |
SolutionType
已报告行程的不同解决方案类型的选择器。
枚举 | |
---|---|
SOLUTION_TYPE_UNSPECIFIED |
默认值。为了实现向后兼容性,API 将默认使用 ON_DEMAND_RIDESHARING_AND_DELIVERIES ,这是第一个受支持的解决方案类型。 |
ON_DEMAND_RIDESHARING_AND_DELIVERIES |
解决方案是按需拼车和送货上门。 |
RequestHeader
RequestHeader 包含所有 Fleet Engine RPC 请求所共有的字段。
字段 | |
---|---|
language_code |
BCP-47 语言代码,例如 en-US 或 sr-Latn。如需了解详情,请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。如果未指定,回答可以采用任何语言,如果存在这种名称,则会优先使用英语。字段值示例: |
region_code |
必需。发起请求的区域的 CLDR 地区代码。字段值示例: |
sdk_version |
调用方 SDK 的版本(如果适用)。版本格式为“major.minor.patch”,例如: |
os_version |
运行调用 SDK 的操作系统版本。字段值示例: |
device_model |
运行调用 SDK 的设备型号。字段值示例: |
sdk_type |
发送请求的 SDK 的类型。 |
maps_sdk_version |
调用 SDK 所依赖的 MapSDK 版本(如果适用)。版本格式为“major.minor.patch”,例如: |
nav_sdk_version |
调用 SDK 所依赖的 NavSDK 的版本(如果适用)。版本格式为“major.minor.patch”,例如: |
platform |
调用方 SDK 的平台。 |
manufacturer |
来自调用 SDK 的 Android 设备的制造商,仅适用于 Android SDK。字段值示例: |
android_api_level |
调用方 SDK 的 Android API 级别,仅适用于 Android SDK。字段值示例: |
trace_id |
可选 ID,可出于记录目的而提供,以便标识请求。 |
平台
调用方 SDK 的平台。
枚举 | |
---|---|
PLATFORM_UNSPECIFIED |
默认值。如果平台省略,则使用此值。 |
ANDROID |
请求来自 Android。 |
IOS |
请求来自 iOS。 |
WEB |
请求来自网络。 |
SdkType
可能的 SDK 类型。
枚举 | |
---|---|
SDK_TYPE_UNSPECIFIED |
默认值。如果省略 sdk_type ,则系统会使用此值。 |
CONSUMER |
调用方 SDK 为使用方。 |
DRIVER |
调用方 SDK 为驱动程序。 |
JAVASCRIPT |
调用方 SDK 是 JavaScript。 |
SearchTripsRequest
SearchTrips 请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
parent |
必需。必须采用 |
vehicle_id |
与请求中的行程相关联的车辆。如果未指定,返回的行程将不包含:
|
active_trips_only |
如果设置为 true,响应会包含影响司机路线的行程。 |
page_size |
如果未设置,服务器会决定要返回的结果数。 |
page_token |
将此项设为之前在 |
minimum_staleness |
如果指定,则返回在 |
SearchTripsResponse
SearchTrips 响应消息。
字段 | |
---|---|
trips[] |
所请求车辆的行程列表。 |
next_page_token |
在 SearchTripsRequest 中传递此令牌,以对列表结果进行分页。该 API 在每次调用时都会返回一个行程列表,如果没有更多结果,则行程列表为空。 |
SearchVehiclesRequest
SearchVehicles
请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
parent |
必需。必须采用 |
pickup_point |
必需。要在附近搜索的上车点。 |
dropoff_point |
客户的预期下车地点。如果 |
pickup_radius_meters |
必需。定义上车点周围的车辆搜索半径。只会返回搜索半径范围内的车辆。值必须介于 400 到 10000 米(含)之间。 |
count |
必需。指定要返回的最大车辆数。该值必须介于 1 到 50 之间(含 1 和 50)。 |
minimum_capacity |
必需。指定某个行程要考虑的乘客人数。该值必须大于或等于 1。容量值不考虑驱动程序。 |
trip_types[] |
必需。表示建议的行程类型。必须且只能包含一种类型。不允许使用 |
maximum_staleness |
将搜索范围限制为在指定时长内向 Fleet Engine 发送了位置信息更新的车辆。仍在传输位置信息的静止车辆不会被视为过时。如果未设置此字段,服务器将使用五分钟作为默认值。 |
vehicle_types[] |
必需。将搜索范围限制为具有某种指定类型的车辆。必须至少指定一种车辆类型。不允许使用类别为 |
required_attributes[] |
调用方可以使用
将搜索范围限制为具有指定属性的车辆。此字段是结合/AND 运算。最多允许 50 个 required_attributes。这与车辆允许的属性数量上限一致。 |
required_one_of_attributes[] |
将搜索范围限制为在每个 |
required_one_of_attribute_sets[] |
与
将搜索范围限制为具有 |
order_by |
必需。指定所需的结果排序标准。 |
include_back_to_back |
指明只有一个有效行程的车辆是否符合此搜索条件。仅当未指定 默认值为 |
trip_id |
表示与此 |
current_trips_present |
该参数指示包含有效行程的车辆是否符合此搜索条件。如果 |
filter |
可选。搜索车辆时要应用的过滤条件查询。如需查看过滤器语法的示例,请参阅 http://aip.dev/160。 此字段旨在替换 此过滤条件充当具有其他约束条件(例如 请注意,仅支持针对车辆属性(例如 此外,所有属性均存储为字符串,因此唯一支持的属性比较是字符串比较。若要与数字或布尔值进行比较,必须明确用引号将这些值括起来,才能被视为字符串(例如 |
CurrentTripsPresent
指定针对车辆当前行程的限制类型。
枚举 | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
具有行程的车辆的可用性受 include_back_to_back 字段约束。 |
NONE |
没有行程的车辆会显示在搜索结果中。使用此值时,include_back_to_back 不能为 true 。 |
ANY |
搜索结果中会显示当前行程最多为 5 个、航点为 10 个的车辆。使用此值时,include_back_to_back 不能为 true 。 |
VehicleMatchOrder
指定响应中车辆匹配的顺序。
枚举 | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
默认值,用于未指定或无法识别的车辆匹配订单。 |
PICKUP_POINT_ETA |
按车辆驾车前往上车点的时间升序排列。 |
PICKUP_POINT_DISTANCE |
按车辆到上车点的行驶距离升序排序。 |
DROPOFF_POINT_ETA |
按车辆行驶时间到下车点的升序排序。只有在请求中指定了下车点时,才能使用此顺序。 |
PICKUP_POINT_STRAIGHT_DISTANCE |
按从车辆上次报告位置到上车点的直线距离升序排序。 |
COST |
按配置的匹配费用升序排序。匹配费用是指直线距离和预计到达时间之间的加权计算。权重已设置为默认值,并且可以根据客户进行修改。如果需要为您的项目修改这些权重,请与 Google 支持团队联系。 |
SearchVehiclesResponse
SearchVehicles
响应消息。
字段 | |
---|---|
matches[] |
符合 |
SpeedReadingInterval
路径中连续路段上的交通密度指示器。如果路径包含点 P_0、P_1、...、P_N(从零开始的索引),SpeedReadingInterval 可定义一个间隔并使用以下类别描述该路径的路况。
字段 | |
---|---|
start_polyline_point_index |
路径中此间隔的起始索引。在 JSON 中,当索引为 0 时,该字段将显示为未填充。 |
end_polyline_point_index |
路径中此间隔的结束索引。在 JSON 中,当索引为 0 时,该字段将显示为未填充。 |
speed |
此时间间隔内的交通速度。 |
速度
基于路况数据的多段线速度分类。
枚举 | |
---|---|
SPEED_UNSPECIFIED |
默认值。此值未使用。 |
NORMAL |
正常速度,未检测到减速。 |
SLOW |
检测到行驶缓慢路段,但未出现交通堵塞。 |
TRAFFIC_JAM |
检测到交通堵塞。 |
StopLocation
实际经停点(上车/下车)的位置。
字段 | |
---|---|
point |
必需。表示实际位置。 |
timestamp |
指示停止的时间。 |
stop_time |
仅限输入。已弃用。使用时间戳字段。 |
TerminalLocation
描述航点的位置。
字段 | |
---|---|
point |
必需。表示行程航点的位置。 |
terminal_point_id |
已弃用:请改为指定 |
access_point_id |
已弃用:请改为指定 |
trip_id |
已弃用。 |
terminal_location_type |
已弃用: |
TerminalPointId
已弃用:Fleet Engine 不再支持 TerminalPoints。请改用 TerminalLocation.point
。
字段 | |
---|---|
value |
已弃用。 |
联合字段 Id 。已弃用。Id 只能是下列其中一项: |
|
place_id |
已弃用。 |
generated_id |
已弃用。 |
TrafficPolylineData
预计车辆路线沿途的路况。
字段 | |
---|---|
traffic_rendering |
以多段线形式呈现客户行程中所有区域的交通速度。 |
行程
行程元数据。
字段 | |
---|---|
name |
仅限输出。格式为“providers/{provider}/trips/{trip}” |
vehicle_id |
进行此行程的车辆 ID。 |
trip_status |
行程的当前状态。 |
trip_type |
行程类型。 |
pickup_point |
客户指明自提地点。 |
actual_pickup_point |
仅限输入。自提客户的实际地点。此字段供提供商提供有关实际自提信息的反馈。 |
actual_pickup_arrival_point |
仅限输入。司机到达上车点的实际时间和地点。此字段供提供商提供有关实际到达信息在上车点的反馈。 |
pickup_time |
仅限输出。乘客上车的预计未来时间,或者乘客上车的实际时间。 |
intermediate_destinations[] |
按照行程请求的中间经停点(除上车点和下车点外)。最初,共享行程将不支持此功能。 |
intermediate_destinations_version |
表示上次修改 |
intermediate_destination_index |
当 |
actual_intermediate_destination_arrival_points[] |
仅限输入。司机到达中间目的地的实际时间和地点。此字段供提供商提供有关中途目的地的实际到达信息的反馈。 |
actual_intermediate_destinations[] |
仅限输入。从中间目的地为客户提供上门服务的实际时间和地点。此字段供提供商提供有关中途目的地的实际自提信息的反馈。 |
dropoff_point |
客户表示将下车的位置。 |
actual_dropoff_point |
仅限输入。客户离开时的实际时间和地点。此字段供提供商提供有关实际下车点信息的反馈。 |
dropoff_time |
仅限输出。乘客将在最终目的地下车的预计未来时间,或他们下车的实际时间。 |
remaining_waypoints[] |
仅限输出。从当前位置到下车点的完整路径(含边界值)。此路径可包含其他行程的航点。 |
vehicle_waypoints[] |
此字段支持手动对行程的航点进行排序。它包含指定车辆的所有剩余航点,以及此行程的上车点和下车点。如果该行程尚未分配给车辆,则 Fleet Engine 会忽略此字段。出于隐私保护方面的原因,服务器在调用 |
route[] |
仅限输出。此行程到 remaining_waypoints 的第一个条目的预期路线。请注意,第一个航点可能属于其他行程。 |
current_route_segment |
仅限输出。下一个航点的编码路径。 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。尚不支持解码。 |
current_route_segment_version |
仅限输出。表示上次修改路线的时间。 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。 |
current_route_segment_traffic |
仅限输出。表示 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。 |
current_route_segment_traffic_version |
仅限输出。表示上次修改 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。 |
current_route_segment_end_point |
仅限输出。 |
remaining_distance_meters |
仅限输出。 |
eta_to_first_waypoint |
仅限输出。下一个航点的预计到达时间( |
remaining_time_to_first_waypoint |
仅限输出。从返回行程数据到 |
remaining_waypoints_version |
仅限输出。表示上次更改 |
remaining_waypoints_route_version |
仅限输出。表示上次修改 |
number_of_passengers |
不可变。表示此行程的乘客人数,不包括司机。车辆必须有可用容量,才能在 |
last_location |
仅限输出。表示沿途车辆最后报告的位置。 |
last_location_snappable |
仅限输出。指示车辆的 |
view |
将填充的“行程”字段子集以及应如何解读这些字段。 |
TripStatus
指示行程进度的状态。
枚举 | |
---|---|
UNKNOWN_TRIP_STATUS |
默认值,用于未指定或无法识别的行程状态。 |
NEW |
新创建的行程。 |
ENROUTE_TO_PICKUP |
司机正在前往上车点。 |
ARRIVED_AT_PICKUP |
司机已抵达上车点。 |
ARRIVED_AT_INTERMEDIATE_DESTINATION |
司机已抵达中途目的地,正在等待乘客。 |
ENROUTE_TO_INTERMEDIATE_DESTINATION |
司机正在前往中间目的地(不是下车点)。 |
ENROUTE_TO_DROPOFF |
司机已接住乘客,正在前往下一个目的地。 |
COMPLETE |
乘客已下车,行程已结束。 |
CANCELED |
司机、乘客或拼车服务提供商在接您前取消了行程。 |
TripType
行程的类型。
枚举 | |
---|---|
UNKNOWN_TRIP_TYPE |
默认值,用于未指定或无法识别的行程类型。 |
SHARED |
行程可能会与其他行程共用一辆车。 |
EXCLUSIVE |
此行程仅限车辆使用。 |
TripView
GetTrip
响应中不同“行程”字段集的选择器。如需了解背景信息,请参阅 AIP-157。并且还可能会添加其他数据视图。
枚举 | |
---|---|
TRIP_VIEW_UNSPECIFIED |
默认值。为了实现向后兼容性,API 将默认采用 SDK 视图。为确保稳定性和支持,建议客户选择 SDK 以外的TripView 。 |
SDK |
包括使用公开库时可能无法解析或支持的字段。 |
JOURNEY_SHARING_V1S |
对于“旅程分享”用例,系统会填充“行程”字段。此视图适用于服务器到服务器的通信。 |
TripWaypoint
描述车辆路线上的停止点或车辆行程的终点。
字段 | |
---|---|
location |
此航点的位置。 |
trip_id |
与此航点关联的行程。 |
waypoint_type |
此航点在此行程中的作用,例如上车点或下车点。 |
path_to_waypoint[] |
从上一个航点到当前航点的路径。未对列表中的第一个航点进行定义。此字段仅在收到请求时填充。 |
encoded_path_to_waypoint |
从上一个航点到当前航点的编码路径。 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。尚不支持解码。 |
traffic_to_waypoint |
到此航点的路径上的路况。请注意,路况信息仅适用于 Google 地图平台行程和交付解决方案的客户。 |
distance_meters |
从上一个航点到当前航点的路径距离。未对列表中的第一个航点进行定义。 |
eta |
预计到达此航点的时间。未对列表中的第一个航点进行定义。 |
duration |
从上一个航点到此点的行程时间。未对列表中的第一个航点进行定义。 |
UpdateTripRequest
UpdateTrip 请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
trip |
必需。与更新关联的行程。 Fleet Engine 会维护以下字段。请勿使用 Trip.update 更新这些信息。
更新共享行程的 如果您指定 为避免包含多个目的地的行程出现竞态条件,您应在将行程状态更新为 |
update_mask |
必需。指示要更新的“行程”中的哪些字段的字段掩码。 |
UpdateVehicleAttributesRequest
UpdateVehicleAttributes
请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
attributes[] |
必需。要更新的车辆属性。系统不会更改或移除未提及的属性。 |
UpdateVehicleAttributesResponse
UpdateVehicleAttributes
响应消息。
字段 | |
---|---|
attributes[] |
必需。更新后的车辆属性完整列表,包括全新、改动和未改动的属性。 |
UpdateVehicleRequest
`UpdateVehicle 请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
vehicle |
必需。要应用的
如果 同样, |
update_mask |
必需。一个字段掩码,指示要更新的 |
交通工具
车辆元数据。
字段 | |
---|---|
name |
仅限输出。此车辆的唯一名称。格式为 |
vehicle_state |
车辆状态。 |
supported_trip_types[] |
此车辆支持的行程类型。 |
current_trips[] |
仅限输出。当前分配给这辆车的行程的“ |
last_location |
上次报告的车辆位置。 |
maximum_capacity |
这辆车可载的总乘客人数。此值不考虑驱动程序。此值必须大于或等于 1。 |
attributes[] |
车辆属性列表。一辆车最多可以有 100 个属性,并且每个属性都必须有一个唯一的键。 |
vehicle_type |
必需。此车辆的类型。可用于过滤 |
license_plate |
车辆的车牌信息。 |
route[] |
已弃用:请改用 |
current_route_segment |
多段线,用于指定驾驶员应用打算前往下一个航点的路线。对于分配给车辆的所有有效行程,系统也会在 注意:此字段仅供驱动程序 SDK 使用。尚不支持解码。 |
current_route_segment_traffic |
仅限输入。Fleet Engine 会使用这些信息来改进历程分享。注意:此字段仅供驱动程序 SDK 使用。 |
current_route_segment_version |
仅限输出。 |
current_route_segment_end_point |
|
remaining_distance_meters |
|
eta_to_first_waypoint |
到达 更新车辆时,在同一请求中, |
remaining_time_seconds |
仅限输入。 更新车辆时,在同一请求中, |
waypoints[] |
分配给此车辆的其余航点。 |
waypoints_version |
仅限输出。 |
back_to_back_enabled |
指示驾驶员是否接受往返行程。如果为 |
navigation_status |
车辆的导航状态。 |
device_settings |
仅限输入。有关驾驶员所用移动设备中的设置的信息。 |
VehicleType
车辆的类型。
字段 | |
---|---|
category |
车辆类型类别 |
类别
车辆类型类别
枚举 | |
---|---|
UNKNOWN |
默认值,用于未指定或无法识别的车辆类别。 |
AUTO |
一辆汽车。 |
TAXI |
充当出租车的任何车辆(通常持牌或受监管的车辆)。 |
TRUCK |
通常是存储容量较大的车辆。 |
TWO_WHEELER |
摩托车、轻便摩托车或其他双轮机动车 |
BICYCLE |
人类的交通。 |
PEDESTRIAN |
沿人行道行驶的交通工具,通常是行走或跑步。 |
VehicleAttribute
将车辆属性描述为键值对。“key:value”字符串长度不能超过 256 个字符。
字段 | |
---|---|
key |
属性的键。键不得包含冒号字符 (:)。 |
value |
属性的值。 |
联合字段 vehicle_attribute_value 。该属性的值可以是字符串、bool 或双精度类型。vehicle_attribute_value 只能是下列其中一项: |
|
string_value |
字符串类型的属性值。 注意:这与最终会被弃用的 |
bool_value |
布尔值类型的属性值。 |
number_value |
双精度型属性值。 |
VehicleAttributeList
车辆属性的列表数据类型。
字段 | |
---|---|
attributes[] |
此集合中的属性列表。 |
VehicleLocation
车辆在某个时间点的位置、速度和方向。
字段 | |
---|---|
location |
车辆的位置。发送到 Fleet Engine 后,车辆的位置就是 GPS 位置。当您在响应中收到它时,车辆的位置可以是 GPS 位置、补充位置或其他估计位置。来源在 |
horizontal_accuracy |
已弃用:请改用 |
latlng_accuracy |
半径为 |
heading |
车辆移动的方向(以度为单位)。0 代表北方。有效范围为 [0,360)。 |
bearing_accuracy |
已弃用:请改用 |
heading_accuracy |
精确度为 |
altitude |
高于 WGS84 的高度(以米为单位)。 |
vertical_accuracy |
已弃用:请改用 |
altitude_accuracy |
精度: |
speed_kmph |
车辆的速度(以公里/小时为单位)。已弃用:请改用 |
speed |
车辆的速度(米/秒) |
speed_accuracy |
精确度为 |
update_time |
传感器根据传感器的时钟报告 |
server_time |
仅限输出。服务器收到位置信息的时间。 |
location_sensor |
位置数据的提供器(例如 |
is_road_snapped |
|
is_gps_sensor_enabled |
仅限输入。指示移动设备上是否已启用 GPS 传感器。 |
time_since_update |
仅限输入。自此位置信息首次发送至服务器以来经过的时间(以秒为单位)。对于首次更新,此值为零。如果时间未知(例如,应用重启时),则此值会重置为零。 |
num_stale_updates |
仅限输入。已弃用:现在会使用其他信号来确定营业地点是否已过时。 |
raw_location |
原始车辆位置(未由道路拦截器处理)。 |
raw_location_time |
与原始位置关联的时间戳。 |
raw_location_sensor |
原始位置的来源。默认为 |
raw_location_accuracy |
半径 |
supplemental_location |
集成应用提供的补充位置信息。 |
supplemental_location_time |
与补充位置关联的时间戳。 |
supplemental_location_sensor |
补充位置的来源。默认为 |
supplemental_location_accuracy |
半径 |
road_snapped |
已弃用:请改用 |
VehicleMatch
包含与车辆 SearchVehiclesRequest
的有效行程点匹配的车辆及相关估算值。
字段 | |
---|---|
vehicle |
必需。与请求匹配的车辆。 |
vehicle_pickup_eta |
车辆行驶的预计到达请求中指定的上车点。空值表示计算车辆的预计到达时间失败。如果 |
vehicle_pickup_distance_meters |
从车辆当前位置到请求中指定的上车点的距离,包括现有行程的任何中间上车点或下车点。此距离包括计算出的驾车(路线)距离,加上导航终点与请求的上车点之间的直线距离。(导航终点与所请求的上车点之间的距离通常很小。)空值表示计算距离时出错。 |
vehicle_pickup_straight_line_distance_meters |
必需。车辆与请求中指定的上车点之间的直线距离。 |
vehicle_dropoff_eta |
整车行驶到请求中指定的下车点的预计到达时间。预计到达时间包括在请求中指定的 |
vehicle_pickup_to_dropoff_distance_meters |
车辆从请求中指定的上车点到下车点的行驶距离(以米为单位)。该距离仅在两点之间,不包括车辆位置或车辆到达上车点或下车点之前必须访问的任何其他点。只有在请求中指定了 |
trip_type |
必需。用于计算到达上车点预计到达时间的请求的行程类型。 |
vehicle_trips_waypoints[] |
用于计算预计到达时间的有序航点列表。该列表包含车辆位置、车辆有效行程的上车点,以及请求中提供的上车点。空列表表示计算车辆的预计到达时间失败。 |
vehicle_match_type |
车辆匹配的类型。 |
requested_ordered_by |
请求对车辆匹配进行排序的顺序。 |
ordered_by |
此车辆使用的实际订单。通常,这会与“order_by”字段;不过,在某些情况下(例如内部服务器错误),也可以使用其他方法(例如 |
VehicleMatchType
车辆匹配类型。
枚举 | |
---|---|
UNKNOWN |
未知车辆匹配类型 |
EXCLUSIVE |
车辆目前没有为其分配行程,可以前往上车点。 |
BACK_TO_BACK |
车辆目前已分配给某个行程,但可在完成正在进行的行程后继续前往上车点。预计到达时间和距离时会将现有行程考虑在内。 |
CARPOOL |
车辆有足够的载客量。 |
CARPOOL_BACK_TO_BACK |
车辆将完成当前正在进行的行程,然后再前往上车点。预计到达时间和距离时会将现有行程考虑在内。 |
VehicleState
Vehicle
的状态。
枚举 | |
---|---|
UNKNOWN_VEHICLE_STATE |
默认值,用于未指定或无法识别的车辆状态。 |
OFFLINE |
车辆不接受新的行程。注意:在完成分配给它的行程期间,车辆可能会继续在此状态下运行。 |
ONLINE |
车辆正在接受新的行程。 |
VisualTrafficReportPolylineRendering
描述客户端应如何对路线中多段线的一部分着色。
字段 | |
---|---|
road_stretch[] |
可选。应沿着多段线渲染的道路拉伸。拉伸保证不会重叠,也不一定横跨整个路线。 如果没有道路延伸样式,客户端应为路线应用默认值。 |
RoadStretch
一条应渲染的道路延伸区。
字段 | |
---|---|
style |
必需。要应用的样式。 |
offset_meters |
必需。此样式应在 |
length_meters |
必需。要应用样式的路径长度。 |
样式
路况样式,表示车流速度。
枚举 | |
---|---|
STYLE_UNSPECIFIED |
未选择任何样式。 |
SLOWER_TRAFFIC |
流量正在下降。 |
TRAFFIC_JAM |
出现交通堵塞。 |
关键点
描述 SearchVehiclesResponse
中 VehicleMatch
的路线的中间点。此概念在所有其他端点中表示为 TripWaypoint
。
字段 | |
---|---|
lat_lng |
此航点的位置。 |
eta |
车辆预计将到达此航点的时间。 |
WaypointType
航点的类型。
枚举 | |
---|---|
UNKNOWN_WAYPOINT_TYPE |
未知或未指定的航点类型。 |
PICKUP_WAYPOINT_TYPE |
接送乘客或物品的航点。 |
DROP_OFF_WAYPOINT_TYPE |
放下乘客或物品的航点。 |
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE |
多目的地行程中中间目的地的航点。 |