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 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

intermediateDestinations[]

object (TerminalLocation)

中期停靠站以行程要求 (除了上車和下車服務) 的順序停靠。共用行程一開始不支援這項功能。

intermediateDestinationsVersion

string (Timestamp format)

表示 intermediateDestinations 上次修改的時間。您的伺服器應在更新 intermediateDestinationIndex 時快取這個值並傳入 UpdateTripRequest,以確保 intermediateDestinations 並未變更。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"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 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"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)

僅供輸出。這趟行程移至其餘 Waypoints 中第一個項目的預期路線。請注意,第一個路線控點可能屬於不同的行程。

currentRouteSegment

string

僅供輸出。下一個路線控點的編碼路徑。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。目前不支援解碼。

currentRouteSegmentVersion

string (Timestamp format)

僅供輸出。表示路線上次修改的時間。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

僅供輸出。表示currentRouteSegment沿途的路況 (如適用)。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。

currentRouteSegmentTrafficVersion

string (Timestamp format)

僅供輸出。表示 currentRouteSegmentTraffic 上次修改的時間。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

currentRouteSegmentEndPoint

object (TripWaypoint)

僅供輸出。currentRouteSegment結束的路線點。

remainingDistanceMeters

integer

僅供輸出。currentRouteSegment 欄位中的剩餘行車距離。如果行程未指派給車輛,或者行程已完成或取消,則無法指定值。

etaToFirstWaypoint

string (Timestamp format)

僅供輸出。預計到達下一個路線控點 (remainingWaypoints 欄位中的第一個項目)。如果行程未指派給車輛,或者行程無效 (完成或已取消),系統就不會指定值。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

remainingTimeToFirstWaypoint

string (Duration format)

僅供輸出。從行程資料傳回到 Trip.eta_to_first_waypoint 中時間的所需時間。如果行程未指派給車輛,或者行程無效 (完成或已取消),系統就不會指定值。

持續時間以秒為單位,最多 9 個小數位數,結尾為「s」,例如:"3.5s"

remainingWaypointsVersion

string (Timestamp format)

僅供輸出。表示 remainingWaypoints 上次變更的時間 (新增、移除或變更路線控點)。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"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 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

numberOfPassengers

integer

無法變更。指出這趟行程的乘客人數 (不含司機)。車輛必須有足夠的容量才能在 vehicles.search 回應中傳回。

lastLocation

object (VehicleLocation)

僅供輸出。指出路線沿途車輛上次回報的位置。

lastLocationSnappable

boolean

僅供輸出。指出車輛的 lastLocation 是否可貼至目前 RouteSegment。如果 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 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

stopTime
(deprecated)

string (Timestamp format)

僅限輸入。已淘汰,使用時間戳記欄位。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"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

更新行程資料。