Package maps.fleetengine.v1

索引

TripService

行程管理服务。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

在 Fleet Engine 中创建行程,并返回新行程。

DeleteTrip

rpc DeleteTrip(DeleteTripRequest) returns (Empty)

删除单个行程。

如果相应行程处于有效状态且已分配给车辆,则返回 FAILED_PRECONDITION。

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

获取有关单次行程的信息。

ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

报告可结算的行程使用情况。

SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

获取特定车辆的所有行程。

UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

更新行程数据。

VehicleService

车辆管理服务。

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

实例化与按需网约车或送货服务提供商关联的新车辆。每个 Vehicle 都必须具有唯一的车辆 ID。

创建 Vehicle 时,必须提供以下 Vehicle 字段:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

创建 Vehicle 时,系统会忽略以下 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

所有其他字段都是可选字段,如果提供,则会使用。

DeleteVehicle

rpc DeleteVehicle(DeleteVehicleRequest) returns (Empty)

从 Fleet Engine 中删除车辆。

如果车辆有正在进行的行程,则返回 FAILED_PRECONDITION。

GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

从 Fleet Engine 返回车辆。

ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

返回与提供方关联且符合请求选项的车辆的分页列表。

SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

返回与请求选项匹配的车辆列表。

UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

将更新后的车辆数据写入 Fleet Engine。

更新 Vehicle 时,由于以下字段由服务器管理,因此无法更新:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

车辆 name 也无法更新。

如果更新 attributes 字段,则车辆的所有属性都会替换为请求中提供的属性。如果您只想更新部分属性,请参阅 UpdateVehicleAttributes 方法。同样,waypoints 字段可以更新,但必须包含车辆当前的所有途经点,而不能包含其他途经点。

UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

部分更新车辆的属性。只有请求中提及的属性会被更新,其他属性不会更改。注意:UpdateVehicle 中的情况有所不同,整个 attributes 字段将被 UpdateVehicleRequest 中的字段替换,请求中未包含的属性将被移除。

BatteryInfo

与设备电池相关的信息。

字段
battery_status

BatteryStatus

电池状态,例如是否已充满电或正在充电等。

power_source

PowerSource

电池电源的状态。

battery_percentage

float

