跳到內容

行程

欄位 傳送
tripId 你們這張工作的 id。一直用到 endTrip。
startTime 開始記錄的時間,包括前往乘客的車程。傳入 Swift Date 或 Kotlin Instant。YAS 以 UTC 保存。
endTime 行程結束的時間。傳入 Swift Date 或 Kotlin Instant:可以是現在,或事後補上的較早時間。
metadata 必須。呼叫當下的工作內容。欄位名稱按合作夥伴約定,不列在這裡。
sessionId beginTrip 交回。跟這張預約一起保存。

司機開始這單時送出 beginTrip 的 metadata。

startTime 是司機開始這單的時間,記錄包括前往乘客的車程。

endTrip 的 metadata 取代 beginTrip 的 metadata。只保留結束時送出的欄位。再送整份欄位。

在現有的行程畫面呼叫 SDK。啟動時先讀 openTripId,再決定要不要 beginTrip。只是派單時不要呼叫。到達和乘客上車不需要再呼叫。對已開啟的 id 再呼叫 beginTrip,會交回同一個 sessionId,而且不會改 startTime 或已保存的 metadata。

預約事件 SDK
已派單 不呼叫
司機開始這單 beginTrip
已到達、乘客上車 不呼叫。同一行程保持開啟。
落客完成 endTrip。App 當時在背景的話,下次開啟再呼叫。
訂單取消 endTrip,時間用停止追蹤的那一刻,並把當時的預約狀態放在 metadata.state

同一時間只有一張預約開啟。beginTrip 用另一個 id 會被拒絕。先為開啟中的 id 呼叫 endTrip。結束時間可以是過去。

endTrip 的 id 不是 openTripId 時會被拒絕。未結束的行程維持不變。openTripId 是 null 時,endTrip 不會建立行程。endTime 早過 startTime 時,行程會結束,樣本會清走。結束時的上傳仍可能送出這趟行程的 metadata,但沒有樣本。

state 是 blocked 時呼叫 beginTrip 不會被拒絕。行程會開啟,state 仍是 blocked。被拒絕的 beginTrip 交回 ""。不要把它存成 sessionId。state 與 openTripId 維持不變。尚未呼叫 registerAtLaunch、state 是 notReady、tripId 是空的,或 metadata 是空的或不是 JSON,也會被拒絕。

startTime 在未來時,記錄等到那個時間。beginTrip 在 startTime 之後才呼叫,而且手機可以記錄時,記錄由該次呼叫開始。呼叫之前的樣本不會有。Android 開始記錄還需要 App 在前景。新行程在背景到達開始時間時,行程保持開啟;不是 blocked 時,狀態是 incomplete。見 權限。

endTrip 停止記錄,並保留到 endTime 為止的樣本。因為 App 在背景而在 endTime 之後取到的樣本,不會放進紀錄。

App 用 endTrip 結束行程。後端也可以呼叫 POST /v1/vehicles/trips/end 結束同一行程(beta)。POST /v1/trips/end 已棄用。

jobMetadata 是這次呼叫要送的內容。endTrip 要再送整份欄位。

import YasCapture
func driverStartedJob(tripId: String, startTime: Date, jobMetadata: [String: Any]) {
if let openId = YasCapture.shared.openTripId, openId != tripId {
return // Call endTrip for openId first.
}
let sessionId = YasCapture.shared.beginTrip(
tripId: tripId,
startTime: startTime,
metadata: jobMetadata
)
if sessionId.isEmpty { return }
saveSessionId(sessionId, for: tripId)
}
func jobEnded(tripId: String, endTime: Date, jobMetadata: [String: Any]) {
YasCapture.shared.endTrip(
tripId: tripId,
endTime: endTime,
metadata: jobMetadata
)
}

下一步:身份驗證。