Package maps.fleetengine.v1

BatteryStatus

电池状态，是充满还是正在充电等

PowerSource

电池电源的状态。

float

当前电池电量百分比 [0-100]。

SpeedReadingInterval

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

string

驾驶员从上一个航点到当前航点的路径。此路径中包含地标，以便客户端可以显示路径上的交通标记（请参阅 speed_reading_interval）。尚不支持解码。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

string

必需。唯一行程 ID。受以下限制：

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

Trip

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

创建行程时，以下字段是必填字段：

• trip_type
• pickup_point

如果您提供以下字段，系统会使用它们：

• number_of_passengers
• vehicle_id
• dropoff_point
• intermediate_destinations
• vehicle_waypoints

所有其他“行程”字段均会被忽略。例如，即使您在创建请求中传入的 trip_status 为 CANCELED，所有行程的 trip_status 也都以 NEW 开头。

只有 EXCLUSIVE 行程支持 intermediate_destinations。

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

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

系统会使用 trip_id、waypoint_type 和 location 字段，并忽略 vehicle_waypoints 中的所有其他 TripWaypoint 字段。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

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

所有其他字段都是可选字段，如果提供，系统会使用这些字段。

LocationPowerSaveMode

确定在省电模式开启时，位置信息功能在设备上的运作方式。

bool

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

bool

设备是否处于交互状态。

BatteryInfo

电池状态的相关信息。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

TripView

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

Timestamp

指示检索 Trip.route 或 Trip.current_route_segment 数据的最短时间戳（不含此时间戳）。如果路线数据自此时间戳以来未更改，则不会在响应中设置路线字段。如果未指定最小值，则始终会检索路线数据。

Timestamp

表示检索 Trip.remaining_waypoints 的最小时间戳（不包括该时间戳）。如果自此时间戳以来未发生变化，则响应中不会设置 remaining_waypoints。如果未指定此字段，则始终检索 remaining_waypoints。

PolylineFormatType

返回的当前路线格式，即 LAT_LNG_LIST_TYPE（采用 Trip.route 格式）或 ENCODED_POLYLINE_TYPE（采用 Trip.current_route_segment 格式）。默认值为 LAT_LNG_LIST_TYPE。

Timestamp

表示检索 Trip.current_route_segment_traffic 的最小时间戳（不包括该时间戳）。如果自此时间戳起流量数据保持不变，则响应中不会设置 current_route_segment_traffic 字段。如果未指定下限，系统将始终检索流量数据。请注意，此流量仅适用于按需乘车和送货解决方案客户。

Timestamp

指示检索 Trip.remaining_waypoints.traffic_to_waypoint 和 Trip.remaining_waypoints.path_to_waypoint 数据的最短时间戳（不含该时间戳）。如果数据自此时间戳起保持不变，则响应中不会设置上述字段。如果未指定 remaining_waypoints_route_version，则始终检索流量和路径。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

Timestamp

表示检索 Vehicle.current_route_segment 的最短时间戳（不含）。如果路线自此时间戳以来保持不变，则不会在响应中设置 current_route_segment 字段。如果未指定最小值，则始终检索 current_route_segment。

Timestamp

指示检索 Vehicle.waypoints 数据的最小时间戳（不包括该时间戳）。如果自此时间戳起路点保持不变，则响应中不会设置 vehicle.waypoints 数据。如果未指定此字段，则始终检索 vehicle.waypoints。

string

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

string

车牌的最后一位数字，或“-1”，表示车牌中不含数字值。

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

RequestHeader

标准 Fleet Engine 请求标头。

string

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

int32

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

string

上次调用 ListVehicles 提供的 next_page_token 的值，以便您按页浏览车辆组。如果请求的过滤条件与之前调用 ListVehicles 的过滤条件不同，则该值未定义。

Int32Value

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

TripType

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

Duration

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

Category

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

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。这与车辆允许的属性数量上限一致。每个重复字符串都应采用“键值”格式。

string

将响应限制为包含每个 VehicleAttributeList 中至少一个指定属性的车辆。在每个列表中，车辆必须至少与其中一个属性匹配。此字段是每个 VehicleAttributeList 中的包含析取/或运算以及 VehicleAttributeList 集合中的合取/与运算。每个重复的字符串都应采用以下格式："key1:value1|key2:value2|key3:value3"。

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 集合中的包含析取/或运算。每个重复的字符串都应采用以下格式："key1:value1|key2:value2|key3:value3"。

VehicleState

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

bool

仅返回当前行程所涉及的车辆。

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

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

Vehicle

