Package maps.fleetengine.v1

索引

TripService

行程管理服务。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

在车队引擎中创建行程，并返回新行程。
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

所有其他字段均为可选字段，系统会在提供时使用这些字段。
GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

从车队引擎返回车辆。
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_status 均以 NEW 开头，即使您在创建请求中传入的 trip_status 为 CANCELED 也是如此。

只有 EXCLUSIVE 行程支持 intermediate_destinations。

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

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

系统会使用 trip_id、waypoint_type 和 location 字段，并忽略 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

必需。要创建的 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

所有其他字段均为可选字段，系统会在提供时使用这些字段。

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

应返回的部分行程字段及其解读。
current_route_segment_version

Timestamp

指示检索 Trip.route 或 Trip.current_route_segment 数据的最小时间戳（不包括该时间戳）。如果路线数据自此时间戳起保持不变，则响应中不会设置路线字段。如果未指定最小值，则始终检索路线数据。
remaining_waypoints_version

Timestamp

表示检索 Trip.remaining_waypoints 的最小时间戳（不包括该时间戳）。如果自此时间戳以来未发生变化，则响应中不会设置 remaining_waypoints。如果未指定此字段，则始终检索 remaining_waypoints。
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_waypoint 和 Trip.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_attributes、required_one_of_attributes 和 required_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 中的包含性析取运算/或运算，也是对 VehicleAttributeList 集合的联接运算/与运算。每个重复字符串应采用“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_attributes、required_one_of_attributes 和 required_one_of_attributes_sets 字段。如果在此处指定了非空值，则以下字段必须为空：required_attributes、required_one_of_attributes 和 required_one_of_attributes_sets。

此过滤条件可与其他约束条件（例如 vehicle_state 或 on_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 未定义 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 或 Wi-Fi 接入点。
ROAD_SNAPPED_LOCATION_PROVIDER 移动设备确定的最可能的道路位置。
CUSTOMER_SUPPLIED_LOCATION 客户提供的来自独立来源的位置信息。通常，此值用于从运行 Driver SDK 的移动设备以外的来源提供的位置。如果其他枚举值之一可用于描述原始来源，请使用该值。标记为 CUSTOMER_SUPPLIED_LOCATION 的位置通常通过车辆的 last_location.supplemental_location_sensor 提供。
FLEET_ENGINE_LOCATION 由车队引擎根据可用的信号计算的位置。仅限输出。如果在请求中收到此值，系统会将其拒绝。
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（例如会话 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.1、12.1。
device_model

string

调用 SDK 所运行设备的型号。字段值示例：iPhone12,1、SM-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，可用于日志记录目的，以便标识请求。

平台

调用 SDK 的平台。

枚举
PLATFORM_UNSPECIFIED 默认值。如果省略平台，则使用此值。
ANDROID 请求来自 Android。
IOS 请求来自 iOS。
WEB 请求来自网络。

SdkType

可能的 SDK 类型。

枚举
SDK_TYPE_UNSPECIFIED 默认值。如果省略 sdk_type，则使用此值。
CONSUMER 调用方 SDK 是使用方。
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 米之间（包括这两个数值）。
count

int32

必需。指定要返回的车辆数量上限。该值必须介于 1 到 50 之间（包括这两个数值）。
minimum_capacity

int32

必需。指定要考虑的乘客人数。此值必须大于或等于 1。载客量值不计入驾驶员。
trip_types[]

TripType

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

Duration

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

VehicleType

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

VehicleAttribute

调用方可以使用 required_attributes、required_one_of_attributes 和 required_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 中的包含性析取/或运算，也是 VehicleAttributeList 集合中的联接/与运算。
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_attributes、required_one_of_attributes 和 required_one_of_attributes_sets 字段。如果在此处指定了非空值，则以下字段必须为空：required_attributes、required_one_of_attributes 和 required_one_of_attributes_sets。

此过滤条件可与其他约束条件（例如 minimum_capacity 或 vehicle_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 按配置的匹配费用升序排序。匹配费用是指根据直线距离和预计到达时间进行加权计算得出的结果。权重是使用默认值设置的，可根据客户进行修改。如果您需要为项目修改这些权重，请与 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

必需。表示行程航点的位置。
terminal_point_id
(deprecated)

TerminalPointId

已废弃：请改为指定 point 字段。
access_point_id
(deprecated)

string

已废弃：请改为指定 point 字段。
trip_id
(deprecated)

string

