索引
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 |
必需。要创建的车辆实体。创建车辆时,以下字段是必填字段:
创建车辆时,系统会忽略以下字段:
所有其他字段均为选填字段,如果提供,系统将使用这些字段。 |
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 |
未定义的位置 PowerSaveMode |
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 或 Wi-Fi 接入点。 |
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(例如会话 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 米(含 400 米)到 10000 米(含)之间。 |
count |
必需。指定要返回的车辆数量上限。该值必须介于 1 到 50 之间(含 1 和 50)。 |
minimum_capacity |
必需。指定行程所考虑的乘客人数。该值必须大于或等于 1。容量值不考虑驱动程序。 |
trip_types[] |
必需。表示建议的行程的类型。必须且只能包含一种类型。不允许使用“ |
maximum_staleness |
将搜索范围限制为在指定持续时间内向 Fleet Engine 发送位置信息更新的车辆。仍在传输其位置信息的固定交通工具不被视为过时。如果未设置此字段,则服务器将使用 5 分钟作为默认值。 |
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 不再支持 TerminalPoint。请改用 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[] |
仅限输出。此行程的预计路线,到备选点中第一个条目。请注意,第一个航点可能属于其他行程。 |
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 Maps Platform 的行程和送货解决方案的客户可以查看路况信息。 |
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 。属性的值,可以是字符串、布尔值或双精度类型。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 |
仅限输入。自该位置首次发送到服务器以来的时间(以秒为单位)。对于第一次更新,此值将为 0。如果时间未知(例如,当应用重启时),此值会重置为零。 |
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 |
多目的地行程中中间目的地的航点。 |