索引
NavConnectService(介面)AuthToken(訊息)CreateTripRequest(訊息)GetTripRequest(訊息)Location(訊息)Stop(訊息)Trip(訊息)Trip.State(列舉)TripConfig(訊息)TripExecution(訊息)
NavConnectService
NavConnect 用戶端可透過這項服務建立及取得行程。
| CreateTrip |
|---|
|
建立行程。行動應用程式必須先呼叫這個方法,才能開始行程。傳回的行程會設定
|
| GetTrip |
|---|
|
取得行程。
|
AuthToken
驗證權杖。
| 欄位 | |
|---|---|
token |
僅供輸出。應傳遞至行動應用程式的驗證權杖。 |
expire_time |
僅供輸出。驗證權杖的到期時間。 |
CreateTripRequest
NavConnectService.CreateTrip 的要求訊息。
| 欄位 | |
|---|---|
parent |
必填。將建立這趟行程的父項資源。格式:projects/{project_number} |
trip_id |
必填。行程的 ID,會成為行程資源名稱的最終元件。 這個值必須是有效的 RFC-4122 UUID。 |
trip |
必填。要建立的行程。 |
GetTripRequest
NavConnectService.GetTrip 的要求訊息。
| 欄位 | |
|---|---|
name |
必填。要取得的行程資源名稱。格式:projects/{project}/trips/{trip_id} |
位置
行動應用程式回報的位置。
| 欄位 | |
|---|---|
point |
僅供輸出。位置的經緯度。 |
source_time |
僅供輸出。用戶端指出取得位置資訊的時間。 |
server_time |
僅供輸出。伺服器收到這項位置更新通知的時間。 |
停止
行程中的停靠點,必須在此執行某些工作。
| 欄位 | |
|---|---|
point |
必填。停靠站的位置 (經緯度)。 |
行程
行程。
| 欄位 | |
|---|---|
name |
僅供輸出。ID。行程的資源名稱。格式:projects/{project_number}/trips/{trip_id}。 |
config |
不可變動。行程設定。 |
android_app_id |
僅限輸入。不可變動。使用行程的行動應用程式 Android 應用程式 ID。至少須設定 |
ios_app_id |
僅限輸入。不可變動。使用行程的行動應用程式 iOS 軟體包 ID。至少須設定 |
auth_token |
僅供輸出。不透明權杖,可授權開始在 Google 地圖或 Waze 中進行 NavConnect 行程,並授予這些應用程式更新行程的權限。僅由 |
state |
僅供輸出。行程狀態。 |
execution |
僅供輸出。行程執行的最新資料。如果行程處於錯誤狀態,可能無法設定這項功能。 |
create_time |
僅供輸出。行程建立時的伺服器時間。 |
update_time |
僅供輸出。伺服器收到最新行程更新的時間。 |
州
所有可能的行程狀態。
| 列舉 | |
|---|---|
STATE_UNSPECIFIED |
未指定行程狀態。 |
NEW |
行程已建立,但尚未開始。 |
ENROUTE |
轉運員正在前往目的地的途中。 |
ARRIVED |
運送人員已抵達目的地。 |
SUSPENDED |
行程已暫停。 |
FAILED |
行程未順利完成。 |
CLIENT_ERROR |
發生用戶端錯誤,因此行程失敗。 |
TripConfig
行程設定。
| 欄位 | |
|---|---|
enable_high_frequency_updates |
(選用步驟) 是否啟用高頻率行程更新。 注意:啟用這項功能後,系統會將行程記錄在 Enterprise 級別用量中,並依 Enterprise 級別費率計費。 |
enable_pubsub |
(選用步驟) 是否為行程啟用 Pub/Sub 通知。 |
pubsub_field_mask |
(選用步驟) 如果設定此欄位,只有指定子集的行程欄位會納入 pubsub 通知。 如未設定,系統會在 pubsub 通知中加入所有行程欄位 (預設行為)。 系統不支援下列欄位:
注意:如果 |
TripExecution
行程執行相關資料。
| 欄位 | |
|---|---|
origin |
僅供輸出。行程起點,通常是 NavConnect 行程開始時的運輸工具位置。 |
destination |
僅供輸出。行動應用程式回報的行程目的地。 |
location |
僅供輸出。代表運輸工具最後已知位置的位置信號。如果有的話,這會是道路上對應的位置。 |
traveled_duration |
僅供輸出。目前為止的移動時間。 |
remaining_duration |
僅供輸出。Google 預估這趟行程的剩餘時間。 |
traveled_distance_meters |
僅供輸出。從起點移動的距離 (以公尺為單位)。 |
remaining_distance_meters |
僅供輸出。目的地剩餘距離 (以公尺為單位)。 |
stop_added_in_route |
僅供輸出。指出是否在路線上新增停靠點。 |