资源:行程
行程元数据。
JSON 表示法 |
---|
{ "name": string, "vehicleId": string, "tripStatus": enum ( |
字段 | |
---|---|
name |
仅限输出。格式为“providers/{provider}/trips/{trip}” |
vehicle |
进行此行程的车辆的 ID。 |
trip |
行程的当前状态。 |
trip |
行程类型。 |
pickup |
客户指明自提地点。 |
actual |
仅限输入。客户上车的实际位置和时间。此字段供提供商提供有关实际自提信息的反馈。 |
actual |
仅限输入。司机到达上车点的实际时间和地点。此字段供提供商提供有关实际到达信息在上车点的反馈。 |
pickup |
仅限输出。乘客上车的预计未来时间,或者乘客上车的实际时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
intermediate |
除了上车点和下车点之外,行程请求的中途停靠点。共享行程最初不支持此功能。 |
intermediate |
表示上次修改 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
intermediate |
当 |
actual |
仅限输入。司机到达中间目的地的实际时间和地点。此字段供提供商提供有关中途目的地的实际到达信息的反馈。 |
actual |
仅限输入。从中途目的地接上客户的实际时间和地点。此字段供提供商提供有关中途目的地的实际自提信息的反馈。 |
dropoff |
客户指明的下车地点。 |
actual |
仅限输入。客户下车的实际时间和地点。此字段供提供商提供有关实际下客信息的反馈。 |
dropoff |
仅限输出。乘客在最终目的地下车的预计未来时间,或实际下车时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
remaining |
仅限输出。从当前位置到下车点的完整路径(含边界值)。此路线可能包含其他行程中的航点。 |
vehicle |
此字段支持手动对行程的航点进行排序。它包含分配给指定车辆的所有剩余路点,以及此行程的上车点和下车点路点。如果行程未分配给车辆,车队引擎会忽略此字段。出于隐私保护方面的原因,服务器仅在 |
route[] |
仅限输出。此行程到 remainingWaypoints 的第一个条目的预期路线。请注意,第一个航路点可能属于其他行程。 |
current |
仅限输出。下一个航点的编码路径。 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。尚不支持解码。 |
current |
仅限输出。表示上次修改路线的时间。 注意:此字段仅供 Driver SDK 和 Consumer SDK 使用。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
current |
仅限输出。表示 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。 |
current |
仅限输出。表示上次修改 注意:此字段仅供驱动程序 SDK 和消费者 SDK 使用。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
current |
仅限输出。 |
remaining |
仅限输出。 |
eta |
仅限输出。下一个航点的预计到达时间( 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
remaining |
仅限输出。从返回行程数据到 该时长以秒为单位,最多包含九个小数位,以“ |
remaining |
仅限输出。表示上次更改 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
remaining |
仅限输出。表示上次修改 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
number |
不可变。表示此行程的乘客人数,不包括司机。车辆必须有可用的载客量,才能在 |
last |
仅限输出。表示车辆在路线上的上次报告位置。 |
last |
仅限输出。指示车辆的 |
view |
将填充的“行程”字段子集以及应如何解读这些字段。 |
TripStatus
指示行程进度的状态。
枚举 | |
---|---|
UNKNOWN_TRIP_STATUS |
默认值,用于未指定或无法识别的行程状态。 |
NEW |
新创建的行程。 |
ENROUTE_TO_PICKUP |
司机正在前往上车点。 |
ARRIVED_AT_PICKUP |
司机已抵达上车点。 |
ARRIVED_AT_INTERMEDIATE_DESTINATION |
司机已到达中途目的地,正在等待乘客。 |
ENROUTE_TO_INTERMEDIATE_DESTINATION |
司机正在前往中途目的地(而非下车点)。 |
ENROUTE_TO_DROPOFF |
司机已接住乘客,正在前往下一个目的地。 |
COMPLETE |
乘客已下车,行程已结束。 |
CANCELED |
在司机、乘客或拼车服务提供商上门接人之前,行程已被取消。 |
StopLocation
实际经停点(上车/下车)的位置。
JSON 表示法 |
---|
{
"point": {
object ( |
字段 | |
---|---|
point |
必需。表示实际位置。 |
timestamp |
表示停止发生的时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
stopTime |
仅限输入。已弃用。使用时间戳字段。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
TripView
trips.get
响应中不同“行程”字段集的选择器。如需了解背景信息,请参阅 AIP-157。我们可能会添加其他视图。
枚举 | |
---|---|
TRIP_VIEW_UNSPECIFIED |
默认值。为了实现向后兼容性,API 将默认采用 SDK 视图。为确保稳定性和支持,建议客户选择 SDK 以外的TripView 。 |
SDK |
包括可能无法使用公开可用的库解读或支持的字段。 |
JOURNEY_SHARING_V1S |
为行程分享用例填充行程字段。此视图适用于服务器到服务器通信。 |
方法 |
|
---|---|
|
在车队引擎中创建行程,并返回新行程。 |
|
获取单个行程的相关信息。 |
|
获取特定车辆的所有行程信息。 |
|
更新行程数据。 |