允許消費者追蹤訂單、行程或其他服務的行程，為隨選行程量身打造消費者體驗。
什麼是 Consumer SDK？
Consumer SDK 是 Fleet Engine 的一部分，適用於隨選行程。這項 SDK 提供介面，可模擬行程資料並在 Fleet Engine 中追蹤行程，還提供類別，方便您建立豐富的地圖式顯示畫面，與消費者使用者分享行程。您可以在應用程式中整合 Consumer SDK，並在 Fleet Engine 中設定適當的角色設定檔，打造這類消費者體驗。
您可以使用 Consumer SDK 平台專屬 API，在應用程式中建構原生分享行程的功能。Consumer SDK 適用於下列平台：
為什麼要使用 Consumer SDK？
將 Consumer SDK 整合至隨選行程應用程式，即可提供完整的消費者體驗，包括近乎即時的位置更新和道路對齊位置。消費者可以在地圖上查看車輛路線，包括進度詳細資料，瞭解行程或外送的所在位置。
Consumer SDK 的用途
您可以運用 Driver SDK 和 Fleet Engine 的資訊，打造專屬的消費者體驗，包括下列功能：
自訂地圖 UI，符合您的品牌需求。
追蹤車輛沿途的即時位置，系統會定期更新車輛位置。
顯示取貨和送達地點的預計到達時間。
顯示剩餘距離。
顯示路線上的即時路況。
Consumer SDK 的運作方式
大致來說，Consumer SDK 依賴下列機制：
- 具備適當的 Fleet Engine 角色，讓經過驗證的應用程式可以追蹤與消費者訂單相關聯的行程。
- 消費者與行程之間的關聯，由後端系統提供。
TripModel和JourneySharingSessionSDK 類別，用於模擬行程資料，並在消費者應用程式中分享行程工作階段。
Consumer SDK 也提供其他介面和類別，方便您建立豐富的應用程式體驗，包括交通資訊、地圖標記、預計抵達時間和路線資料等詳細資訊。
下表顯示消費者應用程式追蹤的行程流程。
| 1 | 消費者應用程式要求行程 | 後端伺服器會收到隨選行程要求，並執行下列動作：
|
| 2 | 駕駛接受行程 | 司機應用程式會取得行程 ID 和行程資訊，司機接受行程。 |
| 3 | 消費者應用程式要求存取權，以便追蹤行程 | 消費者應用程式會從後端取得行程 ID，並要求開始追蹤行程。 |
| 4 | 司機開始行程 | 當駕駛人使用駕駛人應用程式指出行程已開始時，應用程式會透過 Driver SDK 通知後端伺服器。例如，當司機即將離開餐廳或開往取餐地點時。 |
| 5 | Fleet Engine 開始傳送行程資訊 | Fleet Engine 會開始追蹤行程，並與消費者應用程式分享行程進度。 |
| 6 | 消費者應用程式顯示行程資訊 | 消費者應用程式會通知消費者，並開始向他們顯示行程資訊，隨著行程進展更新資訊。 |
| 7 | 行程已取消或完成 | 當駕駛取消或完成行程時，駕駛應用程式會停用位置追蹤功能，後端伺服器則會告知 Fleet Engine 將行程標示為取消或完成。 |
| 8 | 消費者應用程式停止追蹤行程 | 行程顯示為已取消或完成。 |
| 9 | 下趟行程會重複這個程序 | 系統會建立新行程，並重複上述程序。 |
如何使用 Consumer SDK
請選取平台，瞭解如何在消費者應用程式中開始追蹤行程。
Android
| 1 | 在 Android 中設定 Consumer SDK | 如要在應用程式中追蹤隨選行程，請設定 Consumer SDK。詳情請參閱「取得 Android Consumer SDK」。 |
| 2 | 設定視覺介面 | 定義地圖並新增向量地圖支援功能，設定消費者體驗。詳情請參閱「設定地圖」。 |
| 3 | 追蹤行程 | 追蹤行程，將相應車輛的位置資訊分享給消費者。詳情請參閱「追蹤行程」。 |
| 5 | 更新行程進度並處理行程錯誤 | 更新行程詳細資料，例如行車距離和預計抵達時間，並處理行程期間發生的任何錯誤。詳情請參閱「更新行程進度」和「處理行程錯誤」。 |
| 5 | 行程結束後，停止追蹤 | 停止追蹤行程，即可停止與消費者分享車輛位置。詳情請參閱「停止追蹤行程」。 |
iOS
| 1 | 在 iOS 中設定 Consumer SDK | 如要在應用程式中追蹤隨選行程，請設定 Consumer SDK。詳情請參閱「取得 iOS Consumer SDK」。 |
| 2 | 設定視覺介面 | 初始化地圖檢視畫面並處理地圖事件，即可設定消費者體驗。詳情請參閱「設定地圖」。 |
| 3 | 追蹤行程 | 追蹤行程，將相應車輛的位置資訊分享給消費者。詳情請參閱「追蹤行程」。 |
| 5 | 更新行程進度並處理行程錯誤 | 更新行程詳細資料，例如行車距離和預計抵達時間，並處理行程期間發生的任何錯誤。詳情請參閱「更新行程進度」和「處理行程錯誤」。 |
| 5 | 行程結束後，停止追蹤 | 停止追蹤行程，即可停止與消費者分享車輛位置。詳情請參閱「停止追蹤行程」。 |
JavaScript
| 1 | 在 JavaScript 中設定 Consumer SDK | 如要在應用程式中追蹤隨選行程，請設定 Consumer SDK。詳情請參閱「設定 JavaScript Consumer SDK」。 |
| 2 | 載入及自訂地圖 | 啟用 Maps JavaScript API 並設定授權，即可設定消費者體驗。詳情請參閱「設定地圖」。 |
| 3 | 追蹤行程 | 追蹤行程，將相應車輛的位置資訊分享給消費者。詳情請參閱「追蹤行程」。 |
| 5 | 更新行程進度並處理行程錯誤 | 更新行程詳細資料，例如行駛距離和預計抵達時間，並處理行程中的任何錯誤。詳情請參閱更新及追蹤行程進度和處理行程錯誤。 |
| 5 | 行程結束後，停止追蹤 | 停止追蹤行程，即可停止與消費者分享車輛位置。詳情請參閱「停止追蹤行程」。 |
元件
本節將摘要說明追蹤行程的兩個必要元件：
您也可以選擇使用下列元件，自訂消費者體驗：
驗證權杖擷取器
如要控管 Fleet Engine 中儲存的位置資料存取權，請完成下列步驟：
在伺服器上為 Fleet Engine 實作 JSON Web Token (JWT) 建立服務。詳情請參閱「核發 JWT」。
在網頁或行動應用程式中導入驗證權杖擷取器，驗證位置資料的存取權。如要進一步瞭解如何設定權杖擷取器，請參閱 Android、iOS 或 JavaScript 的設定指南。
地圖檢視畫面和行程追蹤器
追蹤行程包括車輛和途中的航點的視覺化元件，以及駕駛人預計抵達時間或剩餘行車距離的原始資料動態饋給。
下表說明這些元件：
| 元件 | 說明 |
|---|---|
| 消費者地圖檢視畫面 | 地圖檢視畫面會管理行程的生命週期，並在行程進行期間顯示車輛位置的途經點。如果車輛的路線已知，地圖檢視畫面會更新車輛路線折線，顯示車輛在路線上的進度。 |
| JavaScript 中的行程位置資訊供應商 | 如果是 JavaScript 網頁應用程式，行程位置資訊供應器會將追蹤物件的位置資訊提供給共用行程地圖。詳情請參閱「例項化行程位置資訊供應器」。您可以使用行程位置資訊供應商追蹤行程的下列詳細資料：
|
追蹤的位置物件
位置資訊供應器會追蹤航點和車輛等物件的位置，如下表所述。
| 追蹤位置 | 說明 |
|---|---|
| 取車地點 | 上車地點是行程的起點。 |
| 目的地位置 | 目的地是行程的終點。標示下車地點。 |
| 路線控點位置 | 航點位置是指追蹤行程路線上的任何中繼位置。從技術上來說，中途點可以包括上車和下車地點，但中途點通常是指路線沿途的中途停靠站。舉例來說，送貨路線上取貨地點和目的地之間的停靠站就是中途點。詳情請參閱 Fleet Engine 說明文件中的「行程途中的停靠點」。 |
| 車輛位置 | 車輛位置是車輛回報的位置，詳情請參閱 Fleet Engine 說明文件中的「車輛位置」。 |
設定地圖樣式
標記和折線樣式會決定地圖上追蹤位置物件的外觀和風格。您可以運用自訂樣式選項，配合網頁應用程式的樣式。
控管追蹤位置的顯示設定
Fleet Engine 中預先定義的位置資訊供應商會遵循這些規則，在地圖上顯示追蹤的位置資訊物件。如果您建立自訂或衍生位置資訊供應器，可以變更顯示規則。
只有在行程進行中才會顯示車輛：從車輛指派給行程到送達目的地為止，系統都會顯示車輛。如果行程取消，系統就不會再顯示車輛。
其他所有地點標記一律會顯示：地圖上會一律顯示起點、目的地和路線控點的其他所有地點標記。舉例來說，無論行程或運送狀態為何，地圖上都會顯示行程下車地點或貨件送達地點。
後續步驟
如要瞭解如何追蹤特定平台的行程，請參閱下列說明文件：