与请求中条件匹配的车辆。返回的车辆数量上限由请求中的 page_size 字段确定。

string

用于检索下一页车辆的令牌。如果不再有符合请求条件的车辆，则为空。

int64

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

string

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

string

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

BillingPlatformIdentifier

发出请求的平台。

string

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

SolutionType

用于报告的行程的 GMP 产品解决方案类型（例如 ON_DEMAND_RIDESHARING_AND_DELIVERIES）。

string

BCP-47 语言代码，例如 en-US 或 sr-Latn。如需了解详情，请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。如果未指定，回答可以采用任何语言，如果存在这种名称，则会优先使用英语。字段值示例：en-US。

string

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

string

调用方 SDK 的版本（如果适用）。版本格式为“major.minor.patch”，例如：1.1.2。

string

运行调用 SDK 的操作系统版本。字段值示例：4.4.1、12.1。

string

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

SdkType

发送请求的 SDK 类型。

string

调用 SDK 所依赖的 MapSDK 版本（如果适用）。版本格式为“major.minor.patch”，例如：5.2.1。

string

调用 SDK 依赖的 NavSDK 版本（如果适用）。版本格式为“major.minor.patch”，例如：2.1.0。

Platform

调用方 SDK 的平台。

string

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

int32

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

string

可选 ID，可出于记录目的而提供，以便标识请求。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

string

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

• current_route_segment
• remaining_waypoints
• remaining_distance_meters
• eta_to_first_waypoint

bool

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

int32

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

string

将此项设为之前在 SearchTripsResponse 中返回的值，以继续从之前的结果中继续操作。

Duration

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

Trip

所请求车辆的行程列表。

string

在 SearchTripsRequest 中传递此令牌以翻页浏览列表结果。该 API 在每次调用时都会返回一个行程列表，如果没有更多结果，则行程列表为空。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

TerminalLocation

必需。要在附近搜索的上车点。

TerminalLocation

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

int32

必需。定义上车点周围的车辆搜索半径。只会返回搜索半径范围内的车辆。值必须介于 400 到 10000 米（含）之间。

int32

必需。指定要返回的最大车辆数。该值必须介于 1 到 50 之间（含 1 和 50）。

int32

必需。指定某个行程要考虑的乘客人数。该值必须大于或等于 1。容量值不考虑驱动程序。

TripType

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

Duration

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

VehicleType

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

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。这与车辆允许的属性数量上限相符。

VehicleAttributeList

将搜索范围限制为在每个 VehicleAttributeList 中至少具有一个指定属性的车辆。在每个列表中，车辆必须至少匹配一个属性。此字段是每个 VehicleAttributeList 中的包含析取/或运算以及 VehicleAttributeList 集合中的合取/AND 运算。

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 运算。

VehicleMatchOrder

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

bool

此属性用于指明是否可以搜索仅包含单次有效行程的车辆。仅当 current_trips_present 未指定时才会用到此字段。如果未指定 current_trips_present 且此字段为 false，则系统会从搜索结果中排除已指定行程的车辆。如果 current_trips_present 未指定且此字段为 true，搜索结果中可能会包含状态为 ENROUTE_TO_DROPOFF 且有一条正在进行的行程的车辆。如果指定了 current_trips_present，则此字段不能设为 true。

默认值为 false。

string

表示与此 SearchVehicleRequest 关联的行程。

CurrentTripsPresent

此列指明包含有效行程的车辆是否符合此搜索条件。如果 trip_type 包含 SHARED，则此值必须设置为 CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外的值。

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"）。

VehicleMatch

与 SearchVehiclesRequest 条件匹配的车辆的列表，按 SearchVehiclesRequest.order_by 字段排序。

int32

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

int32

此时间段在路径中的结束索引。在 JSON 中，当编号为 0 时，该字段将显示为未填充。

Speed

此时间段内的交通速度。

LatLng

必需。表示实际位置。

Timestamp

表示停止发生的时间。

Timestamp

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

LatLng

必需。表示行程航点的位置。

TerminalPointId

已废弃：请改为指定 point 字段。

string

已废弃：请改为指定 point 字段。

string

已弃用。

WaypointType

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

string

已弃用。

string

已弃用。

string

已弃用。

VisualTrafficReportPolylineRendering

一个多段线，用于渲染客户行程中某一段路段上所有区域的交通速度。

string

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

string

进行此行程的车辆的 ID。

TripStatus

行程的当前状态。

TripType

行程的类型。

TerminalLocation

客户指明的取件地点。

StopLocation

仅限输入。自提客户的实际地点。此字段供提供商提供有关实际上门取件信息的反馈。