已弃用。
terminal_location_type
(deprecated)

WaypointType

已废弃：Vehicle.waypoint 将包含此数据。

TerminalPointId

已废弃：车队引擎不再支持 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

当 TripStatus 为 ENROUTE_TO_INTERMEDIATE_DESTINATION 时，表示车辆下一个要经过的中间目的地，介于 [0..N-1] 之间的数字。当 TripStatus 为 ARRIVED_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

此字段支持手动对行程的航点进行排序。它包含分配给指定车辆的所有剩余路点，以及此行程的上车点和下车点路点。如果行程未分配给车辆，车队引擎会忽略此字段。出于隐私保护方面的原因，服务器仅在 UpdateTrip 和 CreateTrip 调用（而非 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.eta_to_first_waypoint 中的时间的间隔。如果行程未分配给车辆，或者行程处于非活动状态（已完成或已取消），则此值为未指定。
remaining_waypoints_version

Timestamp

仅限输出。表示上次更改 remaining_waypoints 的时间（添加、移除或更改了航点）。
remaining_waypoints_route_version

Timestamp

仅限输出。表示上次修改 remaining_waypoints.path_to_waypoint 和 remaining_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_location 或 current_route_segment 不存在，则为 false。该指标由车队引擎计算得出。系统会忽略来自客户端的任何更新。
view

TripView

要填充的部分行程字段及其解读方式。

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

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

以下字段由车队引擎维护。请勿使用 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_id、waypoint_type 和 location 字段，并忽略 vehicle_waypoints 中的所有其他 TripWaypoint 字段。

为避免出现包含多个目的地的行程的争用情况，您应在将行程状态更新为 ENROUTE_TO_INTERMEDIATE_DESTINATION 时提供 Trip.intermediate_destinations_version。传递的 Trip.intermediate_destinations_version 必须与 Fleet Engine 的版本一致。如果不存在，请求将失败。
update_mask

FieldMask

必需。用于指明要更新的行程中哪些字段的字段掩码。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

车辆上次报告的位置。
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 的时间。客户端可以存储此 ID，并在未来的 GetVehicle 请求中传递，以防止返回未更改的路线。
current_route_segment_end_point

TripWaypoint

current_route_segment 结束的航点。驾驶员可以在 UpdateVehicle 调用中提供此信息，可以作为完整的行程航点、航点 LatLng 或 current_route_segment 的最后一个 LatLng 提供。然后，如果未完全指定实际航点，车队引擎会尽力插值到实际航点。在 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_value 和 value，它们必须相同，否则系统会抛出错误。响应中会填充这两个字段。
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

仅限输入。自此位置首次发送到服务器以来经过的时间（以秒为单位）。对于首次更新，此值为 0。如果时间未知（例如，应用重启时），此值会重置为零。
num_stale_updates
(deprecated)

Int32Value

仅限输入。已废弃：现在，系统使用其他信号来确定位置是否已过时。
raw_location

LatLng

原始车辆位置（未经路面照片处理）。
raw_location_time

Timestamp

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

LocationSensor

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

DoubleValue

raw_location 的精确度（以半径为单位），以米为单位。
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_back 为 true 且此车辆有正在进行的行程，则 vehicle_pickup_eta 包含完成当前正在进行的行程所需的时间。
vehicle_pickup_distance_meters

Int32Value

车辆当前位置与请求中指定的上车点之间的距离，包括现有行程的任何中途上车点或下车点。此距离包括计算出的驾车（路线）距离，以及导航终点和请求的上车点之间的直线距离。（导航终点与请求的接人点之间的距离通常很短。）如果出现空值，则表示计算距离时出错。
vehicle_pickup_straight_line_distance_meters

Int32Value

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

Timestamp

车辆到达请求中指定的下车点的完整预计到达时间 (ETA)。预计到达时间包括在请求中指定的 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 有交通堵塞。

关键点

描述 SearchVehiclesResponse 中 VehicleMatch 路线上的中间点。在所有其他端点中，此概念表示为 TripWaypoint。

字段
lat_lng

LatLng

此航点的位置。
eta

Timestamp

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

WaypointType

航点的类型。

枚举
UNKNOWN_WAYPOINT_TYPE 航点类型未知或未指定。
PICKUP_WAYPOINT_TYPE 用于上车或取件/送件的路点。
DROP_OFF_WAYPOINT_TYPE 用于下车或放下物品的路点。
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE 多目的地行程中中途目的地的航点。