索引
TripService
(介面)VehicleService
(介面)BatteryInfo
(訊息)BatteryStatus
(列舉)BillingPlatformIdentifier
(列舉)ConsumableTrafficPolyline
(訊息)CreateTripRequest
(訊息)CreateVehicleRequest
(訊息)DeviceSettings
(訊息)GetTripRequest
(訊息)GetVehicleRequest
(訊息)LicensePlate
(訊息)ListVehiclesRequest
(訊息)ListVehiclesResponse
(訊息)LocationPowerSaveMode
(列舉)LocationSensor
(列舉)NavigationStatus
(列舉)PolylineFormatType
(列舉)PowerSource
(列舉)ReportBillableTripRequest
(訊息)ReportBillableTripRequest.SolutionType
(列舉)RequestHeader
(訊息)RequestHeader.Platform
(列舉)RequestHeader.SdkType
(列舉)SearchTripsRequest
(訊息)SearchTripsResponse
(訊息)SearchVehiclesRequest
(訊息)SearchVehiclesRequest.CurrentTripsPresent
(列舉)SearchVehiclesRequest.VehicleMatchOrder
(列舉)SearchVehiclesResponse
(訊息)SpeedReadingInterval
(訊息)SpeedReadingInterval.Speed
(列舉)StopLocation
(訊息)TerminalLocation
(訊息)TerminalPointId
(訊息) (已淘汰)TrafficPolylineData
(訊息)Trip
(訊息)TripStatus
(列舉)TripType
(列舉)TripView
(列舉)TripWaypoint
(訊息)UpdateTripRequest
(訊息)UpdateVehicleAttributesRequest
(訊息)UpdateVehicleAttributesResponse
(訊息)UpdateVehicleRequest
(訊息)Vehicle
(訊息)Vehicle.VehicleType
(訊息)Vehicle.VehicleType.Category
(列舉)VehicleAttribute
(訊息)VehicleAttributeList
(訊息)VehicleLocation
(訊息)VehicleMatch
(訊息)VehicleMatch.VehicleMatchType
(列舉)VehicleState
(列舉)VisualTrafficReportPolylineRendering
(訊息)VisualTrafficReportPolylineRendering.RoadStretch
(訊息)VisualTrafficReportPolylineRendering.RoadStretch.Style
(列舉)Waypoint
(訊息)WaypointType
(列舉)
TripService
行程管理服務。
CreateTrip |
---|
在車隊引擎中建立行程,並傳回新行程。 |
GetTrip |
---|
取得單趟行程的資訊。 |
ReportBillableTrip |
---|
回報可結算的旅程使用情形。 |
SearchTrips |
---|
取得特定車輛的所有行程。 |
UpdateTrip |
---|
更新行程資料。 |
VehicleService
車輛管理服務。
CreateVehicle |
---|
將與隨選共乘或外送服務供應商相關的新車輛例項化。每個 建立
建立
所有其他欄位均為選填欄位,如果提供,系統就會使用。 |
GetVehicle |
---|
傳回車隊引擎中的車輛。 |
ListVehicles |
---|
傳回與要求選項相符的供應商相關聯車輛的分頁清單。 |
SearchVehicles |
---|
傳回符合要求選項的車輛清單。 |
UpdateVehicle |
---|
將更新後的車輛資料寫入 Fleet Engine。 更新
車輛 如果更新 |
UpdateVehicleAttributes |
---|
部分更新車輛屬性。系統只會更新要求中提及的屬性,其他屬性不會有任何異動。注意:在 |
BatteryInfo
裝置電池的相關資訊。
欄位 | |
---|---|
battery_ |
電池狀態 (是否已充飽電、是否正在充電等) |
power_ |
電池電源的狀態。 |
battery_ |
目前的電量百分比 [0-100]。 |
BatteryStatus
電池狀態 (充飽電或正在充電等)
列舉 | |
---|---|
UNKNOWN_BATTERY_STATUS |
電池狀態不明。 |
BATTERY_STATUS_CHARGING |
電池正在充電。 |
BATTERY_STATUS_DISCHARGING |
電池正在放電。 |
BATTERY_STATUS_FULL |
電池電量已滿。 |
BATTERY_STATUS_NOT_CHARGING |
電池無法充電。 |
BATTERY_STATUS_POWER_LOW |
電池電量不足。 |
BillingPlatformIdentifier
一組值,指出要求是在哪個平台上發出。
列舉 | |
---|---|
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED |
預設。用於未指定的平台。 |
SERVER |
平台是用戶端伺服器。 |
WEB |
平台是網路瀏覽器。 |
ANDROID |
平台是 Android 行動裝置。 |
IOS |
平台是 iOS 行動裝置。 |
OTHERS |
此列舉中未列出的其他平台。 |
ConsumableTrafficPolyline
車輛行駛路徑上的交通密度。
欄位 | |
---|---|
speed_ |
從上一個路標到目前路標的路徑上,車流量速度。 |
encoded_ |
駕駛人從上一個路標到目前路標的路徑。這個路徑含有地標,因此用戶端可以沿路顯示交通標記 (請參閱 |
CreateTripRequest
CreateTrip 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
trip_ |
必要欄位。不重複的行程 ID。但須遵守下列限制:
|
trip |
必要欄位。要建立的行程實體。 建立行程時,必須填寫下列欄位:
系統會使用您提供的下列欄位:
系統會忽略所有其他行程欄位。舉例來說,即使您在建立要求中傳入 只有 為共乘行程設定 指定 系統會使用 |
CreateVehicleRequest
CreateVehicle
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
vehicle_ |
必要欄位。不重複的車輛 ID。但須遵守下列限制:
|
vehicle |
必要欄位。要建立的 Vehicle 實體。建立車輛時,必須填入下列欄位:
建立車輛時,系統會忽略下列欄位:
所有其他欄位均為選填欄位,如果提供,系統就會使用。 |
DeviceSettings
行動裝置上的各種設定資訊。
欄位 | |
---|---|
location_ |
省電模式開啟時,裝置上的位置功能設定的運作方式。 |
is_ |
裝置目前是否處於省電模式。 |
is_ |
裝置是否處於互動狀態。 |
battery_ |
電池狀態的相關資訊。 |
GetTripRequest
GetTrip 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
view |
應傳回的 Trip 欄位子集及其解讀方式。 |
current_ |
表示擷取 |
remaining_ |
表示擷取 |
route_ |
傳回目前的路線格式: |
current_ |
表示擷取 |
remaining_ |
指出擷取 |
GetVehicleRequest
GetVehicle
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
current_ |
表示擷取 |
waypoints_ |
指出擷取 |
LicensePlate
車輛的車牌資訊。為避免儲存個人識別資訊,實體中只會儲存車牌的必要資訊。
欄位 | |
---|---|
country_ |
必要欄位。CLDR 國家/地區代碼。例如 |
last_ |
車牌的最後一個號碼或「-1」,表示車牌中沒有數字值。
|
ListVehiclesRequest
ListVehicles
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
page_ |
要傳回的車輛數量上限。預設值:100。 |
page_ |
先前對 |
minimum_ |
指定車輛的必要最小容量。所有傳回的車輛都會具有大於或等於這個值的 |
trip_ |
將回應限制為至少支援一種指定行程類型的車輛。 |
maximum_ |
限制回應範圍,只回應在指定時間範圍內向 Fleet Engine 傳送位置更新的車輛。靜止車輛仍會傳送位置,因此不會被視為過時。如果提供,則必須是有效的正持續時間。 |
vehicle_ |
必要欄位。將回應限制在具有其中一個指定類別類型的車輛。不允許 |
required_ |
呼叫端可以使用
將回應限制在具有指定屬性的車輛。這個欄位是連接詞/AND 運算。最多可加入 50 個 required_attributes。這與車輛允許的屬性數量上限相符。每個重複字串的格式應為「鍵:值」。 |
required_ |
將回應限制在每個 |
required_ |
與
將回應限制為與 |
vehicle_ |
限制回應對象為具有此車輛狀態的車輛。 |
on_ |
只傳回目前行程的車輛。 |
filter |
選用設定。列出車輛時要套用的篩選器查詢。如需篩選器語法的範例,請參閱 http://aip.dev/160。 這個欄位旨在取代 這個篩選器可與其他限制條件 (例如 請注意,系統僅支援車輛屬性查詢 (例如 此外,所有屬性都會以字串形式儲存,因此只有字串比較功能可用於比較屬性。如要比較數字或布林值,必須明確加上引號,才能將值視為字串 (例如 |
viewport |
選用設定。篩選器,可限制傳回的車輛,只限於最後已知位置位於可視區域定義的矩形區域內的車輛。 |
ListVehiclesResponse
ListVehicles
回應訊息。
欄位 | |
---|---|
vehicles[] |
符合要求中條件的車輛。傳回的車輛數量上限取決於要求中的 |
next_ |
用來擷取下一頁車輛的符記;如果沒有符合要求條件的車輛,則這個欄位會留空。 |
total_ |
必要欄位。所有頁面中符合要求條件的車輛總數。 |
LocationPowerSaveMode
當行動裝置開啟「省電模式」功能時,如何設定位置功能的行為。(https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())
列舉 | |
---|---|
UNKNOWN_LOCATION_POWER_SAVE_MODE |
Undefined LocationPowerSaveMode |
LOCATION_MODE_NO_CHANGE |
位置資訊供應工具不應受到省電模式影響,或是省電模式已關閉。 |
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF |
省電模式啟用且裝置處於非互動狀態時,應停用以 GPS 為基礎的位置資訊供應器。 |
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF |
省電模式開啟且裝置處於非互動狀態時,應停用所有位置資訊供應器。 |
LOCATION_MODE_FOREGROUND_ONLY |
所有位置資訊供應器都會保留,但位置修正資訊應只提供給前景應用程式。 |
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF |
系統不會關閉定位功能,但 LocationManager 會在裝置處於非互動狀態時,限制對供應商的所有要求。 |
LocationSensor
用於判斷位置的感應器或方法。
列舉 | |
---|---|
UNKNOWN_SENSOR |
感應器未指定或不明。 |
GPS |
GPS 或輔助 GPS。 |
NETWORK |
輔助 GPS、行動通信基地台 ID 或 Wi-Fi 存取點。 |
PASSIVE |
行動通信基地台 ID 或 Wi-Fi 存取點。 |
ROAD_SNAPPED_LOCATION_PROVIDER |
行動裝置判斷最有可能的路面位置。 |
CUSTOMER_SUPPLIED_LOCATION |
客戶提供的獨立來源位置。通常,這個值會用於從執行 Driver SDK 的行動裝置以外的來源提供的位置。如果原始來源是由其他列舉值描述,請使用該值。標示為 CUSTOMER_SUPPLIED_LOCATION 的位置通常是透過車輛的 last_location.supplemental_location_sensor 提供。 |
FLEET_ENGINE_LOCATION |
Fleet Engine 根據可用的訊號計算出的位置。僅供輸出。如果要求中收到這個值,系統會拒絕。 |
FUSED_LOCATION_PROVIDER |
Android 的整合式位置預測提供工具。 |
CORE_LOCATION |
Apple 作業系統上的定位供應器。 |
PolylineFormatType
折線格式的類型。
列舉 | |
---|---|
UNKNOWN_FORMAT_TYPE |
格式未指定或不明。 |
LAT_LNG_LIST_TYPE |
google.type.LatLng 清單。 |
ENCODED_POLYLINE_TYPE |
使用折線壓縮演算法編碼的折線。尚未支援解碼。 |
PowerSource
用來為電池充電的充電器類型。
列舉 | |
---|---|
UNKNOWN_POWER_SOURCE |
電源來源不明。 |
POWER_SOURCE_AC |
電源為 AC 充電器。 |
POWER_SOURCE_USB |
電源是 USB 連接埠。 |
POWER_SOURCE_WIRELESS |
電源為無線。 |
POWER_SOURCE_UNPLUGGED |
電池已拔除。 |
ReportBillableTripRequest
ReportBillableTrip 要求訊息。
欄位 | |
---|---|
name |
必要欄位。格式必須為 |
country_ |
必要欄位。行程所在國家/地區的雙字母國家/地區代碼。價格會根據國家/地區代碼定義。 |
platform |
提出要求的平台。 |
related_ |
與回報行程直接相關的 ID。這些通常是行程 ID 可用之前,預訂前作業的 ID (例如工作階段 ID)。 |
solution_ |
用於報表行程的 GMP 產品解決方案類型 (例如 |
SolutionType
用於選擇報表行程的不同解決方案類型。
列舉 | |
---|---|
SOLUTION_TYPE_UNSPECIFIED |
預設值。為了兼顧回溯相容性,API 預設會使用 ON_DEMAND_RIDESHARING_AND_DELIVERIES ,這是第一個支援的解決方案類型。 |
ON_DEMAND_RIDESHARING_AND_DELIVERIES |
解決方案是隨選共乘和運送行程。 |
RequestHeader
RequestHeader 包含所有 Fleet Engine RPC 要求的共同欄位。
欄位 | |
---|---|
language_ |
BCP-47 語言代碼,例如 en-US 或 sr-Latn。詳情請參閱 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。如果未指定任何名稱,回應可以使用任何語言,如果有名稱,則優先使用英文。欄位值範例: |
region_ |
必要欄位。要求來源區域的 CLDR 區域代碼。欄位值範例: |
sdk_ |
呼叫 SDK 的版本 (如適用)。版本格式為「major.minor.patch」,例如 |
os_ |
呼叫 SDK 所執行的作業系統版本。欄位值範例: |
device_ |
呼叫 SDK 執行的裝置型號。欄位值範例: |
sdk_ |
傳送要求的 SDK 類型。 |
maps_ |
呼叫 SDK 所依附的 MapSDK 版本 (如果適用)。版本格式為「major.minor.patch」,例如 |
nav_ |
呼叫 SDK 所依附的 NavSDK 版本 (如果適用)。版本格式為「major.minor.patch」,例如 |
platform |
呼叫 SDK 的平台。 |
manufacturer |
呼叫 SDK 的 Android 裝置製造商,僅適用於 Android SDK。欄位值範例: |
android_ |
呼叫 SDK 的 Android API 級別,僅適用於 Android SDK。欄位值範例: |
trace_ |
可提供的 ID,可用於記錄用途,用於識別要求。 |
平台
呼叫 SDK 的平台。
列舉 | |
---|---|
PLATFORM_UNSPECIFIED |
預設值。如果省略平台,系統會使用這個值。 |
ANDROID |
這項要求來自 Android。 |
IOS |
要求來自 iOS。 |
WEB |
要求來自網路。 |
SdkType
可能的 SDK 類型。
列舉 | |
---|---|
SDK_TYPE_UNSPECIFIED |
預設值。如果省略 sdk_type ,系統會使用這個值。 |
CONSUMER |
呼叫的 SDK 為 Consumer。 |
DRIVER |
呼叫的 SDK 為 Driver。 |
JAVASCRIPT |
呼叫 SDK 為 JavaScript。 |
SearchTripsRequest
SearchTrips 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
vehicle_ |
與請求中行程相關聯的車輛。如未指定,傳回的行程將不含下列項目:
|
active_ |
如果設為 true,回應就會包含影響駕駛人路線的行程。 |
page_ |
如果未設定,伺服器會決定要傳回的結果數量。 |
page_ |
將這個值設為先前在 |
minimum_ |
如果指定,則會傳回在 |
SearchTripsResponse
SearchTrips 回應訊息。
欄位 | |
---|---|
trips[] |
所要求車輛的行程清單。 |
next_ |
在 SearchTripsRequest 中傳遞這個符記,即可逐頁瀏覽清單結果。API 會在每次呼叫時傳回行程清單,如果沒有其他結果,行程清單會是空白。 |
SearchVehiclesRequest
SearchVehicles
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
pickup_ |
必要欄位。要搜尋附近的取貨地點。 |
dropoff_ |
客戶的下車地點。如果 |
pickup_ |
必要欄位。定義上車地點周圍的車輛搜尋半徑。系統只會傳回搜尋半徑範圍內的車輛。值必須介於 400 至 10000 公尺之間 (含)。 |
count |
必要欄位。指定要傳回的車輛數量上限。值必須介於 1 至 50 (含) 之間。 |
minimum_ |
必要欄位。指定行程所考量的乘客人數。值必須大於或等於 1。容量值不會考量驅動程式。 |
trip_ |
必要欄位。代表建議行程的類型。必須包含一個類型。不允許 |
maximum_ |
將搜尋範圍限制在指定時間範圍內,只搜尋已向 Fleet Engine 傳送位置更新的車輛。靜止車輛仍會傳送位置,因此不會被視為過時。如果未設定此欄位,伺服器會使用五分鐘做為預設值。 |
vehicle_ |
必要欄位。將搜尋範圍限制在某個指定類型的車輛。您必須指定至少一種車輛類型。不允許類別為 |
required_ |
呼叫端可以使用
只搜尋具有指定屬性的車輛。這個欄位是連接詞/AND 運算。最多可加入 50 個 required_attributes。這與車輛允許的屬性數量上限相符。 |
required_ |
將搜尋範圍限制為每個 |
required_ |
與
將搜尋範圍限制為 |
order_ |
必要欄位。指定結果的排序條件。 |
include_ |
這項屬性可指出是否有單一行程的車輛符合此搜尋條件。只有在未指定 預設值為 |
trip_ |
指出與此 |
current_ |
這項屬性可指出是否有符合搜尋條件的有效行程。如果 |
filter |
選用設定。搜尋車輛時要套用的篩選器查詢。如需篩選器語法的範例,請參閱 http://aip.dev/160。 這個欄位旨在取代 這個篩選器可與其他限制條件 (例如 請注意,系統僅支援車輛屬性查詢 (例如 此外,所有屬性都會以字串形式儲存,因此只有字串比較功能可用於比較屬性。如要比較數字或布林值,必須明確加上引號,才能將值視為字串 (例如 |
CurrentTripsPresent
指定車輛目前行程的限制類型。
列舉 | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
include_back_to_back 欄位會控管有行程的車輛供應情形。 |
NONE |
沒有行程的車輛可能會出現在搜尋結果中。使用這個值時,include_back_to_back 不能是 true 。 |
ANY |
搜尋結果中最多會列出 5 輛目前行駛中的車輛和 10 個路線控點。使用這個值時,include_back_to_back 不能是 true 。 |
VehicleMatchOrder
指定回應中車輛比對結果的順序。
列舉 | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
預設值,用於未指定或無法辨識的車輛比對順序。 |
PICKUP_POINT_ETA |
依車輛到上車地點的開車時間,以遞增方式排序。 |
PICKUP_POINT_DISTANCE |
依車輛到上車地點的駕駛距離排序 (由低至高)。 |
DROPOFF_POINT_ETA |
依車輛前往下車地點的開車時間排序,由低至高。只有在要求中指定下車地點時,才能使用這個順序。 |
PICKUP_POINT_STRAIGHT_DISTANCE |
依車輛上次回報的位置到接送地點的直線距離,由小至大排序。 |
COST |
依設定的比對費用遞增排序。系統會將直線距離和預估到達時間之間的加權計算結果定義為相符成本。權重會以預設值設定,且可依客戶需求進行修改。如果需要為專案修改這些權重,請與 Google 支援團隊聯絡。 |
SearchVehiclesResponse
SearchVehicles
回應訊息。
欄位 | |
---|---|
matches[] |
符合 |
SpeedReadingInterval
路徑相鄰路段的交通密度指標。假設路徑包含 P_0、P_1、...、P_N 等點 (以 0 為基底的索引),SpeedReadingInterval 會定義間隔,並使用下列類別描述其流量。
欄位 | |
---|---|
start_ |
路徑中這個間隔的起始索引。在 JSON 中,如果索引為 0,欄位就會顯示為未填入資料。 |
end_ |
路徑中這個間隔的結束索引。在 JSON 中,如果索引為 0,欄位就會顯示為未填入資料。 |
speed |
這個間隔內的車流速度。 |
速度
根據交通資料分類多邊形速度。
列舉 | |
---|---|
SPEED_UNSPECIFIED |
預設值。此值未使用。 |
NORMAL |
正常速度,未偵測到速度變慢。 |
SLOW |
偵測到車流量減緩,但未形成交通壅塞。 |
TRAFFIC_JAM |
系統偵測到交通壅塞。 |
StopLocation
實際停靠 (上車/下車) 地點。
欄位 | |
---|---|
point |
必要欄位。表示實際位置。 |
timestamp |
指出停止時間。 |
stop_time |
僅限輸入。已淘汰,使用時間戳記欄位。 |
TerminalLocation
說明路線控點的位置。
欄位 | |
---|---|
point |
必要欄位。用於表示行程路線點的位置。 |
terminal_point_id |
已淘汰:請改為指定 |
access_point_id |
已淘汰:請改為指定 |
trip_id |
已淘汰。 |
terminal_location_type |
已淘汰: |
TerminalPointId
已淘汰:Fleet Engine 不再支援 TerminalPoints。請改用 TerminalLocation.point
。
欄位 | |
---|---|
value |
已淘汰。 |
聯集欄位 Id 。已淘汰,Id 只能是下列其中一項: |
|
place_id |
已淘汰。 |
generated_id |
已淘汰。 |
TrafficPolylineData
車輛預期路線的路況。
欄位 | |
---|---|
traffic_ |
多邊形線條圖,顯示客戶行程沿途所有區域的交通速度。 |
行程
行程中繼資料。
欄位 | |
---|---|
name |
僅供輸出。格式為「providers/{provider}/trips/{trip}」 |
vehicle_ |
進行這趟行程的車輛 ID。 |
trip_ |
行程目前的狀態。 |
trip_ |
行程類型。 |
pickup_ |
消費者指定的取貨地點。 |
actual_ |
僅限輸入。客戶上車時的實際位置。這個欄位可讓供應商針對實際的接送資訊提供意見回饋。 |
actual_ |
僅限輸入。司機抵達上車地點的實際時間和地點。這個欄位可讓供應商提供實際抵達上車地點的資訊。 |
pickup_ |
僅供輸出。乘客預計上車的時間,或實際上車的時間。 |
intermediate_ |
行程要求的中途停靠站 (除了上車和下車地點)。這項功能一開始不會支援共乘行程。 |
intermediate_ |
表示上次修改 |
intermediate_ |
當 |
actual_ |
僅限輸入。司機抵達中途目的地的實際時間和地點。這個欄位可讓供應商針對中途目的地的實際到達資訊提供意見回饋。 |
actual_ |
僅限輸入。客戶從中途目的地搭車的實際時間和地點。這個欄位可讓供應商針對中途目的地的實際上車資訊提供意見回饋。 |
dropoff_ |
客戶表示要下車的地點。 |
actual_ |
僅限輸入。乘客下車的實際時間和地點。這個欄位可讓供應商提供實際下車資訊的意見回饋。 |
dropoff_ |
僅供輸出。乘客抵達最終目的地的預估時間,或實際下車時間。 |
remaining_ |
僅供輸出。從目前位置到下車點的完整路徑,包括兩者。這個路徑可能包含其他行程的路線控點。 |
vehicle_ |
這個欄位可讓你手動排序行程的路線控點。這項資料包含指派車輛的所有剩餘路線點,以及這趟行程的上下車路線點。如果行程尚未指派給車輛,Fleet Engine 會忽略這個欄位。基於隱私權考量,只有在 |
route[] |
僅供輸出。這趟行程預期的路線,從起點到 remaining_waypoints 中的首個項目。請注意,第一個路線點可能屬於不同的行程。 |
current_ |
僅供輸出。下一個路標的經過編碼的路徑。 注意:此欄位僅供 Driver SDK 和 Consumer SDK 使用。尚未支援解碼。 |
current_ |
僅供輸出。表示路線上次修改的時間。 注意:此欄位僅供 Driver SDK 和 Consumer SDK 使用。 |
current_ |
僅供輸出。指出 注意:此欄位僅供 Driver SDK 和 Consumer SDK 使用。 |
current_ |
僅供輸出。表示上次修改 注意:此欄位僅供 Driver SDK 和 Consumer SDK 使用。 |
current_ |
僅供輸出。 |
remaining_ |
僅供輸出。 |
eta_ |
僅供輸出。到達下一個路標的預估時間 ( |
remaining_ |
僅供輸出。從傳回行程資料到 |
remaining_ |
僅供輸出。指出上次變更 |
remaining_ |
僅供輸出。表示上次修改 |
number_ |
不可變動。表示這趟行程的乘客人數,不含駕駛人。車輛必須有可用容量,才能在 |
last_ |
僅供輸出。指出車輛在路線上最後回報的位置。 |
last_ |
僅供輸出。指出車輛的 |
view |
要填入的 Trip 欄位子集,以及如何解讀這些欄位。 |
TripStatus
行程狀態,表示行程進度。
列舉 | |
---|---|
UNKNOWN_TRIP_STATUS |
預設值,用於未指定或未識別的行程狀態。 |
NEW |
新建立的行程。 |
ENROUTE_TO_PICKUP |
駕駛員正在前往上車地點的路上。 |
ARRIVED_AT_PICKUP |
司機已抵達上車地點。 |
ARRIVED_AT_INTERMEDIATE_DESTINATION |
駕駛人已抵達中途目的地,正在等候乘客。 |
ENROUTE_TO_INTERMEDIATE_DESTINATION |
駕駛員正在前往中途目的地 (而非下車地點)。 |
ENROUTE_TO_DROPOFF |
司機已載客,並前往下一個目的地。 |
COMPLETE |
乘客已下車,行程已完成。 |
CANCELED |
司機、乘客或共乘服務供應商在接送前取消行程。 |
TripType
行程類型。
列舉 | |
---|---|
UNKNOWN_TRIP_TYPE |
預設值,用於未指定或無法辨識的行程類型。 |
SHARED |
行程可能與其他行程共用車輛。 |
EXCLUSIVE |
行程只限於一輛車輛。 |
TripView
GetTrip
回應中不同組別的 Trip 欄位選擇器。請參閱 AIP-157 瞭解相關背景。可能會新增其他檢視畫面。
列舉 | |
---|---|
TRIP_VIEW_UNSPECIFIED |
預設值。為了兼顧回溯相容性,API 預設會顯示 SDK 檢視畫面。為確保穩定性和支援服務,建議客戶選取 TripView 而非 SDK 。 |
SDK |
包括使用公開可用的程式庫時,可能無法解讀或支援的欄位。 |
JOURNEY_SHARING_V1S |
行程欄位會根據旅程分享用途填入資料。這個檢視畫面適用於伺服器對伺服器通訊。 |
TripWaypoint
說明車輛路線上的停靠點,或車輛行程的終點。
欄位 | |
---|---|
location |
此航點的位置。 |
trip_ |
與此路標相關聯的行程。 |
waypoint_ |
這個路線點在行程中扮演的角色,例如上車或下車地點。 |
path_ |
從上一個路標到目前路標的路徑。清單中的第一個路線點為未定義。只有在使用者提出要求時,系統才會填入這個欄位。 |
encoded_ |
從上一個路標到目前路標的經過編碼的路徑。 注意:此欄位僅供 Driver SDK 和 Consumer SDK 使用。尚未支援解碼。 |
traffic_ |
前往此路線的路況。請注意,只有 Google 地圖平台的叫車和外送解決方案客戶才能使用交通資訊。 |
distance_ |
從上一個路徑點到目前路徑點的路徑距離。清單中的第一個路線點為未定義。 |
eta |
這個航路點的預計到達時間。清單中的第一個路線點為未定義。 |
duration |
從上一個路標到這個點的車程時間。清單中的第一個路線點為未定義。 |
UpdateTripRequest
UpdateTrip 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
trip |
必要欄位。與更新相關的行程。 下列欄位由車隊引擎維護。請勿使用 Trip.update 更新這些項目。
更新共乘行程的 指定 為避免行程包含多個目的地時發生競爭條件,請在將行程狀態更新為 |
update_ |
必要欄位。欄位遮罩會指出要更新的行程中的哪些欄位。 |
UpdateVehicleAttributesRequest
UpdateVehicleAttributes
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
attributes[] |
必要欄位。要更新的車輛屬性。未提及的屬性不會變更或移除。 |
UpdateVehicleAttributesResponse
UpdateVehicleAttributes
回應訊息。
欄位 | |
---|---|
attributes[] |
必要欄位。更新後的完整車輛屬性清單,包括新增、修改和未修改的屬性。 |
UpdateVehicleRequest
`UpdateVehicle 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
vehicle |
必要欄位。要套用的
如果更新 同樣地, |
update_ |
必要欄位。欄位遮罩,指出要更新 |
車輛
車輛中繼資料。
欄位 | |
---|---|
name |
僅供輸出。這輛車的專屬名稱。格式為 |
vehicle_ |
車輛狀態。 |
supported_ |
此車輛支援的行程類型。 |
current_ |
僅供輸出。目前指派給這輛車輛的行程的 |
last_ |
車輛上次回報的位置。 |
maximum_ |
這輛車輛可載運的乘客總數。這個值不考慮驅動程式。這個值必須大於或等於 1。 |
attributes[] |
車輛屬性清單。車輛最多可有 100 個屬性,且每個屬性都必須有專屬索引鍵。 |
vehicle_ |
必要欄位。這個車輛的類型。可用於篩選 |
license_ |
車輛的車牌資訊。 |
route[] |
已淘汰:請改用 |
current_ |
折線會指定駕駛員應用程式要前往下一個路標的路線。系統也會在 注意:這個欄位僅供 Driver SDK 使用。尚未支援解碼。 |
current_ |
僅限輸入。Fleet Engine 會利用這些資訊改善行程分享功能。注意:這個欄位僅供 Driver SDK 使用。 |
current_ |
僅供輸出。 |
current_ |
|
remaining_ |
|
eta_ |
更新車輛時, |
remaining_ |
僅限輸入。 更新車輛時, |
waypoints[] |
指派給這輛車的其餘路線點。 |
waypoints_ |
僅供輸出。上次更新 |
back_ |
指出駕駛人是否接受接連行程。如果是 |
navigation_ |
車輛的導航狀態。 |
device_ |
僅限輸入。駕駛人使用的行動裝置設定資訊。 |
VehicleType
車輛類型。
欄位 | |
---|---|
category |
車輛類型 |
類別
車輛類型類別
列舉 | |
---|---|
UNKNOWN |
預設值,用於未指定或未識別的車輛類別。 |
AUTO |
汽車。 |
TAXI |
任何計程車 (通常須持有執照或受監管)。 |
TRUCK |
一般來說,車輛的儲存空間容量越大越好。 |
TWO_WHEELER |
摩托車、輕型機踏車或其他兩輪車輛 |
BICYCLE |
人力運輸。 |
PEDESTRIAN |
人類運輸工具,通常是步行或跑步,沿著行人道移動。 |
VehicleAttribute
以鍵/值組合描述車輛屬性。「key:value」字串長度不得超過 256 個半形字元。
欄位 | |
---|---|
key |
屬性鍵。金鑰不得包含冒號字元 (:)。 |
value |
屬性的值。 |
聯集欄位 vehicle_attribute_value 。屬性的值可以是字串、布林值或雙精度值。vehicle_attribute_value 只能是下列其中一項: |
|
string_ |
字串型屬性值。 注意:這與最終會淘汰的 |
bool_ |
布林型屬性值。 |
number_ |
雙精度浮點型屬性值。 |
VehicleAttributeList
車輛屬性的清單清單資料類型。
欄位 | |
---|---|
attributes[] |
這個集合中的屬性清單。 |
VehicleLocation
車輛在某個時間點的位置、速度和方向。
欄位 | |
---|---|
location |
車輛的位置。傳送至 Fleet Engine 時,車輛位置會是 GPS 位置。收到回應時,車輛位置可能會是 GPS 位置、輔助位置或其他預估位置。來源在 |
horizontal_accuracy |
已淘汰:請改用 |
latlng_ |
|
heading |
以度數表示車輛行駛方向。0 代表北方。有效範圍為 [0,360)。 |
bearing_accuracy |
已淘汰:請改用 |
heading_ |
|
altitude |
高於 WGS84 的高度 (公尺)。 |
vertical_accuracy |
已淘汰:請改用 |
altitude_ |
|
speed_kmph |
車輛的速度,以每小時公里為單位。已淘汰:請改用 |
speed |
車輛速度,以公尺/秒為單位 |
speed_ |
|
update_ |
感應器根據自身時鐘回報 |
server_ |
僅供輸出。伺服器收到位置資訊的時間。 |
location_ |
位置資料供應商 (例如 |
is_ |
|
is_ |
僅限輸入。指出行動裝置是否已啟用 GPS 感應器。 |
time_ |
僅限輸入。這個位置首次傳送至伺服器後的時間 (以秒為單位)。在第一次更新時,這項值會為零。如果時間不明 (例如應用程式重新啟動時),這個值會重設為零。 |
num_stale_updates |
僅限輸入。已淘汰:現在會使用其他信號來判斷位置是否過時。 |
raw_ |
原始車輛位置 (未經過道路擷取器處理)。 |
raw_ |
與原始位置相關聯的時間戳記。 |
raw_ |
原始位置的來源。預設值為 |
raw_ |
|
supplemental_ |
整合應用程式提供的額外位置資訊。 |
supplemental_ |
與補充位置相關聯的時間戳記。 |
supplemental_ |
補充位置的來源。預設值為 |
supplemental_ |
|
road_snapped |
已淘汰:請改用 |
VehicleMatch
包含車輛和相關預估值,這些值與車輛的有效行程點相符 SearchVehiclesRequest
。
欄位 | |
---|---|
vehicle |
必要欄位。符合要求的車輛。 |
vehicle_ |
車輛行駛至要求中指定的接送地點所需的預估時間。空值表示無法計算車輛的預估抵達時間。如果 |
vehicle_ |
車輛目前所在位置與要求中指定上車地點的距離,包括現有行程的任何中途上車或下車地點。這個距離包含計算出的行車 (路線) 距離,以及導航終點和要求的接送點之間的直線距離。(導航終點和要求的接送地點之間的距離通常很近)。空值表示計算距離時發生錯誤。 |
vehicle_ |
必要欄位。車輛與要求中指定的接送地點之間的直線距離。 |
vehicle_ |
車輛從要求中指定的下車地點到達目的地的預估車程時間。預估抵達時間會將在要求中指定的 |
vehicle_ |
車輛從取車點到要求中指定的下車點的駕駛距離 (以公尺為單位)。距離只計算兩個點之間的距離,不包含車輛在前往上車/下車地點前必須經過的車輛位置或任何其他點。只有在請求中指定 |
trip_ |
必要欄位。用於計算上車地點預估抵達時間的請求行程類型。 |
vehicle_ |
用於計算預估到達時間的定點排序清單。清單包含車輛位置、車輛有效行程的接送地點,以及要求中提供的接送地點。如果清單為空白,表示無法計算車輛的預估抵達時間。 |
vehicle_ |
車輛比對類型。 |
requested_ |
請求的車輛比對排序順序。等同於 |
ordered_ |
請求的車輛比對排序順序。等同於 |
VehicleMatchType
車輛比對類型。
列舉 | |
---|---|
UNKNOWN |
不明的車輛比對類型 |
EXCLUSIVE |
車輛目前沒有指派的行程,可以繼續前往上車地點。 |
BACK_TO_BACK |
車輛目前已指派給行程,但在完成行程後,可以繼續前往上車地點。預估抵達時間和距離計算會考量現有行程。 |
CARPOOL |
車輛有足夠的乘客座位,可提供共乘服務。 |
CARPOOL_BACK_TO_BACK |
車輛會先完成目前的有效行程,再前往上車地點。預估抵達時間和距離計算會考量現有行程。 |
VehicleState
Vehicle
的狀態。
列舉 | |
---|---|
UNKNOWN_VEHICLE_STATE |
預設值,用於未指定或未識別的車輛狀態。 |
OFFLINE |
車輛不接受新的行程。注意:車輛在完成指派的行程時,可能會繼續處於這個狀態。 |
ONLINE |
車輛正在接受新行程。 |
VisualTrafficReportPolylineRendering
說明用戶端應如何為沿路多邊形的一部分著色。
欄位 | |
---|---|
road_ |
選用設定。應沿著折線算繪的道路路段。系統會保證不重疊區塊,但不一定會跨越整個路線。 如果沒有要設定樣式的路段,用戶端應為路線套用預設值。 |
RoadStretch
應算繪的路段。
欄位 | |
---|---|
style |
必要欄位。要套用的樣式。 |
offset_ |
必要欄位。樣式應套用至 |
length_ |
必要欄位。要套用樣式的路徑長度。 |
樣式
路況樣式,用於顯示車流速度。
列舉 | |
---|---|
STYLE_UNSPECIFIED |
未選取任何樣式。 |
SLOWER_TRAFFIC |
車流量正在減緩。 |
TRAFFIC_JAM |
交通壅塞。 |
途經點
說明 SearchVehiclesResponse
中 VehicleMatch
路線的中間點。在所有其他端點中,這個概念會以 TripWaypoint
表示。
欄位 | |
---|---|
lat_ |
此航點的位置。 |
eta |
車輛預計抵達這個路標的時間。 |
WaypointType
路線點的類型。
列舉 | |
---|---|
UNKNOWN_WAYPOINT_TYPE |
不明或未指定的路標類型。 |
PICKUP_WAYPOINT_TYPE |
乘客或物品上車的路徑點。 |
DROP_OFF_WAYPOINT_TYPE |
乘客或物品下車的路徑點。 |
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE |
多目的地行程中途經過地點的路線控點。 |