StopLocation

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

Timestamp

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

TerminalLocation

除了上车点和下车点之外，行程请求的中途停靠点。最初，共享行程将不支持此功能。

Timestamp

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

int32

当 TripStatus 为 ENROUTE_TO_INTERMEDIATE_DESTINATION 时，是一个介于 [0..N-1] 之间的数字，表示车辆接下来将经过哪个中间目的地。当 TripStatus 为 ARRIVED_AT_INTERMEDIATE_DESTINATION 时，是一个介于 [0..N-1] 之间的数字，表示车辆当前所处的中间目的地。提供程序会设置此值。如果没有 intermediate_destinations，则系统会忽略此字段。

StopLocation

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

StopLocation

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

TerminalLocation

客户指明的下车地点。

StopLocation

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

Timestamp

仅限输出。乘客在最终目的地下车的预计未来时间，或实际下车时间。

TripWaypoint

仅限输出。从当前位置到下车点的完整路径（包括这两个点）。此路线可能包含其他行程中的航点。

TripWaypoint

此字段支持手动对行程的航点进行排序。它包含分配给指定车辆的所有剩余路点，以及此行程的上车点和下车点路点。如果行程未分配给车辆，车队引擎会忽略此字段。出于隐私保护方面的原因，服务器仅在 UpdateTrip 和 CreateTrip 调用（而非 GetTrip 调用）时填充此字段。

LatLng

仅限输出。此行程到 remaining_waypoints 的第一个条目的预期路线。请注意，第一个航点可能属于其他行程。

string

仅限输出。指向下一个航路点的编码路径。

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

Timestamp

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

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

ConsumableTrafficPolyline

仅限输出。表示 current_route_segment 沿途的路况信息（如果可用）。

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

Timestamp

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

注意：此字段仅供驱动程序 SDK 和消费者 SDK 使用。

TripWaypoint

仅限输出。current_route_segment 结束的航点。

Int32Value

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

Timestamp

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

Duration

仅限输出。从返回行程数据到 Trip.eta_to_first_waypoint 中的时间的间隔。如果该行程未分配给车辆，或行程处于非活动状态（已完成或取消），则此值未指定。

Timestamp

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

Timestamp

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

int32

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

VehicleLocation

仅限输出。表示沿途车辆最后报告的位置。

bool

仅限输出。指示车辆的 last_location 是否可贴靠 current_route_segment。如果 last_location 或 current_route_segment 不存在，则为 false。该指标由 Fleet Engine 计算得出。系统会忽略来自客户端的任何更新。

TripView

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

TerminalLocation

此航点的位置。

string

与此航点关联的行程。

WaypointType

此航点在此行程中所扮演的角色，例如上车点或下车点。

LatLng

从上一个航点到当前航点的路径。对于列表中的第一个航点，此值未定义。此字段仅在收到请求时填充。

string

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

注意：此字段仅供驱动程序 SDK 和消费者 SDK 使用。尚不支持解码。

ConsumableTrafficPolyline

到此航点的路径上的路况。请注意，路况信息仅适用于 Google 地图平台行程和交付解决方案的客户。

Int32Value

从上一个航点到当前航点的路径距离。对于列表中的第一个航点，此值未定义。

Timestamp

到达此航路点的预计时间。对于列表中的第一个航点，此值未定义。

Duration

从上一个航点到此点的旅行时间。对于列表中的第一个航点，此值未定义。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

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_id、waypoint_type 和 location 字段，并忽略 vehicle_waypoints 中的所有其他 TripWaypoint 字段。

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

FieldMask

必需。用于指明要更新的行程中哪些字段的字段掩码。update_mask必须包含至少一个字段。

RequestHeader

标准 Fleet Engine 请求标头。

string

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

VehicleAttribute

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

VehicleAttribute

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

RequestHeader

标准 Fleet Engine 请求标头。

string

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

Vehicle

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

• available_capacity
• current_route_segment_version
• current_trips
• name
• waypoints_version

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

同样，waypoints 字段可以更新，但必须包含车辆上当前的所有航点，且不得包含其他航点。

FieldMask

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

string

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

VehicleState

车辆状态。

TripType

此车辆支持的行程类型。

string

仅限输出。当前分配给这辆车的行程的“trip_id”列表。

VehicleLocation

车辆上次报告的位置。

int32

此车辆可搭载的乘客总数。此值不考虑驱动程序。此值必须大于或等于 1。

VehicleAttribute

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

VehicleType

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

LicensePlate

车辆的车牌信息。

TerminalLocation

