REST Resource: providers.trips

资源:行程

行程元数据。

JSON 表示法
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
字段
name

string

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

vehicleId

string

进行此次行程的车辆的 ID。

tripStatus

enum (TripStatus)

行程的当前状态。

tripType

enum (TripType)

行程的类型。

pickupPoint

object (TerminalLocation)

客户指明其上车地点。

actualPickupPoint

object (StopLocation)

仅限输入。上车客户的实际地点。此字段供提供商就实际自提信息提供反馈。

actualPickupArrivalPoint

object (StopLocation)

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

pickupTime

string (Timestamp format)

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

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

intermediateDestinations[]

object (TerminalLocation)

根据行程请求的中间停靠站(除上车点和下车点之外)。最初,共享行程不支持此功能。

intermediateDestinationsVersion

string (Timestamp format)

表示上次修改 intermediateDestinations 的时间。您的服务器应缓存此值,并在更新 intermediateDestinationIndex 时将其传入 UpdateTripRequest,以确保 intermediateDestinations 不会被更改。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

intermediateDestinationIndex

integer

TripStatusENROUTE_TO_INTERMEDIATE_DESTINATION 时,是一个介于 [0..N-1] 之间的数字,表示车辆下一层将前往的中间目的地。当 TripStatusARRIVED_AT_INTERMEDIATE_DESTINATION 时,是一个介于 [0..N-1] 之间的数字,表示车辆所在的中间目的地。由提供商设置此值。如果没有 intermediateDestinations,系统会忽略此字段。

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

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

actualIntermediateDestinations[]

object (StopLocation)

仅限输入。从中间目的地接客客户的实际时间和地点。此字段供提供商针对中转目的地的实际上车信息提供反馈。

dropoffPoint

object (TerminalLocation)

客户表示将下车的地点。

actualDropoffPoint

object (StopLocation)

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

dropoffTime

string (Timestamp format)

仅供输出。乘客未来预计会在最终目的地下车的时间,或他们实际下车的时间。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

remainingWaypoints[]

object (TripWaypoint)

仅供输出。从当前位置到下车点的完整路径(含边界值)。此路径可能包含来自其他行程的航点。

vehicleWaypoints[]

object (TripWaypoint)

此字段支持手动对行程的航点进行排序。它包含已分配车辆的所有剩余航点,以及此行程的上车点和下车点。如果未将行程分配给车辆,Fleet Engine 会忽略此字段。出于隐私原因,此字段仅在调用 trips.updatetrips.create 时由服务器填充,在 trips.get 调用中不会填充。

route[]

object (LatLng)

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

currentRouteSegment

string

仅供输出。前往下一个航点的编码路径。

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

currentRouteSegmentVersion

string (Timestamp format)

仅供输出。指示上次修改路线的时间。

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

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

仅供输出。指示currentRouteSegment沿线的路况(如有)。

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

currentRouteSegmentTrafficVersion

string (Timestamp format)

仅供输出。表示上次修改 currentRouteSegmentTraffic 的时间。

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

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

currentRouteSegmentEndPoint

object (TripWaypoint)

仅供输出。currentRouteSegment 结束的航点。

remainingDistanceMeters

integer

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

etaToFirstWaypoint

string (Timestamp format)

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

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

remainingTimeToFirstWaypoint

string (Duration format)

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

时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

remainingWaypointsVersion

string (Timestamp format)

仅供输出。表示上次更改 remainingWaypoints(添加、移除或更改航点)的时间。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

remainingWaypointsRouteVersion

string (Timestamp format)

仅供输出。表示上次修改 remainingWaypoints.path_to_waypointremainingWaypoints.traffic_to_waypoint 的时间。您的客户端应用应缓存此值并将其传入 GetTripRequest,以确保仅在更新后返回 remainingWaypoints 的路径和流量。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

numberOfPassengers

integer

不可变。表示此次行程的乘客人数,不包括司机。要在 vehicles.search 响应中返回车辆,必须有可用的容量。

lastLocation

object (VehicleLocation)

仅供输出。指示车辆沿路线最后报告的位置。

lastLocationSnappable

boolean

仅供输出。指示车辆的 lastLocation 是否可贴靠到 currentRouteSegment。如果 lastLocationcurrentRouteSegment 不存在,则为 false。它由 Fleet Engine 计算。来自客户端的任何更新都将被忽略。

view

enum (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 在司机、乘客或拼车服务提供商取车之前,行程被取消。

StopLocation

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

JSON 表示法
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
字段
point

object (LatLng)

必需。表示实际位置。

timestamp

string (Timestamp format)

指示停止发生的时间。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

stopTime
(deprecated)

string (Timestamp format)

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

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

TripView

trips.get 响应中不同“行程”字段集的选择器。如需了解上下文,请参阅 AIP-157。可能会添加其他数据视图。

枚举
TRIP_VIEW_UNSPECIFIED 默认值。为实现向后兼容性,该 API 将默认为 SDK 视图。为确保稳定性和支持服务,建议客户选择除 SDK 以外的 TripView
SDK 包含使用公开库可能无法解释或支持的字段。
JOURNEY_SHARING_V1S 系统会针对“行程分享”用例填充行程字段。此视图适用于服务器到服务器的通信。

方法

create

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

get

获取单个行程的相关信息。
获取特定车辆的所有行程。

update

更新行程数据。