索引
TripService
(界面)VehicleService
(界面)BatteryInfo
(消息)BatteryStatus
(枚举)BillingPlatformIdentifier
(枚举)ConsumableTrafficPolyline
(消息)CreateTripRequest
(消息)CreateVehicleRequest
(消息)DeleteTripRequest
(消息)DeleteVehicleRequest
(消息)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
(消息)TerminalLocation.PointSource
(枚举)TerminalPointId
(消息)(已弃用)TrafficPolylineData
(消息)Trip
(消息)TripAttribute
(消息)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 中创建行程,并返回新行程。 |
DeleteTrip |
---|
删除单个行程。 如果相应行程处于有效状态且已分配给车辆,则返回 FAILED_PRECONDITION。 |
GetTrip |
---|
获取有关单次行程的信息。 |
ReportBillableTrip |
---|
报告可结算的行程使用情况。 |
SearchTrips |
---|
获取特定车辆的所有行程。 |
UpdateTrip |
---|
更新行程数据。 |
VehicleService
车辆管理服务。
CreateVehicle |
---|
实例化与按需网约车或送货服务提供商关联的新车辆。每个 创建
创建
所有其他字段都是可选字段,如果提供,则会使用。 |
DeleteVehicle |
---|
从 Fleet Engine 中删除车辆。 如果车辆有正在进行的行程,则返回 FAILED_PRECONDITION。 |
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 |
必需。要创建的行程实体。 创建行程时,必须填写以下字段:
如果您提供以下字段,系统会使用这些字段:
系统会忽略所有其他 Trip 字段。例如,即使您在创建请求中传入 只有 为共享行程设置 指定 系统会使用 |
CreateVehicleRequest
CreateVehicle
请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
parent |
必需。必须采用 |
vehicle_id |
必需。唯一车辆 ID。但需遵守以下限制:
|
vehicle |
必需。要创建的车辆实体。创建车辆时,必须填写以下字段:
创建车辆时,系统会忽略以下字段:
所有其他字段都是可选字段,如果提供,则会使用。 |
DeleteTripRequest
DeleteTrip 请求消息。
字段 | |
---|---|
header |
可选。标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
DeleteVehicleRequest
DeleteVehicle 请求消息。
字段 | |
---|---|
header |
可选。标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
DeviceSettings
有关移动设备上各种设置的信息。
字段 | |
---|---|
location_power_save_mode |
省电模式开启时,位置信息功能在设备上的运行方式。 |
is_power_save_mode |
设备目前是否处于节能模式。 |
is_interactive |
设备是否处于互动状态。 |
battery_info |
有关电池状态的信息。 |
GetTripRequest
GetTrip 请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
view |
应返回的 Trip 字段子集及其解释。 |
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。这与车辆上允许的最大属性数量相符。每个重复的字符串都应采用“键:值”格式。 |
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 |
Undefined 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 或 Wi-Fi 接入点。 |
PASSIVE |
手机信号塔 ID 或 WiFi 接入点。 |
ROAD_SNAPPED_LOCATION_PROVIDER |
移动设备确定的最可能的道路位置。 |
CUSTOMER_SUPPLIED_LOCATION |
客户从独立来源提供的营业地点。通常,此值用于从运行 Driver SDK 的移动设备以外的来源提供的位置。如果原始来源由其他枚举值之一描述,请使用该值。标记为 CUSTOMER_SUPPLIED_LOCATION 的位置通常通过车辆的 last_location.supplemental_location_sensor 提供。 |
FLEET_ENGINE_LOCATION |
Fleet Engine 根据其可用的信号计算出的位置。仅限输出。如果在请求中收到此值,系统会拒绝该请求。 |
FUSED_LOCATION_PROVIDER |
Android 的 Fused Location Provider。 |
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,可提供此 ID 以便出于日志记录目的来标识请求。 |
平台
调用 SDK 的平台。
枚举 | |
---|---|
PLATFORM_UNSPECIFIED |
默认值。如果省略平台,则使用此值。 |
ANDROID |
请求来自 Android。 |
IOS |
请求来自 iOS。 |
WEB |
请求来自网络。 |
SdkType
可能的 SDK 类型。
枚举 | |
---|---|
SDK_TYPE_UNSPECIFIED |
默认值。如果省略 sdk_type ,则使用此值。 |
CONSUMER |
调用 SDK 是 Consumer。 |
DRIVER |
调用 SDK 为 Driver。 |
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 米到 10,000 米之间(含 400 米和 10,000 米)。 |
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 |
按配置的匹配费用升序排列。匹配费用是指直线距离与预计到达时间 (ETA) 之间的加权计算结果。权重会设置为默认值,并且可以根据客户进行修改。如果需要为您的项目修改这些权重,请与 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 |
表示航点的确切 |
place |
表示相应位置的地点资源名称。格式为 这是一项实验性功能。 |
point_location_source |
仅限输出。 |
terminal_point_id |
已弃用:请改用 |
access_point_id |
已弃用:请改用 |
trip_id |
已弃用。 |
terminal_location_type |
已弃用: |
PointSource
表示 LatLng
的来源。
枚举 | |
---|---|
POINT_SOURCE_UNSPECIFIED |
未指定点源。 |
POINT_SOURCE_DEVELOPER_PROVIDED |
LatLng 由开发者明确提供。 |
POINT_SOURCE_CALCULATED_FROM_PLACE |
LatLng 是根据所提供的地点计算得出的。 |
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[] |
仅限输出。此行程中从当前位置到 remaining_waypoints 中的第一个条目的预期路线。请注意,第一个途经点可能属于其他行程。 |
current_route_segment |
仅限输出。下一个途经点的编码路径。 注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。尚不支持解码。 |
current_route_segment_version |
仅限输出。表示路线的上次修改时间。 注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。 |
current_route_segment_traffic |
仅限输出。指明 注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。 |
current_route_segment_traffic_version |
仅限输出。表示上次修改 注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。 |
current_route_segment_end_point |
仅限输出。 |
remaining_distance_meters |
仅限输出。 |
eta_to_first_waypoint |
仅限输出。到达下一个途经点的预计时间( |
remaining_time_to_first_waypoint |
仅限输出。从返回 Trip 数据到 |
remaining_waypoints_version |
仅限输出。表示 |
remaining_waypoints_route_version |
仅限输出。表示 |
number_of_passengers |
不可变。表示本次行程的乘客人数,不包括司机。车辆必须有可用容量才能在 |
last_location |
仅限输出。表示车辆在路线上的最后报告位置。 |
last_location_snappable |
仅限输出。指示车辆的 |
view |
已填充的 Trip 字段子集以及应如何解读这些字段。 |
attributes[] |
自定义行程属性的列表。每个属性都必须具有唯一的键。 |
TripAttribute
将行程属性描述为键值对。“键:值”字符串的长度不得超过 256 个字符。
字段 | |
---|---|
key |
属性的键。键不得包含英文冒号字符 (:)。 |
联合字段 trip_attribute_value 。属性的值,可以是字符串、布尔值或双精度类型。trip_attribute_value 只能是下列其中一项: |
|
string_value |
字符串类型的属性值。 |
bool_value |
布尔值类型的属性值。 |
number_value |
双精度类型的属性值。 |
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 |
从上一个途经点到当前途经点的编码路径。 注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。尚不支持解码。 |
traffic_to_waypoint |
前往此途经点的路径上的路况。请注意,流量信息仅适用于 Google 地图平台出行和配送解决方案客户。 |
distance_meters |
从上一个途径点到当前途径点的路径距离。如果这是第一个途经点,则路径距离是指从车辆当前位置到途经点的距离。 |
eta |
到达此途经点的预计时间。 |
duration |
从上一个途经点到此途经点的旅行时间。如果这是第一个途经点,则行驶时间是从车辆当前位置到该途经点的时间。 |
UpdateTripRequest
UpdateTrip 请求消息。
字段 | |
---|---|
header |
标准 Fleet Engine 请求标头。 |
name |
必需。必须采用 |
trip |
必需。与更新关联的行程。 以下字段由 Fleet Engine 维护。请勿使用 Trip.update 更新这些内容。
更新共享行程的 指定 为避免出现包含多个目的地的行程的竞态条件,您应在将行程状态更新为 |
update_mask |
必需。用于指示要更新的 Trip 中的字段的字段掩码。 |
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 |
车辆上次报告的位置。 |
past_locations[] |
仅限输入。相应车辆过去曾到过但尚未向 Fleet Engine 报告的位置。此功能用于在 |
maximum_capacity |
相应车辆可搭载的骑手总数。此值不考虑司机。此值必须大于或等于 1。 |
attributes[] |
车辆属性列表。一辆车最多可以有 100 个属性,并且每个属性都必须有一个唯一的键。 |
vehicle_type |
必需。相应车辆的类型。可用于过滤 |
license_plate |
车辆的车牌信息。 |
route[] |
已弃用:请改用 |
current_route_segment |
指定驾驶员应用打算前往下一个途经点的路线的多段线。此列表也会在 注意:此字段仅供 Driver SDK 使用。尚不支持解码。 |
current_route_segment_traffic |
仅限输入。Fleet Engine 会使用这些信息来改进行程分享功能。注意:此字段仅供 Driver 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
将车辆属性描述为键值对。“键:值”字符串的长度不得超过 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 |
仅限输入。自首次将相应位置信息发送到服务器以来经过的时间(以秒为单位)。对于首次更新,此值为零。如果时间未知(例如,当应用重启时),此值会重置为零。 |
num_stale_updates |
仅限输入。已弃用:现在使用其他信号来确定位置是否过时。 |
raw_location |
原始车辆位置(未经道路贴合器处理)。 |
raw_location_time |
与原始位置信息相关联的时间戳。 |
raw_location_sensor |
原始位置信息的来源。默认为 |
raw_location_accuracy |
以米为单位的半径,精确度为 |
flp_location |
来自 Android 的一体化位置信息提供程序的位置信息。 |
flp_update_time |
更新 |
flp_latlng_accuracy_meters |
以半径表示的精确度为 |
flp_heading_degrees |
车辆行驶方向(以度为单位),由融合位置信息提供程序确定。0 表示北。有效范围为 [0,360)。 |
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 |
请求的车辆匹配排序顺序。等同于 |
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 |
多目的地行程中途经目的地的航点。 |