索引
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 |
---|
在 Fleet Engine 中建立行程並傳回新行程。 |
GetTrip |
---|
取得單一行程的相關資訊。 |
ReportBillableTrip |
---|
回報可計費行程用量。 |
SearchTrips |
---|
取得特定車輛的所有行程。 |
UpdateTrip |
---|
更新行程資料。 |
VehicleService
車輛管理服務。
CreateVehicle |
---|
將與隨需共乘服務或外送服務供應商相關聯的新車輛例項化。每個 建立
建立
所有其他欄位均為選填欄位,如有提供。 |
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 |
必要欄位。要建立的車輛實體。建立交通工具時,請務必填寫下列欄位:
建立車輛時,系統會忽略下列欄位:
所有其他欄位均為選填欄位,如有提供。 |
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。這與車輛允許的屬性數量上限相符。每個重複字串的格式應為「key:value」。 |
required_one_of_attributes[] |
限制對每個 |
required_one_of_attribute_sets[] |
與
限制只能回應與 |
vehicle_state |
限制回應具有此車輛狀態的車輛。 |
on_trip_only |
只傳回有當前行程的車輛。 |
filter |
選用設定。列出車輛時要套用的篩選查詢。如需篩選器語法範例,請參閱 http://aip.dev/160。 這個欄位是用來取代 這個篩選函式可做為 AND 子句,但具有其他限制條件,例如 請注意,只有車輛屬性 (例如 此外,所有屬性都會儲存為字串,因此唯一支援與屬性的比較是字串比較。如要與數字或布林值比較,您必須明確加上引號,才能視為字串 (例如 |
viewport |
選用設定。這個篩選器可限制車輛只返回可視位置位於可視區域定義的矩形區域。 |
ListVehiclesResponse
ListVehicles
回應訊息。
欄位 | |
---|---|
vehicles[] |
符合要求條件的車輛。傳回的車輛數量上限取決於要求中的 |
next_page_token |
用來擷取下一頁車輛的權杖;如果沒有其他符合要求條件的車輛,則留空。 |
total_size |
必要欄位。在所有頁面中,符合要求的車輛總數。 |
LocationPowerSaveMode
如何設定行動裝置在「省電模式」時運作時,各項功能的運作方式功能。(https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())
列舉 | |
---|---|
UNKNOWN_LOCATION_POWER_SAVE_MODE |
未定義的 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 或 WiFi 存取點。 |
PASSIVE |
基地台 ID 或 Wi-Fi 存取點。 |
ROAD_SNAPPED_LOCATION_PROVIDER |
行動裝置判定為最有可能的道路位置。 |
CUSTOMER_SUPPLIED_LOCATION |
顧客提供的營業地點資訊來自獨立來源。一般而言,這個值用於來源不是執行驅動程式 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 是驅動程式。 |
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 的車輛。即使一般車輛仍在傳輸位置資訊,也不算過時。如未設定這個欄位,伺服器會使用 5 分鐘做為預設值。 |
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。 這個欄位是用來取代 這個篩選函式可做為 AND 子句,但具有其他限制條件,例如 請注意,只有車輛屬性 (例如 此外,所有屬性都會儲存為字串,因此唯一支援與屬性的比較是字串比較。如要與數字或布林值比較,您必須明確加上引號,才能視為字串 (例如 |
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 |
必要欄位。表示行程路線控點的位置。 |
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_rendering |
顯示顧客在一段期間內,所有區域的車速有多快的折線。 |
行程
行程中繼資料。
欄位 | |
---|---|
name |
僅供輸出。格式為「provider/{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[] |
僅供輸出。這趟行程的預期路徑,可前往 back_waypoints 中第一個項目。請注意,第一個路線控點可能屬於不同的行程。 |
current_route_segment |
僅供輸出。前往下一個路線控點的編碼路徑。 注意:這個欄位僅供驅動程式 SDK 和 Consumer SDK 使用。目前不支援解碼。 |
current_route_segment_version |
僅供輸出。指出上次修改路線的時間。 注意:這個欄位僅供驅動程式 SDK 和 Consumer SDK 使用。 |
current_route_segment_traffic |
僅供輸出。指出 注意:這個欄位僅供驅動程式 SDK 和 Consumer SDK 使用。 |
current_route_segment_traffic_version |
僅供輸出。表示上次修改 注意:這個欄位僅供驅動程式 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 |
已填入的行程欄位子集及應如何解讀。 |
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 檢視畫面。為確保穩定性和支援,建議客戶選擇 SDK 以外的 TripView 。 |
SDK |
包含可能無法透過公開可用的程式庫解釋或支援的欄位。 |
JOURNEY_SHARING_V1S |
系統會針對「旅程分享」用途填入行程欄位。這種檢視模式適用於伺服器對伺服器的通訊。 |
TripWaypoint
說明車輛路線上的停靠點或車輛行程的終點。
欄位 | |
---|---|
location |
這個路線控點的位置。 |
trip_id |
與這個路線控點相關聯的行程。 |
waypoint_type |
這個路線控點在這趟行程中扮演的角色,例如上車或下車地點。 |
path_to_waypoint[] |
從上一個路線控點到目前路線點的路徑。清單中第一個路線點的未定義。這個欄位只有在要求時才會填入。 |
encoded_path_to_waypoint |
從前一個路線控點到目前路線點的編碼路徑。 注意:這個欄位僅供驅動程式 SDK 和 Consumer SDK 使用。目前不支援解碼。 |
traffic_to_waypoint |
途經此路線控點的路況。請注意,只有 Google 地圖平台乘車和配送服務解決方案客戶才能查詢路況。 |
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
「更新車輛要求訊息。
欄位 | |
---|---|
header |
標準 Fleet Engine 要求標頭。 |
name |
必要欄位。格式須為 |
vehicle |
必要欄位。要套用的
如果 同樣地, |
update_mask |
必要欄位。欄位遮罩,指出要更新 |
車輛
車輛中繼資料。
欄位 | |
---|---|
name |
僅供輸出。這輛車的專屬名稱。格式為 |
vehicle_state |
車輛狀態。 |
supported_trip_types[] |
這輛車支援的行程類型。 |
current_trips[] |
僅供輸出。目前指派給這輛車的行程 |
last_location |
上次回報的車輛位置 |
maximum_capacity |
這輛車可載客總人數。這個值不含驅動程式。這個值必須大於或等於 1。 |
attributes[] |
車輛屬性清單。一輛車最多能有 100 個屬性,而且每個屬性都必須有專屬索引鍵。 |
vehicle_type |
必要欄位。這輛車的類型。可用來篩選 |
license_plate |
車輛的車牌資訊。 |
route[] |
已淘汰:請改用 |
current_route_segment |
用於指定駕駛應用程式前往下一個路線點的路徑的折線。凡是指派給車輛的有效行程,這份清單也會在 注意:這個欄位僅供驅動程式 SDK 使用。目前不支援解碼。 |
current_route_segment_traffic |
僅限輸入。Fleet Engine 會使用這項資訊改善旅程分享體驗。注意:這個欄位僅供驅動程式 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
將車輛屬性描述為鍵/值組合。「key:value」字串長度不得超過 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 |
半徑為 |
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 |
這輛車的實際訂單。通常會比對「order_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 |
多目的地行程的中繼目的地路線控點。 |