当前电池电量百分比 [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[]

SpeedReadingInterval

从上一个途经点到当前途经点的路径上的交通速度。

encoded_path_to_waypoint

string

司机从上一个途经点到当前途经点所走的路线。此路径包含地标,因此客户端可以沿路径显示流量标记(请参阅 speed_reading_interval)。目前尚不支持解码。

CreateTripRequest

CreateTrip 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

parent

string

必需。必须采用 providers/{provider} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

trip_id

string

必需。唯一行程 ID。但需遵守以下限制:

  • 必须是有效的 Unicode 字符串。
  • 长度上限为 64 个字符。
  • 根据 Unicode 标准化形式 C 进行标准化。
  • 不得包含以下任何 ASCII 字符:“/”“:”“?”“,”或“#”。
trip

Trip

必需。要创建的行程实体。

创建行程时,必须填写以下字段:

  • trip_type
  • pickup_point

如果您提供以下字段,系统会使用这些字段:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

系统会忽略所有其他 Trip 字段。例如,即使您在创建请求中传入 CANCELEDtrip_status,所有行程的初始 trip_status 仍为 NEW

只有 EXCLUSIVE 类型的行程支持 intermediate_destinations

为共享行程设置 vehicle_id 时,您必须提供 Trip.vehicle_waypoints 列表来指定车辆的剩余途经点的顺序,否则途经点顺序将不确定。

指定 Trip.vehicle_waypoints 时,该列表必须包含车辆行程的所有剩余途经点,不得包含额外的途经点。您必须按以下顺序排列这些途经点:对于给定的行程,上车点位于中途目的地之前,而所有中途目的地都位于下车点之前。EXCLUSIVE 行程的途经点不得与任何其他行程的途经点交错。

系统会使用 trip_idwaypoint_typelocation 字段,并忽略 vehicle_waypoints 中的所有其他 TripWaypoint 字段。

CreateVehicleRequest

CreateVehicle 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

parent

string

必需。必须采用 providers/{provider} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

vehicle_id

string

必需。唯一车辆 ID。但需遵守以下限制:

  • 必须是有效的 Unicode 字符串。
  • 长度上限为 64 个字符。
  • 根据 Unicode 标准化形式 C 进行标准化。
  • 不得包含以下任何 ASCII 字符:“/”“:”“?”“,”或“#”。
vehicle

Vehicle

必需。要创建的车辆实体。创建车辆时,必须填写以下字段:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

创建车辆时,系统会忽略以下字段:

  • 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

所有其他字段都是可选字段,如果提供,则会使用。

DeleteTripRequest

DeleteTrip 请求消息。

字段
header

RequestHeader

可选。标准 Fleet Engine 请求标头。

name

string

必需。必须采用 providers/{provider}/trips/{trip} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

DeleteVehicleRequest

DeleteVehicle 请求消息。

字段
header

RequestHeader

可选。标准 Fleet Engine 请求标头。

name

string

必需。必须采用 providers/{provider}/vehicles/{vehicle} 格式。{provider} 必须是发出此调用的服务账号所属的 Google Cloud 项目的项目 ID(例如 sample-cloud-project)。

DeviceSettings

有关移动设备上各种设置的信息。

字段
location_power_save_mode

LocationPowerSaveMode

省电模式开启时,位置信息功能在设备上的运行方式。

is_power_save_mode

bool

设备目前是否处于节能模式。

is_interactive

bool

设备是否处于互动状态。

battery_info

BatteryInfo

有关电池状态的信息。

GetTripRequest

GetTrip 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

name

string

必需。必须采用 providers/{provider}/trips/{trip} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

view

TripView

应返回的 Trip 字段子集及其解释。

current_route_segment_version

Timestamp

表示检索 Trip.routeTrip.current_route_segment 数据的最小时间戳(不含)。如果自相应时间戳以来路线数据未发生变化,则响应中不会设置路线字段。如果未指定最小值,则始终会检索路线数据。

remaining_waypoints_version
(deprecated)

Timestamp

已废弃:始终检索 Trip.remaining_waypoints。使用 remaining_waypoints_route_version 控制何时检索 Trip.remaining_waypoints.traffic_to_waypointTrip.remaining_waypoints.path_to_waypoint 数据。

route_format_type

PolylineFormatType

返回的当前路线格式,LAT_LNG_LIST_TYPE(在 Trip.route 中)或 ENCODED_POLYLINE_TYPE(在 Trip.current_route_segment 中)。默认值为 LAT_LNG_LIST_TYPE

current_route_segment_traffic_version

Timestamp

表示检索 Trip.current_route_segment_traffic 的最小时间戳(不含)。如果自相应时间戳以来流量数据未发生变化,则响应中不会设置 current_route_segment_traffic 字段。如果未指定最小值,则始终会检索流量数据。请注意,流量数据仅适用于按需乘车和送货解决方案客户。

remaining_waypoints_route_version

Timestamp

表示检索 Trip.remaining_waypoints.traffic_to_waypointTrip.remaining_waypoints.path_to_waypoint 数据的最小时间戳(不含)。如果自相应时间戳以来数据未发生变化,则响应中不会设置上述字段。如果未指定 remaining_waypoints_route_version,则始终检索流量和路径。

GetVehicleRequest

GetVehicle 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

name

string

必需。必须采用 providers/{provider}/vehicles/{vehicle} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

current_route_segment_version

Timestamp

表示检索 Vehicle.current_route_segment 的最小时间戳(不含)。如果自相应时间戳以来路线未发生变化,则响应中不会设置 current_route_segment 字段。如果未指定最小值,则始终检索 current_route_segment

waypoints_version

Timestamp

表示检索 Vehicle.waypoints 数据的最小时间戳(不含)。如果自相应时间戳以来,途经点未发生变化,则响应中不会设置 vehicle.waypoints 数据。如果未指定此字段,则始终检索 vehicle.waypoints

LicensePlate

车辆的牌照信息。为避免存储个人身份信息,系统仅将车牌的最少信息存储为实体的一部分。

字段
country_code

string

必需。CLDR 国家/地区代码。例如,US 表示美国,IN 表示印度。

last_character

string

车牌号的最后一位数字,如果车牌号中没有数字值,则为“-1”。

  • “ABC 1234” ->“4”
  • “AB 123 CD” ->“3”
  • “ABCDEF” -> “-1”

ListVehiclesRequest

ListVehicles 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

parent

string

必需。必须采用 providers/{provider} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

page_size

int32

要返回的车辆数量上限。默认值:100。

page_token

string

之前对 ListVehicles 的调用提供的 next_page_token 的值,以便您可以对车辆组进行分页。如果请求的过滤条件与之前对 ListVehicles 的调用的过滤条件不相同,则该值未定义。

minimum_capacity

Int32Value

指定车辆所需的最小容量。返回的所有车辆的 maximum_capacity 都将大于或等于此值。如果设置,则必须大于或等于 0。

trip_types[]

TripType

将响应限制为支持至少一种指定行程类型的车辆。

maximum_staleness

Duration

将响应限制为在指定时长内向 Fleet Engine 发送过位置更新的车辆。仍会传输位置信息的静止车辆不会被视为过时。如果存在,则必须是有效的正时长。

vehicle_type_categories[]

Category

必需。将响应限制为具有指定类型类别的车辆。不允许UNKNOWN

required_attributes[]

string

调用者可以使用 required_attributesrequired_one_of_attributesrequired_one_of_attribute_sets 字段的任意组合来形成复杂的逻辑运算。

required_attributes 是一个列表;required_one_of_attributes 使用的消息允许列表的列表。这两个字段结合使用,可构成以下表达式:

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

将响应限制为具有指定属性的车辆。此字段表示一种合取/AND 操作。最多允许添加 50 个 required_attributes。这与车辆上允许的最大属性数量相符。每个重复的字符串都应采用“键:值”格式。

required_one_of_attributes[]

string

将响应限制为在每个 VehicleAttributeList 中至少具有一个指定属性的车辆。在每个列表中,车辆必须至少匹配一个属性。此字段在每个 VehicleAttributeList 中表示包含性析取/OR 操作,在 VehicleAttributeList 的集合中表示合取/AND 操作。每个重复字符串都应采用“key1:value1|key2:value2|key3:value3”格式。

required_one_of_attribute_sets[]

string

required_one_of_attribute_sets 提供额外的功能。

required_one_of_attributes 类似,required_one_of_attribute_sets 使用的消息允许包含列表的列表,从而支持如下表达式:

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

将响应限制为与 VehicleAttributeList 中的所有属性匹配的车辆。在每个列表中,车辆必须与所有属性匹配。此字段在每个 VehicleAttributeList 中都是一种合取/AND 操作,在 VehicleAttributeList 的集合中是一种包含性析取/OR 操作。每个重复字符串都应采用“key1:value1|key2:value2|key3:value3”格式。

vehicle_state

VehicleState

将响应限制为具有相应车辆状态的车辆。

on_trip_only

bool

仅返回有当前行程的车辆。

filter

string

可选。列出车辆时要应用的过滤查询。如需查看过滤条件语法示例,请参阅 http://aip.dev/160

此字段旨在取代 required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets 字段。如果此处指定了非空值,则以下字段必须为空:required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets

此过滤器的作用类似于包含其他限制条件(例如 vehicle_stateon_trip_only)的 AND 子句。

请注意,系统仅支持针对车辆属性(例如 attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2>)的查询。过滤查询中允许的限制数量上限为 50。

此外,所有属性都存储为字符串,因此唯一支持的属性比较是字符串比较。为了与数字或布尔值进行比较,必须明确引用这些值,以便将其视为字符串(例如 attributes.<key> = "10"attributes.<key> = "true")。

viewport

Viewport

可选。一种过滤器,用于将返回的车辆限制为最后一次已知位置位于视口定义的矩形区域内的车辆。

ListVehiclesResponse

ListVehicles 响应消息。

字段
vehicles[]

Vehicle

符合请求中条件的车辆。返回的车辆数量上限由请求中的 page_size 字段决定。

next_page_token

string

用于检索下一页车辆的令牌。如果没有更多符合请求条件的车辆,则为空。

total_size

int64

必需。所有页面中符合请求条件的车辆总数。

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 操作系统上的位置信息提供程序。

车辆的导航状态。

枚举
UNKNOWN_NAVIGATION_STATUS 未指定的导航状态。
NO_GUIDANCE 司机应用的导航处于 FREE_NAV 模式。
ENROUTE_TO_DESTINATION 精细导航可用,司机应用导航已进入 GUIDED_NAV 模式。
OFF_ROUTE 车辆已偏离建议的路线。
ARRIVED_AT_DESTINATION 车辆位于目的地附近约 50 米范围内。

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

string

必需。必须采用 providers/{provider}/billableTrips/{billable_trip} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

country_code

string

必需。行程所在国家/地区的双字母国家/地区代码。价格是根据国家/地区代码定义的。

platform

BillingPlatformIdentifier

发出请求的平台。

related_ids[]

string

与所报告的行程直接相关的标识符。这些通常是在行程 ID 可用之前完成的预订前操作的 ID(例如会话 ID)。related_ids 的数量上限为 50。

solution_type

SolutionType

报告的行程所使用的 GMP 产品解决方案类型(例如 ON_DEMAND_RIDESHARING_AND_DELIVERIES)。

SolutionType

用于选择已报告行程的不同解决方案类型的选择器。

枚举
SOLUTION_TYPE_UNSPECIFIED 默认值。为了实现向后兼容性,该 API 默认使用 ON_DEMAND_RIDESHARING_AND_DELIVERIES,这是第一个受支持的解决方案类型。
ON_DEMAND_RIDESHARING_AND_DELIVERIES 该解决方案是按需拼车和送货行程。

RequestHeader

RequestHeader 包含所有 Fleet Engine RPC 请求共有的字段。

字段
language_code

string

BCP-47 语言代码,例如 en-US 或 sr-Latn。如需了解详情,请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。如果未指定,则响应可能采用任何语言,但如果存在英文名称,则优先采用英文。字段值示例:en-US

region_code

string

必需。发起请求的地区的 CLDR 地区代码。字段值示例:US

sdk_version

string

调用 SDK 的版本(如适用)。版本格式为“major.minor.patch”,例如:1.1.2

os_version

string

运行调用 SDK 的操作系统的版本。字段值示例:4.4.112.1

device_model

string

运行调用 SDK 的设备的型号。字段值示例:iPhone12,1SM-G920F

sdk_type

SdkType

发送请求的 SDK 的类型。

maps_sdk_version

string

调用 SDK 所依赖的 MapSDK 版本(如果适用)。版本格式为“major.minor.patch”,例如:5.2.1

nav_sdk_version

string

调用 SDK 所依赖的 NavSDK 版本(如果适用)。版本格式为“major.minor.patch”,例如:2.1.0

platform

Platform

调用 SDK 的平台。

manufacturer

string

调用 SDK 的 Android 设备的制造商,仅适用于 Android SDK。字段值示例:Samsung

android_api_level

int32

调用 SDK 的 Android API 级别,仅适用于 Android SDK。字段值示例:23

trace_id

string

可选 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

RequestHeader

标准 Fleet Engine 请求标头。

parent

string

必需。必须采用 providers/{provider} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

vehicle_id

string

与请求中的行程关联的车辆。如果未指定,则返回的行程不包含:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

如果设置为 true,则响应会包含影响司机路线的行程。

page_size

int32

如果未设置,则服务器将决定要返回的结果数。

page_token

string

将此参数设置为之前在 SearchTripsResponse 中返回的值,以便从之前的搜索结果继续。

minimum_staleness

Duration

如果指定,则返回在时间 (current - minimum_staleness) 之后未更新的行程。

SearchTripsResponse

SearchTrips 响应消息。

字段
trips[]

Trip

所请求车辆的行程列表。

next_page_token

string

在 SearchTripsRequest 中传递此令牌,以翻阅列表结果。API 每次调用都会返回一个行程列表,当没有更多结果时,行程列表为空。

SearchVehiclesRequest

SearchVehicles 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

parent

string

必需。必须采用 providers/{provider} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

pickup_point

TerminalLocation

必需。要搜索的附近自提点。

dropoff_point

TerminalLocation

客户的预期下车地点。如果 trip_types 包含 TripType.SHARED,则此字段为必填字段。

pickup_radius_meters

int32

必需。定义接客点周围的车辆搜索半径。系统只会返回搜索半径范围内的车辆。值必须介于 400 米到 10,000 米之间(含 400 米和 10,000 米)。

count

int32

必需。指定要返回的车辆数量上限。该值必须介于 1 到 50 之间(含 1 和 50)。

minimum_capacity

int32

必需。指定行程中考虑的乘客人数。该值必须大于或等于 1。容量值中不包含司机。

trip_types[]

TripType

必需。表示建议的行程类型。必须只包含一种类型。不允许使用 UNKNOWN_TRIP_TYPE。将搜索范围限制为仅包含支持相应行程类型的车辆。

maximum_staleness

Duration

将搜索范围限制为在指定时长内向 Fleet Engine 发送过位置信息更新的车辆。仍会传输位置信息的静止车辆不会被视为过时。如果未设置此字段,服务器会使用 5 分钟作为默认值。

vehicle_types[]

VehicleType

必需。将搜索范围限定为具有指定类型之一的车辆。必须至少指定一种车辆类型。不允许使用类别为 UNKNOWN 的 VehicleTypes。

required_attributes[]

VehicleAttribute

调用者可以使用 required_attributesrequired_one_of_attributesrequired_one_of_attribute_sets 字段的任意组合来形成复杂的逻辑运算。

required_attributes 是一个列表;required_one_of_attributes 使用的消息允许列表的列表。这两个字段结合使用,可构成以下表达式:

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

将搜索范围限制为仅包含指定属性的车辆。此字段表示一种合取/AND 操作。最多允许添加 50 个 required_attributes。这与车辆允许的最大属性数量相符。

required_one_of_attributes[]

VehicleAttributeList

将搜索范围限制为仅包含每个 VehicleAttributeList 中至少一个指定属性的车辆。在每个列表中,车辆必须至少匹配一个属性。此字段在每个 VehicleAttributeList 中是包含性析取/OR 操作,在 VehicleAttributeList 的集合中是合取/AND 操作。

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets 提供额外的功能。

required_one_of_attributes 类似,required_one_of_attribute_sets 使用的消息允许包含列表的列表,从而支持如下表达式:

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

将搜索范围限制为仅包含 VehicleAttributeList 中所有属性的车辆。在每个列表中,车辆必须与所有属性匹配。此字段在每个 VehicleAttributeList 中都是一种合取/AND 操作,在 VehicleAttributeList 的集合中是一种包含性析取/OR 操作。

order_by

VehicleMatchOrder

必需。指定所需的结果排序标准。

include_back_to_back

bool

这表示具有单次有效行程的车辆是否符合此搜索条件。此字段仅在未指定 current_trips_present 时使用。如果未指定 current_trips_present 且此字段为 false,则搜索结果中会排除已分配行程的车辆。如果未指定 current_trips_present 且此字段为 true,则搜索结果可以包含具有一次状态为 ENROUTE_TO_DROPOFF 的有效行程的车辆。指定 current_trips_present 时,此字段不能设置为 true。

默认值为 false

trip_id

string

表示与此 SearchVehicleRequest 关联的行程。

current_trips_present

CurrentTripsPresent

这表示正在进行行程的车辆是否符合此搜索条件。如果 trip_type 包含 SHARED,则必须将此标记设置为 CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外的值。

filter

string

可选。搜索车辆时要应用的过滤查询。如需查看过滤条件语法示例,请参阅 http://aip.dev/160

此字段旨在取代 required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets 字段。如果此处指定了非空值,则以下字段必须为空:required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets

此过滤器的作用类似于包含其他限制条件(例如 minimum_capacityvehicle_types)的 AND 子句。

请注意,系统仅支持针对车辆属性(例如 attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2>)的查询。过滤查询中允许的限制数量上限为 50。

此外,所有属性都存储为字符串,因此唯一支持的属性比较是字符串比较。为了与数字或布尔值进行比较,必须明确引用这些值,以便将其视为字符串(例如 attributes.<key> = "10"attributes.<key> = "true")。

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

VehicleMatch

符合 SearchVehiclesRequest 条件的车辆列表,按 SearchVehiclesRequest.order_by 字段排序。

SpeedReadingInterval

路径上连续路段的交通密度指示器。如果路径包含点 P_0、P_1、...、P_N(从零开始的索引),则 SpeedReadingInterval 会定义一个区间,并使用以下类别描述该区间的流量。

字段
start_polyline_point_index

int32

相应时间段在路径中的起始索引。在 JSON 中,当索引为 0 时,相应字段将显示为未填充。

end_polyline_point_index

int32

相应区间在路径中的结束索引。在 JSON 中,当索引为 0 时,相应字段将显示为未填充。

speed

Speed

相应时间间隔内的流量速度。

速度

基于流量数据的折线速度分类。

枚举
SPEED_UNSPECIFIED 默认值。此值未使用。
NORMAL 正常速度,交通顺畅。
SLOW 检测到减速,车流量中等。
TRAFFIC_JAM 交通拥堵。

StopLocation

停靠(上车/下车)发生的实际位置。

字段
point

LatLng

必需。表示实际位置。

timestamp

Timestamp

指明了停车时间。

stop_time
(deprecated)

Timestamp

仅限输入。已弃用。使用时间戳字段。

TerminalLocation

描述航点的位置。

字段
point

LatLng

表示航点的确切 LatLng。必须将 pointplace 指定为输入。如果同时指定了这两个参数,则 point 将用于路由,而 place 将用于元数据。如果仅指定 place 作为输入,系统将根据 place 计算 point 并将其包含在输出中。

place

string

表示相应位置的地点资源名称。格式为 places/{place_id}。必须将 pointplace 指定为输入。如果同时指定了这两个参数,则 point 将用于路由,而 place 将用于元数据。只有当输入中包含 place 时,输出中才会包含 place,这意味着不会执行从 LatLngplace 的查找。

这是一项实验性功能。

point_location_source

PointSource

仅限输出。point 字段的来源。

terminal_point_id
(deprecated)

TerminalPointId

已弃用:请改用 place 字段。

access_point_id
(deprecated)

string

已弃用:请改用 place 字段。

trip_id
(deprecated)

string

已弃用。

terminal_location_type
(deprecated)

WaypointType

已弃用:Vehicle.waypoint 将包含此数据。

PointSource

表示 LatLng 的来源。

枚举
POINT_SOURCE_UNSPECIFIED 未指定点源。
POINT_SOURCE_DEVELOPER_PROVIDED LatLng 由开发者明确提供。
POINT_SOURCE_CALCULATED_FROM_PLACE LatLng 是根据所提供的地点计算得出的。

TerminalPointId

已弃用:Fleet Engine 不再支持 TerminalPoint。请改用 TerminalLocation.point

字段
value
(deprecated)

string

已弃用。

联合字段 Id。已弃用。Id 只能是下列其中一项:
place_id
(deprecated)

string

已弃用。

generated_id
(deprecated)

string

已弃用。

TrafficPolylineData

预期车辆行驶路线上的路况。

字段
traffic_rendering

VisualTrafficReportPolylineRendering

折线图,显示客户行程中一段路线上所有区域的交通速度。

行程

行程元数据。

字段
name

string

仅限输出。格式为“providers/{provider}/trips/{trip}”

vehicle_id

string

进行此行程的车辆的 ID。

trip_status

TripStatus

行程的当前状态。

trip_type

TripType

行程的类型。

pickup_point

TerminalLocation

客户指定的上车地点。

actual_pickup_point

StopLocation

仅限输入。接载客户时的实际位置。此字段供提供商提供有关实际取货信息的反馈。

actual_pickup_arrival_point

StopLocation

仅限输入。司机到达上车点的实际时间和位置。此字段供提供商提供有关上车点实际到达信息的反馈。

pickup_time

Timestamp

仅限输出。乘客的预计未来上车时间或实际的上车时间。

intermediate_destinations[]

TerminalLocation

行程请求中的中途经停点(除了上车点和下车点)。最初,此功能将不支持合乘行程。

intermediate_destinations_version

Timestamp

表示上次修改 intermediate_destinations 的时间。您的服务器应缓存此值,并在更新 intermediate_destination_index 时将其传递到 UpdateTripRequest 中,以确保 intermediate_destinations 不会发生变化。

intermediate_destination_index

int32

TripStatusENROUTE_TO_INTERMEDIATE_DESTINATION 时,一个介于 [0..N-1] 之间的数字,表示车辆接下来将经过哪个中间目的地。当 TripStatusARRIVED_AT_INTERMEDIATE_DESTINATION 时,表示车辆所处的中间目的地,取值范围为 [0..N-1]。此值由提供方设置。如果没有 intermediate_destinations,则忽略此字段。

actual_intermediate_destination_arrival_points[]

StopLocation

仅限输入。司机到达中途目的地的实际时间和位置。此字段供提供商提供有关中途目的地实际到达信息的反馈。

actual_intermediate_destinations[]

StopLocation

仅限输入。客户从中途目的地出发的实际时间和地点。此字段供提供商提供有关中途目的地实际取货信息的反馈。

dropoff_point

TerminalLocation

客户指定的下车地点。

actual_dropoff_point

StopLocation

仅限输入。客户实际下车的时间和地点。此字段供提供商提供有关实际下车信息的反馈。

dropoff_time

Timestamp

仅限输出。乘客到达最终目的地的预计未来时间,或乘客到达最终目的地的实际时间。

remaining_waypoints[]

TripWaypoint

仅限输出。从当前位置到下车点的完整路径(含)。此路径可能包含其他行程中的途经点。

vehicle_waypoints[]

TripWaypoint

此字段支持手动对行程的途经点进行排序。它包含分配车辆的所有剩余途经点,以及本次行程的上车和下车途经点。如果行程尚未分配给车辆,Fleet Engine 会忽略此字段。出于隐私考虑,此字段仅由服务器在 UpdateTripCreateTrip 调用中填充,而不会在 GetTrip 调用中填充。

route[]

LatLng

仅限输出。此行程中从当前位置到 remaining_waypoints 中的第一个条目的预期路线。请注意,第一个途经点可能属于其他行程。

current_route_segment

string

仅限输出。下一个途经点的编码路径。

注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。尚不支持解码。

current_route_segment_version

Timestamp

仅限输出。表示路线的上次修改时间。

注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。

current_route_segment_traffic

ConsumableTrafficPolyline

仅限输出。指明 current_route_segment 沿途的路况(如有)。

注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。

current_route_segment_traffic_version

Timestamp

仅限输出。表示上次修改 current_route_segment_traffic 的时间。

注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。

current_route_segment_end_point

TripWaypoint

仅限输出。current_route_segment 结束时的途经点。

remaining_distance_meters

Int32Value

仅限输出。current_route_segment 字段中的剩余行驶距离。如果行程未分配给车辆,或者行程已完成或已取消,则该值未指定。

eta_to_first_waypoint

Timestamp

仅限输出。到达下一个途经点的预计时间(remaining_waypoints 字段中的第一个条目)。如果行程未分配给车辆,或者行程处于非活动状态(已完成或已取消),则该值为未指定。

remaining_time_to_first_waypoint

Duration

仅限输出。从返回 Trip 数据到 Trip.eta_to_first_waypoint 中的时间之间的时长。如果行程未分配给车辆,或者行程处于非活动状态(已完成或已取消),则该值为未指定。

remaining_waypoints_version

Timestamp

仅限输出。表示 remaining_waypoints 的上次更改时间(添加、移除或更改了途经点)。

remaining_waypoints_route_version

Timestamp

仅限输出。表示 remaining_waypoints.path_to_waypointremaining_waypoints.traffic_to_waypoint 的上次修改时间。您的客户端应用应缓存此值,并在 GetTripRequest 中传递该值,以确保仅在 remaining_waypoints 的路径和流量更新时才返回这些路径和流量。

number_of_passengers

int32

不可变。表示本次行程的乘客人数,不包括司机。车辆必须有可用容量才能在 SearchVehicles 响应中返回。

last_location

VehicleLocation

仅限输出。表示车辆在路线上的最后报告位置。

last_location_snappable

bool

仅限输出。指示车辆的 last_location 是否可以贴靠到 current_route_segment。如果 last_locationcurrent_route_segment 不存在,则为 False。由 Fleet Engine 计算。系统会忽略来自客户端的任何更新。

view

TripView

已填充的 Trip 字段子集以及应如何解读这些字段。

attributes[]

TripAttribute

自定义行程属性的列表。每个属性都必须具有唯一的键。

TripAttribute

将行程属性描述为键值对。“键:值”字符串的长度不得超过 256 个字符。

字段
key

string

属性的键。键不得包含英文冒号字符 (:)。

联合字段 trip_attribute_value。属性的值,可以是字符串、布尔值或双精度类型。trip_attribute_value 只能是下列其中一项:
string_value

string

字符串类型的属性值。

bool_value

bool

布尔值类型的属性值。

number_value

double

双精度类型的属性值。

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

TerminalLocation

相应途经点的位置。

trip_id

string

与此途经点关联的行程。

waypoint_type

WaypointType

此途经点在此行程中扮演的角色,例如上车点或下车点。

path_to_waypoint[]

LatLng

从上一个途经点到当前途经点的路径。如果这是第一个途经点,则路径是从车辆的当前位置到该途经点。仅在请求时填充此字段。

encoded_path_to_waypoint

string

从上一个途经点到当前途经点的编码路径。

注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。尚不支持解码。

traffic_to_waypoint

ConsumableTrafficPolyline

前往此途经点的路径上的路况。请注意,流量信息仅适用于 Google 地图平台出行和配送解决方案客户。

distance_meters

Int32Value

从上一个途径点到当前途径点的路径距离。如果这是第一个途经点,则路径距离是指从车辆当前位置到途经点的距离。

eta

Timestamp

到达此途经点的预计时间。

duration

Duration

从上一个途经点到此途经点的旅行时间。如果这是第一个途经点,则行驶时间是从车辆当前位置到该途经点的时间。

UpdateTripRequest

UpdateTrip 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

name

string

必需。必须采用 providers/{provider}/trips/{trip} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-consumer-project)。

