索引
TripService
(介面)VehicleService
(介面)BatteryInfo
(訊息)BatteryStatus
(列舉)BillingPlatformIdentifier
(列舉)ConsumableTrafficPolyline
(訊息)CreateTripRequest
(訊息)CreateVehicleRequest
(訊息)DeleteTripRequest
(訊息)DeleteVehicleRequest
(訊息)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
(訊息)TerminalLocation.PointSource
(列舉)TerminalPointId
(訊息) (已淘汰)TrafficPolylineData
(訊息)Trip
(訊息)TripAttribute
(訊息)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 |
---|
在 Fleet Engine 中建立行程,並傳回新行程。 |
DeleteTrip |
---|
刪除單一行程。 如果行程處於有效狀態且已指派車輛,則會傳回 FAILED_PRECONDITION。 |
GetTrip |
---|
取得單趟行程的相關資訊。 |
ReportBillableTrip |
---|
回報可計費的行程用量。 |
SearchTrips |
---|
取得特定車輛的所有行程。 |
UpdateTrip |
---|
更新行程資料。 |
VehicleService
車輛管理服務。
CreateVehicle |
---|
建立與隨選共乘或外送服務供應商相關聯的新車輛。每個 建立
建立
其他欄位均為選填,但如果提供,系統就會使用。 |
DeleteVehicle |
---|
從 Fleet Engine 刪除車輛。 如果車輛有已指派的有效行程,則會傳回 FAILED_PRECONDITION。 |
GetVehicle |
---|
從 Fleet Engine 傳回車輛。 |
ListVehicles |
---|
傳回與供應商相關聯的車輛分頁清單,這些車輛符合要求選項。 |
SearchVehicles |
---|
傳回符合要求選項的車輛清單。 |
UpdateVehicle |
---|
將更新後的車輛資料寫入 Fleet Engine。 更新
車輛 如果更新 |
UpdateVehicleAttributes |
---|
部分更新車輛的屬性。系統只會更新要求中提及的屬性,其他屬性則不會變更。注意:在 |
BatteryInfo
裝置電池的相關資訊。
欄位 | |
---|---|
battery_status |
電池狀態,例如是否已充飽電或正在充電。 |
power_source |
電池電源狀態。 |
battery_percentage |
目前的電量百分比 [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_reading_interval[] |
從上一個途中的航點到目前航點的路徑,沿途的交通速度。 |
encoded_path_to_waypoint |
駕駛從上一個途中的航點到目前航點所採取的路徑。這條路徑包含地標,因此用戶端可以沿著路徑顯示流量標記 (請參閱 |
CreateTripRequest
CreateTrip 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
trip_id |
必要欄位。不重複的行程 ID。須遵守下列限制:
|
trip |
必要欄位。要建立的行程實體。 建立行程時,必須填寫下列欄位:
如果您提供下列欄位,系統就會使用這些欄位:
系統會忽略其他所有行程欄位。舉例來說,即使您在建立要求中傳遞 只有 為共乘行程設定 指定 系統會使用 |
CreateVehicleRequest
CreateVehicle
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
vehicle_id |
必要欄位。專屬車輛 ID。須遵守下列限制:
|
vehicle |
必要欄位。要建立的車輛實體。建立車輛時,必須填寫下列欄位:
建立車輛時,系統會忽略下列欄位:
其他欄位均為選填,但如果提供,系統就會使用。 |
DeleteTripRequest
DeleteTrip 要求訊息。
欄位 | |
---|---|
header |
(選用步驟) 標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
DeleteVehicleRequest
DeleteVehicle 要求訊息。
欄位 | |
---|---|
header |
(選用步驟) 標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
DeviceSettings
行動裝置上各種設定的相關資訊。
欄位 | |
---|---|
location_power_save_mode |
省電模式開啟時,裝置的位置資訊功能設定行為。 |
is_power_save_mode |
裝置目前是否處於省電模式。 |
is_interactive |
裝置是否處於互動狀態。 |
battery_info |
電池狀態資訊。 |
GetTripRequest
GetTrip 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
view |
應傳回的行程欄位子集及其解讀方式。 |
current_route_segment_version |
指出要擷取 |
remaining_waypoints_version |
已淘汰:一律會擷取 |
route_format_type |
傳回的目前路徑格式, |
current_route_segment_traffic_version |
指出要擷取 |
remaining_waypoints_route_version |
指出要擷取 |
GetVehicleRequest
GetVehicle
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
current_route_segment_version |
指出要擷取 |
waypoints_version |
指出要擷取 |
LicensePlate
車輛的車牌資訊。為避免儲存個人識別資訊,系統只會將車牌的最低資訊量儲存為實體的一部分。
欄位 | |
---|---|
country_code |
必要欄位。CLDR 國家/地區代碼。例如 |
last_character |
車牌號碼的最後一位數字,或「-1」表示車牌號碼中沒有數字。
|
ListVehiclesRequest
ListVehicles
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
page_size |
要傳回的車輛數量上限。預設值為 100。 |
page_token |
先前呼叫 |
minimum_capacity |
指定車輛的最低容納人數。傳回的所有車輛的 |
trip_types[] |
將回應限制為至少支援一種指定行程類型的車輛。 |
maximum_staleness |
將回應限制為在指定時間內向 Fleet Engine 傳送位置更新的車輛。如果靜止車輛仍在傳輸位置資訊,就不會視為過時。如有提供,必須是有效的正數時間長度。 |
vehicle_type_categories[] |
必要欄位。將回應限制為具有指定類型類別的車輛。不允許 |
required_attributes[] |
呼叫端可以使用
將回應限制為具有指定屬性的車輛。這個欄位是連詞/AND 運算。最多可使用 50 個 required_attributes。這與車輛允許的屬性數量上限相符。每個重複字串的格式都應為「鍵:值」。 |
required_one_of_attributes[] |
將回應限制為每個 |
required_one_of_attribute_sets[] |
與
將回應限制為符合 |
vehicle_state |
將回應限制為具有此車輛狀態的車輛。 |
on_trip_only |
請只歸還目前有行程的車輛。 |
filter |
(選用步驟) 列出車輛時要套用的篩選查詢。如需篩選器語法範例,請參閱 http://aip.dev/160。 這個欄位旨在取代 這個篩選器會與其他限制 (例如 請注意,系統僅支援車輛屬性查詢 (例如 此外,所有屬性都會儲存為字串,因此唯一支援的屬性比較是字串比較。如要與數字或布林值比較,必須明確加上引號,將值視為字串 (例如 |
viewport |
(選用步驟) 這項篩選器會將傳回的車輛限制為最後已知位置位於可視區域定義的矩形區域內。 |
ListVehiclesResponse
ListVehicles
回應訊息。
欄位 | |
---|---|
vehicles[] |
符合要求中條件的車輛。傳回的車輛數量上限取決於要求中的 |
next_page_token |
用來擷取下一頁車輛的符記。如果沒有其他符合要求條件的車輛,這個欄位會留空。 |
total_size |
必要欄位。所有頁面中符合要求條件的車輛總數。 |
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 |
輔助全球衛星定位系統、行動通信基地台 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_code |
必要欄位。行程所在國家/地區的雙字母國家/地區代碼。價格會依國家/地區代碼而定。 |
platform |
發出要求的平台。 |
related_ids[] |
與回報行程直接相關的 ID。這些通常是行程 ID 可用前完成的預訂前作業 ID (例如工作階段 ID)。 |
solution_type |
用於回報行程的 GMP 產品解決方案類型 (例如 |
SolutionType
選取器,用於選擇回報行程的不同解決方案類型。
列舉 | |
---|---|
SOLUTION_TYPE_UNSPECIFIED |
預設值。為確保回溯相容性,API 預設會使用 ON_DEMAND_RIDESHARING_AND_DELIVERIES ,這是第一個支援的解決方案類型。 |
ON_DEMAND_RIDESHARING_AND_DELIVERIES |
解決方案:隨選共乘和運送行程。 |
RequestHeader
RequestHeader 包含所有 Fleet Engine RPC 要求通用的欄位。
欄位 | |
---|---|
language_code |
BCP-47 語言代碼,例如 en-US 或 sr-Latn。詳情請參閱 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。如果未指定語言,回覆內容可能會使用任何語言,但如果該名稱有英文版本,則會優先使用英文。欄位值範例: |
region_code |
必要欄位。要求來源地區的 CLDR 地區代碼。欄位值範例: |
sdk_version |
通話 SDK 版本 (如適用)。版本格式為「major.minor.patch」,例如 |
os_version |
執行通話 SDK 的作業系統版本。欄位值範例: |
device_model |
執行呼叫 SDK 的裝置型號。欄位值範例: |
sdk_type |
傳送要求的 SDK 類型。 |
maps_sdk_version |
呼叫 SDK 所依附的 MapSDK 版本 (如適用)。版本格式為「major.minor.patch」,例如 |
nav_sdk_version |
呼叫 SDK 所依附的 NavSDK 版本 (如適用)。版本格式為「major.minor.patch」,例如 |
platform |
呼叫 SDK 的平台。 |
manufacturer |
呼叫 SDK 的 Android 裝置製造商,僅適用於 Android SDK。欄位值範例: |
android_api_level |
呼叫 SDK 的 Android API 級別,僅適用於 Android SDK。欄位值範例: |
trace_id |
選用 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_id |
與要求中的行程相關聯的車輛。如未指定,傳回的行程不會包含:
|
active_trips_only |
如果設為 true,回應會包含影響駕駛人路線的行程。 |
page_size |
如果未設定,伺服器會決定要傳回的結果數量。 |
page_token |
將這個值設為先前在 |
minimum_staleness |
如果指定,則傳回在 |
SearchTripsResponse
SearchTrips 回應訊息。
欄位 | |
---|---|
trips[] |
所要求車輛的行程清單。 |
next_page_token |
在 SearchTripsRequest 中傳遞這個權杖,即可逐頁瀏覽清單結果。API 會在每次呼叫時傳回行程清單,如果沒有其他結果,行程清單就會空白。 |
SearchVehiclesRequest
SearchVehicles
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
parent |
必要欄位。格式必須為 |
pickup_point |
必要欄位。要搜尋附近的取貨地點。 |
dropoff_point |
顧客預計的下車地點。如果 |
pickup_radius_meters |
必要欄位。定義取貨地點周圍的車輛搜尋半徑。系統只會傳回搜尋半徑內的車輛。值必須介於 400 至 10000 公尺之間 (含)。 |
count |
必要欄位。指定要傳回的車輛數量上限。值須介於 1 至 50 (含) 之間。 |
minimum_capacity |
必要欄位。指定行程的乘客人數。值必須大於或等於 1。容量值不會納入驅動程式。 |
trip_types[] |
必要欄位。代表建議行程的類型。只能包含一個類型。不允許 |
maximum_staleness |
將搜尋範圍限制為在指定時間內向 Fleet Engine 傳送位置更新的車輛。如果靜止車輛仍在傳輸位置資訊,就不會視為過時。如果未設定這個欄位,伺服器會使用五分鐘做為預設值。 |
vehicle_types[] |
必要欄位。將搜尋範圍限制為指定類型的車輛。至少須指定一種車輛類型。不得使用類別為 |
required_attributes[] |
呼叫端可以使用
將搜尋範圍限制為僅包含具有指定屬性的車輛。這個欄位是連詞/AND 運算。最多可使用 50 個 required_attributes。這與車輛允許的屬性數量上限相符。 |
required_one_of_attributes[] |
將搜尋範圍限制為每個 |
required_one_of_attribute_sets[] |
與
將搜尋範圍限制為僅包含 |
order_by |
必要欄位。指定結果的所需排序條件。 |
include_back_to_back |
這表示單一行程的車輛是否符合這項搜尋條件。只有在未指定 預設值為 |
trip_id |
指出與這個 |
current_trips_present |
這表示有進行中行程的車輛是否符合這項搜尋條件。如果 |
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 (以零為基準的索引),SpeedReadingInterval 會定義間隔,並使用下列類別說明流量。
欄位 | |
---|---|
start_polyline_point_index |
路徑中這個間隔的起始索引。在 JSON 中,如果索引為 0,欄位會顯示為未填入。 |
end_polyline_point_index |
路徑中這個間隔的結束索引。在 JSON 中,如果索引為 0,欄位會顯示為未填入。 |
speed |
這個間隔的車流速度。 |
速度
根據交通流量資料分類折線速度。
列舉 | |
---|---|
SPEED_UNSPECIFIED |
預設值。這個值不會使用。 |
NORMAL |
正常速度,車流暢通。 |
SLOW |
系統偵測到車流減緩,車流中等。 |
TRAFFIC_JAM |
車流堵塞。 |
StopLocation
停靠站 (上車/下車) 的實際位置。
欄位 | |
---|---|
point |
必要欄位。表示實際位置。 |
timestamp |
指出停靠時間。 |
stop_time |
僅限輸入。已淘汰,使用時間戳記欄位。 |
TerminalLocation
說明路線控點的位置。
欄位 | |
---|---|
point |
表示路線控點的確切 |
place |
代表這個位置的地點資源名稱。格式為 這是實驗功能。 |
point_location_source |
僅供輸出。 |
terminal_point_id |
已淘汰:請改為指定 |
access_point_id |
已淘汰:請改為指定 |
trip_id |
已淘汰。 |
terminal_location_type |
已淘汰: |
PointSource
指出 LatLng
的來源。
列舉 | |
---|---|
POINT_SOURCE_UNSPECIFIED |
未指定點來源。 |
POINT_SOURCE_DEVELOPER_PROVIDED |
開發人員明確提供 LatLng 。 |
POINT_SOURCE_CALCULATED_FROM_PLACE |
LatLng 是根據所提供的地點計算得出。 |
TerminalPointId
已淘汰:Fleet Engine 不再支援 TerminalPoint。請改用 TerminalLocation.point
。
欄位 | |
---|---|
value |
已淘汰。 |
聯集欄位 Id 。已淘汰,Id 只能是下列其中一項: |
|
place_id |
已淘汰。 |
generated_id |
已淘汰。 |
TrafficPolylineData
預計車輛行駛路線的路況。
欄位 | |
---|---|
traffic_rendering |
以折線顯示顧客行程中某段路程所有區域的交通速度。 |
行程
行程中繼資料。
欄位 | |
---|---|
name |
僅供輸出。格式為「providers/{provider}/trips/{trip}」 |
vehicle_id |
執行這趟行程的車輛 ID。 |
trip_status |
行程的目前狀態。 |
trip_type |
行程類型。 |
pickup_point |
顧客指定取貨的地點。 |
actual_pickup_point |
僅限輸入。顧客上車時的實際地點。這個欄位供供應商提供實際取貨資訊的意見回饋。 |
actual_pickup_arrival_point |
僅限輸入。司機抵達上車地點的實際時間和位置。這個欄位供供應商提供取貨地點的實際抵達資訊。 |
pickup_time |
僅供輸出。預估乘客上車時間或實際上車時間。 |
intermediate_destinations[] |
行程要求中的中途停靠站 (取貨和送達地點除外)。共乘行程一開始不支援這項功能。 |
intermediate_destinations_version |
指出上次修改 |
intermediate_destination_index |
當 |
actual_intermediate_destination_arrival_points[] |
僅限輸入。司機抵達中途目的地的實際時間和地點。供應商可透過這個欄位,針對中途目的地的實際抵達資訊提供意見回饋。 |
actual_intermediate_destinations[] |
僅限輸入。顧客從中途目的地上車的實際時間和地點。這個欄位供供應商提供中途目的地的實際取貨資訊。 |
dropoff_point |
顧客指定下車的地點。 |
actual_dropoff_point |
僅限輸入。顧客實際下車的時間和地點。這個欄位供供應商提供實際下車資訊的意見回饋。 |
dropoff_time |
僅供輸出。預估乘客抵達最終目的地的時間,或實際抵達時間。 |
remaining_waypoints[] |
僅供輸出。從目前位置到下車地點的完整路徑 (含兩端)。這條路徑可能包含其他行程的路線控點。 |
vehicle_waypoints[] |
這個欄位支援手動排序行程的路線控點。其中包含指派車輛的所有剩餘途經點,以及這趟行程的取貨和送達途經點。如果行程尚未指派車輛,Fleet Engine 會忽略這個欄位。基於隱私權考量,這個欄位只會在 |
route[] |
僅供輸出。這趟行程預計前往 remaining_waypoints 中第一個項目的路線。請注意,第一個中途點可能屬於其他行程。 |
current_route_segment |
僅供輸出。下一個途中的編碼路徑。 注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。目前尚未支援解碼。 |
current_route_segment_version |
僅供輸出。指出路線上次修改的時間。 注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。 |
current_route_segment_traffic |
僅供輸出。顯示 注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。 |
current_route_segment_traffic_version |
僅供輸出。顯示 注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。 |
current_route_segment_end_point |
僅供輸出。 |
remaining_distance_meters |
僅供輸出。 |
eta_to_first_waypoint |
僅供輸出。抵達下一個途中的預計時間 ( |
remaining_time_to_first_waypoint |
僅供輸出。從系統傳回行程資料到 |
remaining_waypoints_version |
僅供輸出。表示上次變更 |
remaining_waypoints_route_version |
僅供輸出。指出上次修改 |
number_of_passengers |
不可變更。表示這趟行程的乘客人數,不含司機。車輛必須有可用容量,才能在 |
last_location |
僅供輸出。指出車輛在路線上最後回報的位置。 |
last_location_snappable |
僅供輸出。指出車輛的 |
view |
系統會填入的 Trip 欄位子集,以及這些欄位的解讀方式。 |
attributes[] |
自訂行程屬性清單。每個屬性都必須有專屬鍵。 |
TripAttribute
以鍵/值組合形式說明行程屬性。「鍵:值」字串長度不得超過 256 個字元。
欄位 | |
---|---|
key |
屬性的鍵。索引鍵不得包含半形冒號 (:)。 |
聯集欄位 trip_attribute_value 。屬性的值可以是字串、布林值或雙精度浮點數類型。trip_attribute_value 只能是下列其中一項: |
|
string_value |
字串類型的屬性值。 |
bool_value |
布林值型別屬性值。 |
number_value |
雙精度浮點數型別的屬性值。 |
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
回應中選取不同的行程欄位組合。如需相關背景資訊,請參閱 AIP-157。日後可能會新增其他檢視畫面。
列舉 | |
---|---|
TRIP_VIEW_UNSPECIFIED |
預設值。為了兼顧回溯相容性,API 會預設為 SDK 檢視畫面。為確保穩定性和支援服務,建議客戶選取 TripView 以外的 SDK 。 |
SDK |
包括可能無法使用公開程式庫解讀或支援的欄位。 |
JOURNEY_SHARING_V1S |
系統會為行程分享用途填入行程欄位。這個檢視畫面適用於伺服器對伺服器的通訊。 |
TripWaypoint
說明車輛路線上的停靠點,或車輛行程的終點。
欄位 | |
---|---|
location |
這個中途點的位置。 |
trip_id |
與這個中途點相關聯的行程。 |
waypoint_type |
這個中途點在行程中扮演的角色,例如取貨或送達。 |
path_to_waypoint[] |
從上一個途中的航點到目前航點的路徑。如果是第一個途經點,路徑會從車輛目前位置到途經點。這個欄位只會在要求時填入。 |
encoded_path_to_waypoint |
從上一個中途點到目前中途點的編碼路徑。 注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。目前尚未支援解碼。 |
traffic_to_waypoint |
前往這個中途點的路徑路況。請注意,這項功能僅適用於 Google 地圖平台 Rides and Deliveries Solution 客戶。 |
distance_meters |
從上一個途中的航點到目前航點的路徑距離。如果是第一個中途點,路徑距離是從車輛目前位置到中途點的距離。 |
eta |
抵達這個中途點的預計時間。 |
duration |
從上一個中途點到這個中途點的旅行時間。如果是第一個中途點,則為車輛目前位置到中途點的行車時間。 |
UpdateTripRequest
UpdateTrip 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
trip |
必要欄位。與更新相關聯的行程。 下列欄位由 Fleet Engine 維護。請勿使用 Trip.update 更新這些屬性。
更新共乘行程的 指定 為避免多目的地行程發生競爭情況,請在將行程狀態更新為 |
update_mask |
必要欄位。欄位遮罩,指出要更新行程中的哪些欄位。 |
UpdateVehicleAttributesRequest
UpdateVehicleAttributes
要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
attributes[] |
必要欄位。要更新的車輛屬性。未提及的屬性不會變更或移除。 |
UpdateVehicleAttributesResponse
UpdateVehicleAttributes
回應訊息。
欄位 | |
---|---|
attributes[] |
必要欄位。更新後的完整車輛屬性清單,包括新增、變更和未變更的屬性。 |
UpdateVehicleRequest
`UpdateVehicle 要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式必須為 |
vehicle |
必要欄位。要套用的
如果更新 同樣地, |
update_mask |
必要欄位。欄位遮罩,指出要更新 |
車輛
車輛中繼資料。
欄位 | |
---|---|
name |
僅供輸出。這部車輛的專屬名稱。格式為 |
vehicle_state |
車輛狀態。 |
supported_trip_types[] |
這輛車支援的行程類型。 |
current_trips[] |
僅供輸出。目前指派給這輛車的行程 |
last_location |
車輛最後回報的位置。 |
past_locations[] |
僅限輸入。這部車輛過去曾到過,但尚未向 Fleet Engine 回報的位置。這項功能用於 |
maximum_capacity |
這輛車可搭載的乘客總數。這項值不包含司機。這個值必須大於或等於 1。 |
attributes[] |
車輛屬性清單。車輛最多可有 100 個屬性,且每個屬性都必須有專屬鍵。 |
vehicle_type |
必要欄位。這輛車的類型。可用於篩選 |
license_plate |
車輛的車牌資訊。 |
route[] |
已淘汰:請改用 |
current_route_segment |
折線,指定駕駛人應用程式預計前往下一個途中的路線。系統也會在 注意:這個欄位僅供 Driver SDK 使用。目前尚未支援解碼。 |
current_route_segment_traffic |
僅限輸入。Fleet Engine 會使用這項資訊改善行程分享功能。注意:這個欄位僅供 Driver SDK 使用。 |
current_route_segment_version |
僅供輸出。設定 |
current_route_segment_end_point |
|
remaining_distance_meters |
|
eta_to_first_waypoint |
更新車輛時,同一要求中的 |
remaining_time_seconds |
僅限輸入。 更新車輛時,同一要求中的 |
waypoints[] |
指派給這輛車的其餘航點。 |
waypoints_version |
僅供輸出。上次更新 |
back_to_back_enabled |
指出司機是否接受連續行程。如果 |
navigation_status |
車輛的導航狀態。 |
device_settings |
僅限輸入。駕駛人所用行動裝置的設定資訊。 |
VehicleType
車輛類型。
欄位 | |
---|---|
category |
車輛類型類別 |
類別
車輛類型類別
列舉 | |
---|---|
UNKNOWN |
預設值,用於未指定或無法辨識的車輛類別。 |
AUTO |
汽車。 |
TAXI |
任何做為計程車的車輛 (通常須取得執照或受管制)。 |
TRUCK |
一般來說,這類車輛的儲物空間較大。 |
TWO_WHEELER |
機車、輕型機踏車或其他雙輪車輛 |
BICYCLE |
以人力為動力的交通工具。 |
PEDESTRIAN |
人類運輸者,通常會步行或跑步,沿著行人路徑移動。 |
VehicleAttribute
以鍵/值組合形式說明車輛屬性。「鍵:值」字串長度不得超過 256 個字元。
欄位 | |
---|---|
key |
屬性的鍵。索引鍵不得包含半形冒號 (:)。 |
value |
屬性的值。 |
聯集欄位 vehicle_attribute_value 。屬性的值可以是字串、布林值或雙精度浮點數類型。vehicle_attribute_value 只能是下列其中一項: |
|
string_value |
字串類型的屬性值。 注意:這與 |
bool_value |
布林值型別屬性值。 |
number_value |
雙精度浮點數型別的屬性值。 |
VehicleAttributeList
車輛屬性的清單清單資料類型。
欄位 | |
---|---|
attributes[] |
這個集合中的屬性清單。 |
VehicleLocation
車輛在特定時間點的位置、速度和航向。
欄位 | |
---|---|
location |
車輛位置。傳送至 Fleet Engine 的車輛位置是 GPS 位置。當您在回覆中收到這項資訊時,車輛位置可能是 GPS 位置、輔助位置或其他預估位置。來源是在 |
horizontal_accuracy |
已淘汰:請改用 |
latlng_accuracy |
準確度為 |
heading |
車輛行進方向 (以角度表示)。0 代表北方。有效範圍為 [0,360)。 |
bearing_accuracy |
已淘汰:請改用 |
heading_accuracy |
準確度為 |
altitude |
以高於 WGS84 的公尺數表示。 |
vertical_accuracy |
已淘汰:請改用 |
altitude_accuracy |
準確度為 |
speed_kmph |
車輛速度 (以公里/小時為單位)。已淘汰:請改用 |
speed |
車輛速度 (以公尺/秒為單位) |
speed_accuracy |
準確度,單位為公尺/秒。 |
update_time |
感應器回報 |
server_time |
僅供輸出。伺服器收到位置資訊的時間。 |
location_sensor |
位置資料供應商 (例如 |
is_road_snapped |
|
is_gps_sensor_enabled |
僅限輸入。指出行動裝置是否已啟用 GPS 感應器。 |
time_since_update |
僅限輸入。自這個位置資訊首次傳送至伺服器以來經過的時間 (以秒為單位)。第一次更新時,這個值會是零。如果時間不明 (例如應用程式重新啟動時),這個值會重設為零。 |
num_stale_updates |
僅限輸入。已淘汰:現在會使用其他信號判斷位置資訊是否過時。 |
raw_location |
車輛原始位置 (未經道路吸附處理)。 |
raw_location_time |
與原始位置資訊相關聯的時間戳記。 |
raw_location_sensor |
原始位置的來源。預設值為 |
raw_location_accuracy |
以公尺為單位的半徑 |
flp_location |
Android 整合式位置預測提供工具提供的位置資訊。 |
flp_update_time |
更新 |
flp_latlng_accuracy_meters |
準確度為 |
flp_heading_degrees |
車輛的移動方向 (以度為單位),由 Fused Location Provider 判斷。0 代表北方。有效範圍為 [0,360)。 |
supplemental_location |
整合應用程式提供的補充位置資訊。 |
supplemental_location_time |
與補充地點相關聯的時間戳記。 |
supplemental_location_sensor |
補充位置資訊的來源。預設值為 |
supplemental_location_accuracy |
以公尺為單位的半徑 |
road_snapped |
已淘汰:請改用 |
VehicleMatch
包含車輛和相關預估值,這些預估值與車輛 SearchVehiclesRequest
的有效行程點相符。
欄位 | |
---|---|
vehicle |
必要欄位。符合要求的車輛。 |
vehicle_pickup_eta |
車輛抵達要求中指定取貨點的預計時間。如果值為空白,表示系統無法計算車輛的預計抵達時間。如果 |
vehicle_pickup_distance_meters |
車輛目前位置與要求中指定的上車地點之間的距離,包括現有行程的任何中途上車或下車地點。這段距離包含計算出的行車 (路線) 距離,以及導航終點與要求的上車地點之間的直線距離。(導航終點與要求的上車地點之間的距離通常很短)。如果值為空白,表示計算距離時發生錯誤。 |
vehicle_pickup_straight_line_distance_meters |
必要欄位。車輛與要求中指定上車地點之間的直線距離。 |
vehicle_dropoff_eta |
車輛抵達要求中指定卸貨地點的完整預計時間。預計抵達時間包括在要求中指定的 |
vehicle_pickup_to_dropoff_distance_meters |
車輛從要求中指定的取貨地點到下車地點的行車距離 (以公尺為單位)。這項距離僅指兩點之間的距離,不包括車輛位置或車輛必須先前往的任何其他地點,才能抵達取貨點或送達點。只有在要求中指定 |
trip_type |
必要欄位。用來計算上車地點預計抵達時間的要求行程類型。 |
vehicle_trips_waypoints[] |
用來計算預計抵達時間的航點排序清單。清單包括車輛位置、車輛有效行程的取貨點,以及要求中提供的取貨點。空清單表示無法計算車輛的預計抵達時間。 |
vehicle_match_type |
車輛比對類型。 |
requested_ordered_by |
要求排序相符車輛的順序。等同於 |
ordered_by |
要求排序相符車輛的順序。等同於 |
VehicleMatchType
車輛比對類型。
列舉 | |
---|---|
UNKNOWN |
不明的車輛比對類型 |
EXCLUSIVE |
車輛目前沒有已指派的行程,可以前往上車地點。 |
BACK_TO_BACK |
車輛目前已指派給行程,但完成進行中的行程後,即可前往上車地點。系統會根據現有行程計算預計抵達時間和距離。 |
CARPOOL |
車輛有足夠空間可供共乘。 |
CARPOOL_BACK_TO_BACK |
車輛會先完成目前行程,再前往上車地點。系統會根據現有行程計算預計抵達時間和距離。 |
VehicleState
Vehicle
的狀態。
列舉 | |
---|---|
UNKNOWN_VEHICLE_STATE |
預設值,用於未指定或無法辨識的車輛狀態。 |
OFFLINE |
車輛不接受新的行程。注意:車輛可能會繼續以這種狀態行駛,完成指派的行程。 |
ONLINE |
車輛接受新行程。 |
VisualTrafficReportPolylineRendering
說明用戶應如何沿著路線為折線的一部分著色。
欄位 | |
---|---|
road_stretch[] |
(選用步驟) 應沿著折線算繪的道路路段。路段保證不會重疊,也不一定會涵蓋整條路線。 如果沒有要套用樣式的路段,用戶端應為路線套用預設樣式。 |
RoadStretch
應算繪的一段道路。
欄位 | |
---|---|
style |
必要欄位。要套用的樣式。 |
offset_meters |
必要欄位。樣式應套用在 |
length_meters |
必要欄位。要套用樣式的路徑長度。 |
樣式
路況樣式,表示車流速度。
列舉 | |
---|---|
STYLE_UNSPECIFIED |
未選取任何樣式。 |
SLOWER_TRAFFIC |
交通越來越壅塞。 |
TRAFFIC_JAM |
發生交通壅塞。 |
途經點
說明 SearchVehiclesResponse
中 VehicleMatch
的路線沿途中間點。在所有其他端點中,這個概念都以 TripWaypoint
表示。
欄位 | |
---|---|
lat_lng |
這個中途點的位置。 |
eta |
車輛抵達這個中途點的預估時間。 |
WaypointType
航點類型。
列舉 | |
---|---|
UNKNOWN_WAYPOINT_TYPE |
不明或未指定的中途點類型。 |
PICKUP_WAYPOINT_TYPE |
接送乘客或物品的中途點。 |
DROP_OFF_WAYPOINT_TYPE |
乘客或物品的下車地點。 |
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE |
多目的地行程的中途目的地路線控點。 |