已弃用：请改用 Vehicle.waypoints。

string

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

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

TrafficPolylineData

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

Timestamp

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

TripWaypoint

current_route_segment 结束的航点。此状态可由驾驶员在 UpdateVehicle 调用上提供，可作为完整的行程航点、航点 LatLng 或 current_route_segment 的最后一个 LatLng。然后，Fleet Engine 会尽力将其插入实际路标（如果未完全指定）。除非同时指定了 current_route_segment，否则系统会在 UpdateVehicle 调用中忽略此字段。

Int32Value

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

Timestamp

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

更新车辆时，在同一请求中，remaining_time_seconds 的优先级高于 eta_to_first_waypoint。

Int32Value

仅限输入。current_route_segment 的剩余行驶时间。如果 waypoints 字段为空或 Vehicle.current_route_segment 字段为空，则此值未指定。如果所有各方使用相同的时钟，则此值应与 eta_to_first_waypoint - current_time 匹配。

更新车辆时，在同一请求中，remaining_time_seconds 的优先级高于 eta_to_first_waypoint。

TripWaypoint

分配给此车辆的其余航点。

Timestamp

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

bool

指示驾驶员是否接受往返行程。如果为 true，SearchVehicles 可能会包含该车辆，即使该车辆目前已分配给某个行程也是如此。默认值为 false。

NavigationStatus

车辆的导航状态。

DeviceSettings

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

Category

车辆类型类别

string

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

string

属性的值。

string

字符串类型的属性值。

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

bool

布尔值类型的属性值。

double

双精度型属性值。

VehicleAttribute

此集合中的属性列表。

LatLng

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

DoubleValue

已弃用：请改用 latlng_accuracy。

DoubleValue

半径为 location 米的精确度。

Int32Value

车辆移动的方向（以度为单位）。0 代表北方。有效范围为 [0,360)。

DoubleValue

已弃用：请改用 heading_accuracy。

DoubleValue

精确度为 heading（以度为单位）。

DoubleValue

高于 WGS84 的高度（以米为单位）。

DoubleValue

已弃用：请改用 altitude_accuracy。

DoubleValue

精度：altitude（以米为单位）。

Int32Value

车辆的速度（以公里/小时为单位）。已弃用：请改用 speed。

DoubleValue

车辆的速度（米/秒）

DoubleValue

精确度为 speed（以米/秒为单位）。

Timestamp

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

Timestamp

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

LocationSensor

位置数据的提供器（例如 GPS）。

BoolValue

location 是否与道路吸附。

BoolValue

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

Int32Value

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

Int32Value

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

LatLng

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

Timestamp

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

LocationSensor

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

DoubleValue

raw_location 的精确度（以半径为单位），以米为单位。

LatLng

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

Timestamp

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

LocationSensor

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

DoubleValue

supplemental_location 的精确度（以半径为单位），以米为单位。

bool

已弃用：请改用 is_road_snapped。

Vehicle

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

Timestamp

车辆行驶的预计到达请求中指定的上车点。空值表示计算车辆的预计到达时间失败。如果 SearchVehiclesRequest.include_back_to_back 为 true，且此车辆有进行中的行程，则 vehicle_pickup_eta 会包含完成当前正在进行的行程所需的时间。

Int32Value

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

Int32Value

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

Timestamp

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

Int32Value

车辆从请求中指定的上车点到下车点的行驶距离（以米为单位）。该距离仅在两点之间，不包括车辆位置或车辆到达上车点或下车点之前必须访问的任何其他点。只有在请求中指定了 dropoff_point 时，系统才会填充该值。空值表示未能计算请求中指定的上车点到下车点之间的距离。

TripType

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

Waypoint

用于计算预计到达时间的有序路点列表。该列表包含车辆位置、车辆正在执行的行程的自提点，以及请求中提供的自提点。空列表表示无法计算车辆的预计到达时间。

VehicleMatchType

车辆匹配类型。

VehicleMatchOrder

请求用于对车辆匹配进行排序的顺序。

VehicleMatchOrder

此车辆使用的实际订单。通常，这将与请求中的“order_by”字段匹配；但是，在某些情况下（例如内部服务器错误），系统可能会使用其他方法（例如 PICKUP_POINT_STRAIGHT_DISTANCE）。

RoadStretch

可选。应沿多段线渲染的道路路段。拉伸保证不会重叠，也不一定横跨整个路线。

如果没有道路延伸样式，客户端应为路线应用默认值。

Style

必需。要应用的样式。

int32

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

int32

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

LatLng

此航点的位置。

Timestamp

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