trip

Trip

必需。与更新关联的行程。

以下字段由 Fleet Engine 维护。请勿使用 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

更新共享行程的 Trip.vehicle_id 时,您必须提供 Trip.vehicle_waypoints 列表来指定剩余途经点的顺序,否则顺序将不确定。

指定 Trip.vehicle_waypoints 时,该列表必须包含车辆行程的所有剩余途经点,不得包含额外的途经点。您必须按以下顺序排列这些途经点:对于给定的行程,上车点位于中途目的地之前,而所有中途目的地都位于下车点之前。EXCLUSIVE 行程的途经点不得与任何其他行程的途经点交错。系统会使用 trip_idwaypoint_typelocation 字段,并忽略 vehicle_waypoints 中的所有其他 TripWaypoint 字段。

为避免出现包含多个目的地的行程的竞态条件,您应在将行程状态更新为 ENROUTE_TO_INTERMEDIATE_DESTINATION 时提供 Trip.intermediate_destinations_version。传递的 Trip.intermediate_destinations_version 必须与 Fleet Engine 的版本一致。如果不满足此条件,请求将失败。

update_mask

FieldMask

必需。用于指示要更新的 Trip 中的字段的字段掩码。update_mask 必须包含至少一个字段。

UpdateVehicleAttributesRequest

UpdateVehicleAttributes 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

name

string

必需。必须采用 providers/{provider}/vehicles/{vehicle} 格式。提供方必须是发出此调用的服务账号所属的 Google Cloud 项目的 ID(例如 sample-cloud-project)。

attributes[]

VehicleAttribute

必需。要更新的车辆属性。未提及的属性不会被更改或移除。

UpdateVehicleAttributesResponse

UpdateVehicleAttributes 响应消息。

字段
attributes[]

VehicleAttribute

必需。更新后的完整车辆属性列表,包括新增、更改和未更改的属性。

UpdateVehicleRequest

`UpdateVehicle 请求消息。

字段
header

RequestHeader

标准 Fleet Engine 请求标头。

name

string

必需。必须采用 providers/{provider}/vehicles/{vehicle} 格式。{provider} 必须是发出此调用的服务账号所属的 Google Cloud 项目的项目 ID(例如 sample-cloud-project)。

vehicle

Vehicle

必需。要应用的 Vehicle 实体值。更新 Vehicle 时,以下字段可能无法更新,因为它们由服务器管理。

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

如果更新 attributes 字段,则车辆的所有属性都会替换为请求中提供的属性。如果您只想更新部分属性,请参阅 UpdateVehicleAttributes 方法。

同样,waypoints 字段可以更新,但必须包含车辆当前的所有途经点,而不能包含其他途经点。

update_mask

FieldMask

必需。一个字段掩码,用于指明要更新 Vehicle 的哪些字段。必须提供至少一个字段名称。

交通工具

车辆元数据。

字段
name

string

仅限输出。相应车辆的唯一名称。格式为 providers/{provider}/vehicles/{vehicle}

vehicle_state

VehicleState

车辆状态。

supported_trip_types[]

TripType

相应车辆支持的行程类型。

current_trips[]

string

仅限输出。当前分配给相应车辆的行程的 trip_id 列表。

last_location

VehicleLocation

车辆上次报告的位置。

past_locations[]

VehicleLocation

仅限输入。相应车辆过去曾到过但尚未向 Fleet Engine 报告的位置。此功能用于在 UpdateVehicleRequest 中记录之前无法发送到服务器的位置。这种情况通常发生在车辆未连接到互联网时。

maximum_capacity

int32

相应车辆可搭载的骑手总数。此值不考虑司机。此值必须大于或等于 1。

attributes[]

VehicleAttribute

车辆属性列表。一辆车最多可以有 100 个属性,并且每个属性都必须有一个唯一的键。

vehicle_type

VehicleType

必需。相应车辆的类型。可用于过滤 SearchVehicles 结果中的车辆。还会影响预计到达时间和路线计算。

license_plate

LicensePlate

车辆的车牌信息。

route[]
(deprecated)

TerminalLocation

已弃用:请改用 Vehicle.waypoints

current_route_segment

string

指定驾驶员应用打算前往下一个途经点的路线的多段线。此列表也会在 Trip.current_route_segment 中针对分配给车辆的所有有效行程返回。

注意:此字段仅供 Driver SDK 使用。尚不支持解码。

current_route_segment_traffic

TrafficPolylineData

仅限输入。Fleet Engine 会使用这些信息来改进行程分享功能。注意:此字段仅供 Driver SDK 使用。

current_route_segment_version

Timestamp

仅限输出。设置 current_route_segment 的时间。它可以由客户端存储,并在未来的 GetVehicle 请求中传递,以防止返回未更改的路线。

current_route_segment_end_point

TripWaypoint

current_route_segment 结束时的途经点。驱动程序可以在 UpdateVehicle 调用中提供此信息,可以是完整的行程航点、航点 LatLng,也可以是 current_route_segment 的最后一个 LatLng。然后,如果航点未完全指定,Fleet Engine 会尽力插值到实际航点。在 UpdateVehicle 调用中,除非还指定了 current_route_segment,否则系统会忽略此字段。

remaining_distance_meters

Int32Value

current_route_segment 的剩余行驶距离。此值也会在 Trip.remaining_distance_meters 中针对分配给车辆的所有有效行程返回。如果 current_route_segment 字段为空,则该值未指定。

eta_to_first_waypoint

Timestamp

waypoints 字段中第一个条目的预计到达时间。如果 waypoints 字段为空或 Vehicle.current_route_segment 字段为空,则该值未指定。

更新车辆时,同一请求中的 remaining_time_seconds 优先于 eta_to_first_waypoint

remaining_time_seconds

Int32Value

仅限输入。current_route_segment 的剩余驾驶时间。如果 waypoints 字段为空或 Vehicle.current_route_segment 字段为空,则该值未指定。如果所有当事方都使用同一时钟,则此值应与 eta_to_first_waypoint - current_time 一致。

更新车辆时,同一请求中的 remaining_time_seconds 优先于 eta_to_first_waypoint

waypoints[]

TripWaypoint

分配给相应车辆的剩余途经点。

waypoints_version

Timestamp

仅限输出。waypoints 字段的上次更新时间。客户端应缓存此值并在 GetVehicleRequest 中传递该值,以确保仅在 waypoints 字段更新时才返回该字段。

back_to_back_enabled

bool

指示司机是否接受连续行程。如果为 true,即使车辆当前已分配给某次行程,SearchVehicles 也可能包含该车辆。默认值为 false

navigation_status

NavigationStatus

车辆的导航状态。

device_settings

DeviceSettings

仅限输入。与驾驶员使用的移动设备中的设置相关的信息。

VehicleType

车辆类型。

字段
category

Category

车辆类型类别

类别

车辆类型类别

枚举
UNKNOWN 默认值,用于未指定或无法识别的车辆类别。
AUTO 汽车。
TAXI 任何用作出租车的车辆(通常需要获得许可或受到监管)。
TRUCK 通常是指存储容量大的车辆。
TWO_WHEELER 摩托车、助力车或其他双轮车辆
BICYCLE 人力驱动的交通工具。
PEDESTRIAN 一种人类运输者,通常步行或跑步,沿着人行道移动。

VehicleAttribute

将车辆属性描述为键值对。“键:值”字符串的长度不得超过 256 个字符。

字段
key

string

属性的键。键不得包含英文冒号字符 (:)。

value

string

属性的值。

联合字段 vehicle_attribute_value。属性的值,可以是字符串、布尔值或双精度类型。vehicle_attribute_value 只能是下列其中一项:
string_value

string

字符串类型的属性值。

注意:此字段与 value 字段完全相同,但后者最终将被弃用。对于创建或更新方法,可以使用任一字段,但强烈建议使用 string_value。如果同时设置了 string_valuevalue,它们必须完全相同,否则系统会抛出错误。这两个字段都会填充在响应中。

bool_value

bool

布尔值类型的属性值。

number_value

double

双精度类型的属性值。

VehicleAttributeList

一种用于存储车辆属性的列表列表数据类型。

字段
attributes[]

VehicleAttribute

相应集合中的属性列表。

VehicleLocation

车辆在某个时间点的位置、速度和行驶方向。

字段
location

LatLng

车辆的位置。当位置信息发送到 Fleet Engine 时,车辆的位置是 GPS 位置。当您在响应中收到此值时,车辆的位置信息可以是 GPS 位置信息、补充位置信息或其他一些估计的位置信息。来源在 location_sensor 中指定。

horizontal_accuracy
(deprecated)

DoubleValue

已弃用:请改用 latlng_accuracy

latlng_accuracy

DoubleValue

以半径表示的精确度为 location 米。

heading

Int32Value

车辆行驶方向(以度为单位)。0 表示北。有效范围为 [0,360)。

bearing_accuracy
(deprecated)

DoubleValue

已弃用:请改用 heading_accuracy

heading_accuracy

DoubleValue

精确度为 heading 度。

altitude

DoubleValue

海拔高度(以米为单位,高于 WGS84)。

vertical_accuracy
(deprecated)

DoubleValue

已弃用:请改用 altitude_accuracy

altitude_accuracy

DoubleValue

altitude 的精度,以米为单位。

speed_kmph
(deprecated)

Int32Value

车辆速度,单位为千米/小时。已弃用:请改用 speed

speed

DoubleValue

车辆速度(以米/秒为单位)

speed_accuracy

DoubleValue

speed 的精确度,以米/秒为单位。

update_time

Timestamp

传感器根据其时钟报告 location 的时间。

server_time

Timestamp

仅限输出。服务器接收到位置信息的时间。

location_sensor

LocationSensor

位置数据提供方(例如 GPS)。

is_road_snapped

BoolValue

location 是否贴合道路。

is_gps_sensor_enabled

BoolValue

仅限输入。指示移动设备上是否已启用 GPS 传感器。

time_since_update

Int32Value

仅限输入。自首次将相应位置信息发送到服务器以来经过的时间(以秒为单位)。对于首次更新,此值为零。如果时间未知(例如,当应用重启时),此值会重置为零。

num_stale_updates
(deprecated)

Int32Value

仅限输入。已弃用:现在使用其他信号来确定位置是否过时。

raw_location

LatLng

原始车辆位置(未经道路贴合器处理)。

raw_location_time

Timestamp

与原始位置信息相关联的时间戳。

raw_location_sensor

LocationSensor

原始位置信息的来源。默认为 GPS

raw_location_accuracy

DoubleValue

以米为单位的半径,精确度为 raw_location

flp_location

LatLng

来自 Android 的一体化位置信息提供程序的位置信息。

flp_update_time

Timestamp

更新 flp_location 的时间戳

flp_latlng_accuracy_meters

DoubleValue

以半径表示的精确度为 flp_location 米。

flp_heading_degrees

Int32Value

车辆行驶方向(以度为单位),由融合位置信息提供程序确定。0 表示北。有效范围为 [0,360)。

supplemental_location

LatLng

集成应用提供的补充位置信息。

supplemental_location_time

Timestamp

与补充位置信息相关联的时间戳。

supplemental_location_sensor

LocationSensor

补充位置信息的来源。默认为 CUSTOMER_SUPPLIED_LOCATION

supplemental_location_accuracy

DoubleValue

以米为单位的半径,精确度为 supplemental_location

road_snapped
(deprecated)

bool

已弃用:请改用 is_road_snapped

VehicleMatch

包含车辆和相关估计值,这些车辆与车辆 SearchVehiclesRequest 的有效行程的点匹配。

字段
vehicle

Vehicle

必需。与请求匹配的车辆。

vehicle_pickup_eta

Timestamp

车辆从当前位置到达请求中指定的上车点的预计行驶时间。空值表示车辆的预计到达时间计算失败。如果 SearchVehiclesRequest.include_back_to_backtrue 且相应车辆有正在进行的行程,则 vehicle_pickup_eta 会包含完成当前正在进行的行程所需的时间。

vehicle_pickup_distance_meters

Int32Value

从车辆当前位置到请求中指定的上车点的距离,包括现有行程的任何中间上车点或下车点。此距离包括计算出的驾车(路线)距离,以及导航终点与请求的上车点之间的直线距离。(导航终点与请求的上车点之间的距离通常很小。)空值表示距离计算有误。

vehicle_pickup_straight_line_distance_meters

Int32Value

必需。车辆与请求中指定的上车点之间的直线距离。

vehicle_dropoff_eta

Timestamp

车辆从当前位置到请求中指定的下车点的完整行驶预计到达时间。预计到达时间包括在请求中指定的 dropoff_point 之前停靠任何航点的时间。只有在请求中指定了下车点时,系统才会填充此值。空值表示在计算预计到达时间时出错。

vehicle_pickup_to_dropoff_distance_meters

Int32Value

车辆从上车点到请求中指定的下车点的行驶距离(以米为单位)。此距离仅指两点之间的距离,不包括车辆位置或在车辆到达上车点或下车点之前必须经过的任何其他点。仅当请求中指定了 dropoff_point 时,系统才会填充此值。空值表示无法计算从上车点到请求中指定的下车点的距离。

trip_type

TripType

必需。用于计算前往上车点的预计到达时间的请求的行程类型。

vehicle_trips_waypoints[]

Waypoint

用于计算预计到达时间的有序途经点列表。该列表包含车辆位置、车辆有效行程的接客点以及请求中提供的接客点。空列表表示车辆的预计到达时间计算失败。

vehicle_match_type

VehicleMatchType

车辆匹配的类型。

requested_ordered_by

VehicleMatchOrder

请求的车辆匹配排序顺序。等同于 ordered_by

ordered_by

VehicleMatchOrder

请求的车辆匹配排序顺序。等同于 requested_ordered_by

VehicleMatchType

车辆匹配类型。

枚举
UNKNOWN 未知车辆匹配类型
EXCLUSIVE 车辆目前未分配任何行程,可以前往上车点。
BACK_TO_BACK 车辆目前已分配给某次行程,但可以在完成当前行程后前往上车点。系统会在计算预计到达时间和距离时考虑现有行程。
CARPOOL 车辆有足够的空间供多人共乘。
CARPOOL_BACK_TO_BACK 车辆将先完成当前正在进行的行程,然后再前往上车点。系统会在计算预计到达时间和距离时考虑现有行程。

VehicleState

Vehicle 的状态。

枚举
UNKNOWN_VEHICLE_STATE 默认值,用于未指定或无法识别的车辆状态。
OFFLINE 车辆不接受新行程。注意:车辆在完成分配给它的行程期间,可能会继续在此状态下运行。
ONLINE 车辆正在接受新的行程。

VisualTrafficReportPolylineRendering

描述了客户端应如何沿路线为折线的某一部分着色。

字段
road_stretch[]

RoadStretch

可选。应沿多段线渲染的道路段。路段保证不会重叠,但不一定覆盖整个路线。

如果没有要设置样式的路段,客户端应应用路线的默认样式。

RoadStretch

应渲染的一段道路。

字段
style

Style

必需。要应用的样式。

offset_meters

int32

必需。样式应应用于 [offset_meters, offset_meters + length_meters) 之间。

length_meters

int32

必需。应用样式的路径的长度。

样式

表示路况(指示交通速度)的样式。

枚举
STYLE_UNSPECIFIED 未选择任何样式。
SLOWER_TRAFFIC 交通正在放缓。
TRAFFIC_JAM 有交通拥堵。

航点

描述 SearchVehiclesResponseVehicleMatch 的路线上的中间点。在所有其他端点中,此概念都表示为 TripWaypoint

字段
lat_lng

LatLng

相应途经点的位置。

eta

Timestamp

车辆预计到达此途经点的时间。

WaypointType

途经点的类型。

枚举
UNKNOWN_WAYPOINT_TYPE 航点类型未知或未指定。
PICKUP_WAYPOINT_TYPE 接载乘客或取件的途经点。
DROP_OFF_WAYPOINT_TYPE 用于接送乘客或物品的途经点。
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE 多目的地行程中途经目的地的航点。