Package maps.fleetengine.v1

索引

TripService

行程管理服務。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

在 Fleet Engine 中建立行程,並傳回新行程。

DeleteTrip

rpc DeleteTrip(DeleteTripRequest) returns (Empty)

刪除單一行程。

如果行程處於有效狀態且已指派車輛,則會傳回 FAILED_PRECONDITION。

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

取得單趟行程的相關資訊。

ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

回報可計費的行程用量。

SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

取得特定車輛的所有行程。

UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

更新行程資料。

VehicleService

車輛管理服務。

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

建立與隨選共乘或外送服務供應商相關聯的新車輛。每個 Vehicle 都必須有專屬的車輛 ID。

建立 Vehicle 時,必須填寫下列 Vehicle 欄位:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

建立 Vehicle 時,系統會忽略下列 Vehicle 欄位:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

其他欄位均為選填,但如果提供,系統就會使用。

DeleteVehicle

rpc DeleteVehicle(DeleteVehicleRequest) returns (Empty)

從 Fleet Engine 刪除車輛。

如果車輛有已指派的有效行程,則會傳回 FAILED_PRECONDITION。

GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

從 Fleet Engine 傳回車輛。

ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

傳回與供應商相關聯的車輛分頁清單,這些車輛符合要求選項。

SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

傳回符合要求選項的車輛清單。

UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

將更新後的車輛資料寫入 Fleet Engine。

更新 Vehicle 時,由於下列欄位是由伺服器管理,因此無法更新:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

車輛 name 也無法更新。

如果更新 attributes 欄位,車輛的所有屬性都會替換為要求中提供的屬性。如要僅更新部分屬性,請參閱 UpdateVehicleAttributes 方法。同樣地,waypoints 欄位可以更新,但必須包含車輛目前的所有航點,不得包含其他航點。

UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

部分更新車輛的屬性。系統只會更新要求中提及的屬性,其他屬性則不會變更。注意:在 UpdateVehicle 中,整個 attributes 欄位會由 UpdateVehicleRequest 中的欄位取代,要求中沒有的屬性則會移除。

BatteryInfo

裝置電池的相關資訊。

欄位
battery_status

BatteryStatus

電池狀態,例如是否已充飽電或正在充電。

power_source

PowerSource

電池電源狀態。

battery_percentage

float

目前的電量百分比 [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[]

SpeedReadingInterval

從上一個途中的航點到目前航點的路徑,沿途的交通速度。

encoded_path_to_waypoint

string

駕駛從上一個途中的航點到目前航點所採取的路徑。這條路徑包含地標,因此用戶端可以沿著路徑顯示流量標記 (請參閱 speed_reading_interval)。目前不支援解碼。

CreateTripRequest

CreateTrip 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

trip_id

string

必要欄位。不重複的行程 ID。須遵守下列限制:

  • 必須是有效的 Unicode 字串。
  • 長度上限為 64 個半形字元。
  • 根據 Unicode Normalization Form C 正規化。
  • 不得包含下列任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
trip

Trip

必要欄位。要建立的行程實體。

建立行程時,必須填寫下列欄位:

  • trip_type
  • pickup_point

如果您提供下列欄位,系統就會使用這些欄位:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

系統會忽略其他所有行程欄位。舉例來說,即使您在建立要求中傳遞 CANCELEDtrip_status,所有行程仍會以 NEWtrip_status 開始。

只有 EXCLUSIVE 行程支援 intermediate_destinations

為共乘行程設定 vehicle_id 時,您必須提供 Trip.vehicle_waypoints 清單,指定車輛剩餘中途站的順序,否則系統將無法判斷中途站順序。

指定 Trip.vehicle_waypoints 時,清單必須包含車輛行程的所有剩餘途經點,不得有額外途經點。你必須依序安排這些中途點,確保在特定行程中,上車地點位於中途目的地之前,且所有中途目的地都位於下車地點之前。EXCLUSIVE 行程的航點不得與任何其他行程交錯。

系統會使用 trip_idwaypoint_typelocation 欄位,並忽略 vehicle_waypoints 中的所有其他 TripWaypoint 欄位。

CreateVehicleRequest

CreateVehicle 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

vehicle_id

string

必要欄位。專屬車輛 ID。須遵守下列限制:

  • 必須是有效的 Unicode 字串。
  • 長度上限為 64 個半形字元。
  • 根據 Unicode Normalization Form C 正規化。
  • 不得包含下列任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
vehicle

Vehicle

必要欄位。要建立的車輛實體。建立車輛時,必須填寫下列欄位:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

建立車輛時,系統會忽略下列欄位:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

其他欄位均為選填,但如果提供,系統就會使用。

DeleteTripRequest

DeleteTrip 要求訊息。

欄位
header

RequestHeader

(選用步驟) 標準 Fleet Engine 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/trips/{trip}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

DeleteVehicleRequest

DeleteVehicle 要求訊息。

欄位
header

RequestHeader

(選用步驟) 標準 Fleet Engine 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/vehicles/{vehicle}。{provider} 必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

DeviceSettings

行動裝置上各種設定的相關資訊。

欄位
location_power_save_mode

LocationPowerSaveMode

省電模式開啟時,裝置的位置資訊功能設定行為。

is_power_save_mode

bool

裝置目前是否處於省電模式。

is_interactive

bool

裝置是否處於互動狀態。

battery_info

BatteryInfo

電池狀態資訊。

GetTripRequest

GetTrip 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/trips/{trip}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

view

TripView

應傳回的行程欄位子集及其解讀方式。

current_route_segment_version

Timestamp

指出要擷取 Trip.routeTrip.current_route_segment 資料的最低時間戳記 (不含)。如果自這個時間戳記以來,路線資料未曾變更,則回應中不會設定路線欄位。如未指定最小值,系統一律會擷取路線資料。

remaining_waypoints_version
(deprecated)

Timestamp

已淘汰:一律會擷取 Trip.remaining_waypoints。使用 remaining_waypoints_route_version 控制擷取 Trip.remaining_waypoints.traffic_to_waypointTrip.remaining_waypoints.path_to_waypoint 資料的時間。

route_format_type

PolylineFormatType

傳回的目前路徑格式,LAT_LNG_LIST_TYPE (在 Trip.route 中) 或 ENCODED_POLYLINE_TYPE (在 Trip.current_route_segment 中)。預設值為 LAT_LNG_LIST_TYPE

current_route_segment_traffic_version

Timestamp

指出要擷取 Trip.current_route_segment_traffic 的最低時間戳記 (不含)。如果自這個時間戳記以來,流量資料沒有變更,回應中就不會設定 current_route_segment_traffic 欄位。如果未指定下限,系統一律會擷取流量資料。請注意,這項功能僅適用於隨選乘車與運送服務解決方案客戶。

remaining_waypoints_route_version

Timestamp

指出要擷取 Trip.remaining_waypoints.traffic_to_waypointTrip.remaining_waypoints.path_to_waypoint 資料的最低時間戳記 (不含)。如果自這個時間戳記以來資料未變更,則回應中不會設定上述欄位。如果未指定 remaining_waypoints_route_version,系統一律會擷取流量和路徑。

GetVehicleRequest

GetVehicle 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/vehicles/{vehicle}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

current_route_segment_version

Timestamp

指出要擷取 Vehicle.current_route_segment 的最低時間戳記 (不含)。如果自這個時間戳記以來路線未變更,則回應中不會設定 current_route_segment 欄位。如果未指定下限,系統一律會擷取 current_route_segment

waypoints_version

Timestamp

指出要擷取 Vehicle.waypoints 資料的最低時間戳記 (不含)。如果自這個時間戳記以來,航點沒有任何變更,則回應中不會設定 vehicle.waypoints 資料。如果未指定這個欄位,系統一律會擷取 vehicle.waypoints

LicensePlate

車輛的車牌資訊。為避免儲存個人識別資訊,系統只會將車牌的最低資訊量儲存為實體的一部分。

欄位
country_code

string

必要欄位。CLDR 國家/地區代碼。例如 US 代表美國,IN 則代表印度。

last_character

string

車牌號碼的最後一位數字,或「-1」表示車牌號碼中沒有數字。

  • 「ABC 1234」->「4」
  • 「AB 123 CD」->「3」
  • 「ABCDEF」->「-1」

ListVehiclesRequest

ListVehicles 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

page_size

int32

要傳回的車輛數量上限。預設值為 100。

page_token

string

先前呼叫 ListVehicles 時提供的 next_page_token 值,方便您分頁瀏覽車輛群組。如果要求篩選條件與先前呼叫 ListVehicles 的篩選條件不同,則值為未定義。

minimum_capacity

Int32Value

指定車輛的最低容納人數。傳回的所有車輛的 maximum_capacity 都會大於或等於這個值。如果設定,則必須大於或等於 0。

trip_types[]

TripType

將回應限制為至少支援一種指定行程類型的車輛。

maximum_staleness

Duration

將回應限制為在指定時間內向 Fleet Engine 傳送位置更新的車輛。如果靜止車輛仍在傳輸位置資訊,就不會視為過時。如有提供,必須是有效的正數時間長度。

vehicle_type_categories[]

Category

必要欄位。將回應限制為具有指定類型類別的車輛。不允許UNKNOWN

required_attributes[]

string

呼叫端可以使用 required_attributesrequired_one_of_attributesrequired_one_of_attribute_sets 欄位的任意組合,形成複雜的邏輯運算。

required_attributes 是清單;required_one_of_attributes 使用的訊息允許清單清單。這兩個欄位結合後,即可組成下列運算式:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

將回應限制為具有指定屬性的車輛。這個欄位是連詞/AND 運算。最多可使用 50 個 required_attributes。這與車輛允許的屬性數量上限相符。每個重複字串的格式都應為「鍵:值」。

required_one_of_attributes[]

string

將回應限制為每個 VehicleAttributeList 中至少有一個指定屬性的車輛。在每個清單中,車輛必須符合至少一個屬性。這個欄位是每個 VehicleAttributeList 中的包含性析取/OR 運算,以及 VehicleAttributeList 集合中的合取/AND 運算。每個重複字串的格式應為「key1:value1|key2:value2|key3:value3」。

required_one_of_attribute_sets[]

string

required_one_of_attribute_sets 提供額外功能。

required_one_of_attributes 類似,required_one_of_attribute_sets 使用的訊息允許清單清單,因此可使用下列運算式:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

將回應限制為符合 VehicleAttributeList 中所有屬性的車輛。在每個清單中,車輛必須符合所有屬性。這個欄位是每個 VehicleAttributeList 中的連詞/AND 運算,以及整個 VehicleAttributeList 集合中的包含性析取/OR 運算。每個重複字串的格式應為「key1:value1|key2:value2|key3:value3」。

vehicle_state

VehicleState

將回應限制為具有此車輛狀態的車輛。

on_trip_only

bool

請只歸還目前有行程的車輛。

filter

string

(選用步驟) 列出車輛時要套用的篩選查詢。如需篩選器語法範例,請參閱 http://aip.dev/160

這個欄位旨在取代 required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets 欄位。如果在此指定非空白值,下列欄位必須留空:required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets

這個篩選器會與其他限制 (例如 vehicle_stateon_trip_only) 搭配使用,做為 AND 子句。

請注意,系統僅支援車輛屬性查詢 (例如 attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2>)。篩選器查詢最多可包含 50 項限制。

此外,所有屬性都會儲存為字串,因此唯一支援的屬性比較是字串比較。如要與數字或布林值比較,必須明確加上引號,將值視為字串 (例如 attributes.<key> = "10"attributes.<key> = "true")。

viewport

Viewport

(選用步驟) 這項篩選器會將傳回的車輛限制為最後已知位置位於可視區域定義的矩形區域內。

ListVehiclesResponse

ListVehicles 回應訊息。

欄位
vehicles[]

Vehicle

符合要求中條件的車輛。傳回的車輛數量上限取決於要求中的 page_size 欄位。

next_page_token

string

用來擷取下一頁車輛的符記。如果沒有其他符合要求條件的車輛,這個欄位會留空。

total_size

int64

必要欄位。所有頁面中符合要求條件的車輛總數。

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 作業系統上的位置資訊供應商。

車輛的導航狀態。

列舉
UNKNOWN_NAVIGATION_STATUS 未指定導覽狀態。
NO_GUIDANCE 駕駛人應用程式的導航功能處於 FREE_NAV 模式。
ENROUTE_TO_DESTINATION 即時路線導航功能已啟用,且 Driver 應用程式導航已進入 GUIDED_NAV 模式。
OFF_ROUTE 車輛已偏離建議路線。
ARRIVED_AT_DESTINATION 車輛距離目的地約 50 公尺。

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

string

必要欄位。格式必須為 providers/{provider}/billableTrips/{billable_trip}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

country_code

string

必要欄位。行程所在國家/地區的雙字母國家/地區代碼。價格會依國家/地區代碼而定。

platform

BillingPlatformIdentifier

發出要求的平台。

related_ids[]

string

與回報行程直接相關的 ID。這些通常是行程 ID 可用前完成的預訂前作業 ID (例如工作階段 ID)。related_ids 數量上限為 50 個。

solution_type

SolutionType

用於回報行程的 GMP 產品解決方案類型 (例如 ON_DEMAND_RIDESHARING_AND_DELIVERIES)。

SolutionType

選取器,用於選擇回報行程的不同解決方案類型。

列舉
SOLUTION_TYPE_UNSPECIFIED 預設值。為確保回溯相容性,API 預設會使用 ON_DEMAND_RIDESHARING_AND_DELIVERIES,這是第一個支援的解決方案類型。
ON_DEMAND_RIDESHARING_AND_DELIVERIES 解決方案:隨選共乘和運送行程。

RequestHeader

RequestHeader 包含所有 Fleet Engine RPC 要求通用的欄位。

欄位
language_code

string

BCP-47 語言代碼,例如 en-US 或 sr-Latn。詳情請參閱 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。如果未指定語言,回覆內容可能會使用任何語言,但如果該名稱有英文版本,則會優先使用英文。欄位值範例:en-US

region_code

string

必要欄位。要求來源地區的 CLDR 地區代碼。欄位值範例:US

sdk_version

string

通話 SDK 版本 (如適用)。版本格式為「major.minor.patch」,例如 1.1.2

os_version

string

執行通話 SDK 的作業系統版本。欄位值範例:4.4.112.1

device_model

string

執行呼叫 SDK 的裝置型號。欄位值範例:iPhone12,1SM-G920F

sdk_type

SdkType

傳送要求的 SDK 類型。

maps_sdk_version

string

呼叫 SDK 所依附的 MapSDK 版本 (如適用)。版本格式為「major.minor.patch」,例如 5.2.1

nav_sdk_version

string

呼叫 SDK 所依附的 NavSDK 版本 (如適用)。版本格式為「major.minor.patch」,例如 2.1.0

platform

Platform

呼叫 SDK 的平台。

manufacturer

string

呼叫 SDK 的 Android 裝置製造商,僅適用於 Android SDK。欄位值範例:Samsung

android_api_level

int32

呼叫 SDK 的 Android API 級別,僅適用於 Android SDK。欄位值範例:23

trace_id

string

選用 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

RequestHeader

標準 Fleet Engine 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

vehicle_id

string

與要求中的行程相關聯的車輛。如未指定,傳回的行程不會包含:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

如果設為 true,回應會包含影響駕駛人路線的行程。

page_size

int32

如果未設定,伺服器會決定要傳回的結果數量。

page_token

string

將這個值設為先前在 SearchTripsResponse 中傳回的值,即可從先前的結果繼續。

minimum_staleness

Duration

如果指定,則傳回在 (current - minimum_staleness) 時間後未更新的行程。

SearchTripsResponse

SearchTrips 回應訊息。

欄位
trips[]

Trip

所要求車輛的行程清單。

next_page_token

string

在 SearchTripsRequest 中傳遞這個權杖,即可逐頁瀏覽清單結果。API 會在每次呼叫時傳回行程清單,如果沒有其他結果,行程清單就會空白。

SearchVehiclesRequest

SearchVehicles 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

pickup_point

TerminalLocation

必要欄位。要搜尋附近的取貨地點。

dropoff_point

TerminalLocation

顧客預計的下車地點。如果 trip_types 包含 TripType.SHARED,則此欄位為必填欄位。

pickup_radius_meters

int32

必要欄位。定義取貨地點周圍的車輛搜尋半徑。系統只會傳回搜尋半徑內的車輛。值必須介於 400 至 10000 公尺之間 (含)。

count

int32

必要欄位。指定要傳回的車輛數量上限。值須介於 1 至 50 (含) 之間。

minimum_capacity

int32

必要欄位。指定行程的乘客人數。值必須大於或等於 1。容量值不會納入驅動程式。

trip_types[]

TripType

必要欄位。代表建議行程的類型。只能包含一個類型。不允許UNKNOWN_TRIP_TYPE。將搜尋範圍限制在支援該行程類型的車輛。

maximum_staleness

Duration

將搜尋範圍限制為在指定時間內向 Fleet Engine 傳送位置更新的車輛。如果靜止車輛仍在傳輸位置資訊,就不會視為過時。如果未設定這個欄位,伺服器會使用五分鐘做為預設值。

vehicle_types[]

VehicleType

必要欄位。將搜尋範圍限制為指定類型的車輛。至少須指定一種車輛類型。不得使用類別為 UNKNOWN 的 VehicleTypes。

required_attributes[]

VehicleAttribute

呼叫端可以使用 required_attributesrequired_one_of_attributesrequired_one_of_attribute_sets 欄位的任意組合,形成複雜的邏輯運算。

required_attributes 是清單;required_one_of_attributes 使用的訊息允許清單清單。這兩個欄位結合後,即可組成下列運算式:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

將搜尋範圍限制為僅包含具有指定屬性的車輛。這個欄位是連詞/AND 運算。最多可使用 50 個 required_attributes。這與車輛允許的屬性數量上限相符。

required_one_of_attributes[]

VehicleAttributeList

將搜尋範圍限制為每個 VehicleAttributeList 中至少有一個指定屬性的車輛。在每個清單中,車輛必須符合至少一個屬性。這個欄位是每個 VehicleAttributeList 中的包含性析取/OR 運算,以及 VehicleAttributeList 集合中的合取/AND 運算。

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets 提供額外功能。

required_one_of_attributes 類似,required_one_of_attribute_sets 使用的訊息允許清單清單,因此可使用下列運算式:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

將搜尋範圍限制為僅包含 VehicleAttributeList 中所有屬性的車輛。在每個清單中,車輛必須符合所有屬性。這個欄位是每個 VehicleAttributeList 中的連詞/AND 運算,以及整個 VehicleAttributeList 集合中的包含性析取/OR 運算。

order_by

VehicleMatchOrder

必要欄位。指定結果的所需排序條件。

include_back_to_back

bool

這表示單一行程的車輛是否符合這項搜尋條件。只有在未指定 current_trips_present 時,才會使用此欄位。如果未指定 current_trips_present,且這個欄位為 false,則搜尋結果會排除已指派行程的車輛。如果未指定 current_trips_present,且這個欄位為 true,搜尋結果可能會包含有一趟狀態為 ENROUTE_TO_DROPOFF 的有效行程的車輛。指定 current_trips_present 時,這個欄位無法設為 true。

預設值為 false

trip_id

string

指出與這個 SearchVehicleRequest 相關聯的行程。

current_trips_present

CurrentTripsPresent

這表示有進行中行程的車輛是否符合這項搜尋條件。如果 trip_type 包含 SHARED,則必須將此值設為 CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外的值。

filter

string

(選用步驟) 搜尋車輛時要套用的篩選查詢。如需篩選器語法範例,請參閱 http://aip.dev/160

這個欄位旨在取代 required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets 欄位。如果在此指定非空白值,下列欄位必須留空:required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets

這個篩選器會與其他限制 (例如 minimum_capacityvehicle_types) 搭配使用,做為 AND 子句。

請注意,系統僅支援車輛屬性查詢 (例如 attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2>)。篩選器查詢最多可包含 50 項限制。

此外,所有屬性都會儲存為字串,因此唯一支援的屬性比較是字串比較。如要與數字或布林值比較,必須明確加上引號,將值視為字串 (例如 attributes.<key> = "10"attributes.<key> = "true")。

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[]

VehicleMatch

符合 SearchVehiclesRequest 條件的車輛清單,並依 SearchVehiclesRequest.order_by 欄位排序。

SpeedReadingInterval

路徑上連續路段的交通密度指標。假設路徑的點為 P_0、P_1、...、P_N (以零為基準的索引),SpeedReadingInterval 會定義間隔,並使用下列類別說明流量。

欄位
start_polyline_point_index

int32

路徑中這個間隔的起始索引。在 JSON 中,如果索引為 0,欄位會顯示為未填入。

end_polyline_point_index

int32

路徑中這個間隔的結束索引。在 JSON 中,如果索引為 0,欄位會顯示為未填入。

speed

Speed

這個間隔的車流速度。

速度

根據交通流量資料分類折線速度。

列舉
SPEED_UNSPECIFIED 預設值。這個值不會使用。
NORMAL 正常速度,車流暢通。
SLOW 系統偵測到車流減緩,車流中等。
TRAFFIC_JAM 車流堵塞。

StopLocation

停靠站 (上車/下車) 的實際位置。

欄位
point

LatLng

必要欄位。表示實際位置。

timestamp

Timestamp

指出停靠時間。

stop_time
(deprecated)

Timestamp

僅限輸入。已淘汰,使用時間戳記欄位。

TerminalLocation

說明路線控點的位置。

欄位
point

LatLng

表示路線控點的確切 LatLng。必須指定 pointplace 做為輸入內容。如果同時指定這兩項屬性,系統會使用 point 進行路徑設定,並使用 place 做為中繼資料。如果只指定 place 做為輸入,系統會從 place 計算 point,並納入輸出內容。

place

string

代表這個位置的地點資源名稱。格式為 places/{place_id}。必須指定 pointplace 做為輸入內容。如果同時指定這兩項屬性,系統會使用 point 進行路徑設定,並使用 place 做為中繼資料。只有在輸入內容中包含 place 時,輸出內容才會包含 place,也就是說,系統不會從 LatLng 執行 place 查閱。

這是實驗功能。

point_location_source

PointSource

僅供輸出。point 欄位的來源。

terminal_point_id
(deprecated)

TerminalPointId

已淘汰:請改為指定 place 欄位。

access_point_id
(deprecated)

string

已淘汰:請改為指定 place 欄位。

trip_id
(deprecated)

string

已淘汰。

terminal_location_type
(deprecated)

WaypointType

已淘汰:Vehicle.waypoint將擁有這項資料。

PointSource

指出 LatLng 的來源。

列舉
POINT_SOURCE_UNSPECIFIED 未指定點來源。
POINT_SOURCE_DEVELOPER_PROVIDED 開發人員明確提供 LatLng
POINT_SOURCE_CALCULATED_FROM_PLACE LatLng 是根據所提供的地點計算得出。

TerminalPointId

已淘汰:Fleet Engine 不再支援 TerminalPoint。請改用 TerminalLocation.point

欄位
value
(deprecated)

string

已淘汰。

聯集欄位 Id。已淘汰,Id 只能是下列其中一項:
place_id
(deprecated)

string

已淘汰。

generated_id
(deprecated)

string

已淘汰。

TrafficPolylineData

預計車輛行駛路線的路況。

欄位
traffic_rendering

VisualTrafficReportPolylineRendering

以折線顯示顧客行程中某段路程所有區域的交通速度。

行程

行程中繼資料。

欄位
name

string

僅供輸出。格式為「providers/{provider}/trips/{trip}」

vehicle_id

string

執行這趟行程的車輛 ID。

trip_status

TripStatus

行程的目前狀態。

trip_type

TripType

行程類型。

pickup_point

TerminalLocation

顧客指定取貨的地點。

actual_pickup_point

StopLocation

僅限輸入。顧客上車時的實際地點。這個欄位供供應商提供實際取貨資訊的意見回饋。

actual_pickup_arrival_point

StopLocation

僅限輸入。司機抵達上車地點的實際時間和位置。這個欄位供供應商提供取貨地點的實際抵達資訊。

pickup_time

Timestamp

僅供輸出。預估乘客上車時間或實際上車時間。

intermediate_destinations[]

TerminalLocation

行程要求中的中途停靠站 (取貨和送達地點除外)。共乘行程一開始不支援這項功能。

intermediate_destinations_version

Timestamp

指出上次修改 intermediate_destinations 的時間。伺服器應快取這個值,並在更新 intermediate_destination_index 時傳遞至 UpdateTripRequest,確保 intermediate_destinations 不會變更。

intermediate_destination_index

int32

TripStatusENROUTE_TO_INTERMEDIATE_DESTINATION 時,介於 [0..N-1] 之間的數字表示車輛接下來會經過哪個中途目的地。如果 TripStatusARRIVED_AT_INTERMEDIATE_DESTINATION,則為介於 [0..N-1] 之間的數字,表示車輛目前位於哪個中途目的地。這項值由供應商設定。如果沒有 intermediate_destinations,系統就會忽略這個欄位。

actual_intermediate_destination_arrival_points[]

StopLocation

僅限輸入。司機抵達中途目的地的實際時間和地點。供應商可透過這個欄位,針對中途目的地的實際抵達資訊提供意見回饋。

actual_intermediate_destinations[]

StopLocation

僅限輸入。顧客從中途目的地上車的實際時間和地點。這個欄位供供應商提供中途目的地的實際取貨資訊。

dropoff_point

TerminalLocation

顧客指定下車的地點。

actual_dropoff_point

StopLocation

僅限輸入。顧客實際下車的時間和地點。這個欄位供供應商提供實際下車資訊的意見回饋。

dropoff_time

Timestamp

僅供輸出。預估乘客抵達最終目的地的時間,或實際抵達時間。

remaining_waypoints[]

TripWaypoint

僅供輸出。從目前位置到下車地點的完整路徑 (含兩端)。這條路徑可能包含其他行程的路線控點。

vehicle_waypoints[]

TripWaypoint

這個欄位支援手動排序行程的路線控點。其中包含指派車輛的所有剩餘途經點,以及這趟行程的取貨和送達途經點。如果行程尚未指派車輛,Fleet Engine 會忽略這個欄位。基於隱私權考量,這個欄位只會在 UpdateTripCreateTrip 呼叫中由伺服器填入,GetTrip 呼叫則不會。

route[]

LatLng

僅供輸出。這趟行程預計前往 remaining_waypoints 中第一個項目的路線。請注意,第一個中途點可能屬於其他行程。

current_route_segment

string

僅供輸出。下一個途中的編碼路徑。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。目前尚未支援解碼。

current_route_segment_version

Timestamp

僅供輸出。指出路線上次修改的時間。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。

current_route_segment_traffic

ConsumableTrafficPolyline

僅供輸出。顯示 current_route_segment 沿途的路況 (如有)。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。

current_route_segment_traffic_version

Timestamp

僅供輸出。顯示current_route_segment_traffic的最後修改時間。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。

current_route_segment_end_point

TripWaypoint

僅供輸出。current_route_segment 結束的航點。

remaining_distance_meters

Int32Value

僅供輸出。current_route_segment 欄位中的剩餘行車距離。如果行程未指派給車輛,或行程已完成或取消,則值為未指定。

eta_to_first_waypoint

Timestamp

僅供輸出。抵達下一個途中的預計時間 (remaining_waypoints 欄位中的第一個項目)。如果行程未指派給車輛,或行程處於非使用中狀態 (已完成或取消),則值為未指定。

remaining_time_to_first_waypoint

Duration

僅供輸出。從系統傳回行程資料到 Trip.eta_to_first_waypoint 的時間長度。如果行程未指派給車輛,或行程處於非使用中狀態 (已完成或取消),則值為未指定。

remaining_waypoints_version

Timestamp

僅供輸出。表示上次變更 remaining_waypoints 的時間 (新增、移除或變更途中的點)。

remaining_waypoints_route_version

Timestamp

僅供輸出。指出上次修改 remaining_waypoints.path_to_waypointremaining_waypoints.traffic_to_waypoint 的時間。用戶端應用程式應快取這個值,並在 GetTripRequest 中傳遞,確保只有在更新時才傳回 remaining_waypoints 的路徑和流量。

number_of_passengers

int32

不可變更。表示這趟行程的乘客人數,不含司機。車輛必須有可用容量,才能在 SearchVehicles 回應中傳回。

last_location

VehicleLocation

僅供輸出。指出車輛在路線上最後回報的位置。

last_location_snappable

bool

僅供輸出。指出車輛的 last_location 是否可對齊 current_route_segment。如果 last_locationcurrent_route_segment 不存在,則為 False。這項資料由 Fleet Engine 計算。系統會忽略用戶端傳送的任何更新。

view

TripView

系統會填入的 Trip 欄位子集,以及這些欄位的解讀方式。

attributes[]

TripAttribute

自訂行程屬性清單。每個屬性都必須有專屬鍵。

TripAttribute

以鍵/值組合形式說明行程屬性。「鍵:值」字串長度不得超過 256 個字元。

欄位
key

string

屬性的鍵。索引鍵不得包含半形冒號 (:)。

聯集欄位 trip_attribute_value。屬性的值可以是字串、布林值或雙精度浮點數類型。trip_attribute_value 只能是下列其中一項:
string_value

string

字串類型的屬性值。

bool_value

bool

布林值型別屬性值。

number_value

double

雙精度浮點數型別的屬性值。

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

TerminalLocation

這個中途點的位置。

trip_id

string

與這個中途點相關聯的行程。

waypoint_type

WaypointType

這個中途點在行程中扮演的角色,例如取貨或送達。

path_to_waypoint[]

LatLng

從上一個途中的航點到目前航點的路徑。如果是第一個途經點,路徑會從車輛目前位置到途經點。這個欄位只會在要求時填入。

encoded_path_to_waypoint

string

從上一個中途點到目前中途點的編碼路徑。

注意:這個欄位僅供 Driver SDK 和 Consumer SDK 使用。目前尚未支援解碼。

traffic_to_waypoint

ConsumableTrafficPolyline

前往這個中途點的路徑路況。請注意,這項功能僅適用於 Google 地圖平台 Rides and Deliveries Solution 客戶。

distance_meters

Int32Value

從上一個途中的航點到目前航點的路徑距離。如果是第一個中途點,路徑距離是從車輛目前位置到中途點的距離。

eta

Timestamp

抵達這個中途點的預計時間。

duration

Duration

從上一個中途點到這個中途點的旅行時間。如果是第一個中途點,則為車輛目前位置到中途點的行車時間。

UpdateTripRequest

UpdateTrip 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/trips/{trip}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-consumer-project),而發出這項呼叫的服務帳戶是該專案的成員。

trip

Trip

必要欄位。與更新相關聯的行程。

下列欄位由 Fleet Engine 維護。請勿使用 Trip.update 更新這些屬性。

  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_traffic
  • current_route_segment_traffic_version
  • current_route_segment_version
  • dropoff_time
  • eta_to_next_waypoint
  • intermediate_destinations_version
  • last_location
  • name
  • number_of_passengers
  • pickup_time
  • remaining_distance_meters
  • remaining_time_to_first_waypoint
  • remaining_waypoints
  • remaining_waypoints_version
  • route

更新共乘行程的 Trip.vehicle_id 時,必須提供 Trip.vehicle_waypoints 清單,指定剩餘中途站的順序,否則系統將無法判斷順序。

指定 Trip.vehicle_waypoints 時,清單必須包含車輛行程的所有剩餘途經點,不得有額外途經點。你必須依序安排這些中途點,確保在特定行程中,上車地點位於中途目的地之前,且所有中途目的地都位於下車地點之前。EXCLUSIVE 行程的途經地點不得與任何其他行程交錯。系統會使用 trip_idwaypoint_typelocation 欄位,並忽略 vehicle_waypoints 中的所有其他 TripWaypoint 欄位。

為避免多目的地行程發生競爭情況,請在將行程狀態更新為 ENROUTE_TO_INTERMEDIATE_DESTINATION 時提供 Trip.intermediate_destinations_version。傳遞的 Trip.intermediate_destinations_version 必須與 Fleet Engine 的版本一致。如果不是,要求就會失敗。

update_mask

FieldMask

必要欄位。欄位遮罩,指出要更新行程中的哪些欄位。update_mask 至少須包含一個欄位。

UpdateVehicleAttributesRequest

UpdateVehicleAttributes 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/vehicles/{vehicle}。供應商必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

attributes[]

VehicleAttribute

必要欄位。要更新的車輛屬性。未提及的屬性不會變更或移除。

UpdateVehicleAttributesResponse

UpdateVehicleAttributes 回應訊息。

欄位
attributes[]

VehicleAttribute

必要欄位。更新後的完整車輛屬性清單,包括新增、變更和未變更的屬性。

UpdateVehicleRequest

`UpdateVehicle 要求訊息。

欄位
header

RequestHeader

標準 Fleet Engine 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/vehicles/{vehicle}。{provider} 必須是 Google Cloud 專案的專案 ID (例如 sample-cloud-project),而發出這項呼叫的服務帳戶是該專案的成員。

vehicle

Vehicle

必要欄位。要套用的 Vehicle 實體值。更新 Vehicle 時,下列欄位可能無法更新,因為這些欄位是由伺服器管理。

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

如果更新 attributes 欄位,車輛的所有屬性都會替換為要求中提供的屬性。如要僅更新部分屬性,請參閱 UpdateVehicleAttributes 方法。

同樣地,waypoints 欄位可以更新,但必須包含車輛目前的所有航點,不得包含其他航點。

update_mask

FieldMask

必要欄位。欄位遮罩,指出要更新 Vehicle 的哪些欄位。至少須提供一個欄位名稱。

車輛

車輛中繼資料。

欄位
name

string

僅供輸出。這部車輛的專屬名稱。格式為 providers/{provider}/vehicles/{vehicle}

vehicle_state

VehicleState

車輛狀態。

supported_trip_types[]

TripType

這輛車支援的行程類型。

current_trips[]

string

僅供輸出。目前指派給這輛車的行程 trip_id 清單。

last_location

VehicleLocation

車輛最後回報的位置。

past_locations[]

VehicleLocation

僅限輸入。這部車輛過去曾到過,但尚未向 Fleet Engine 回報的位置。這項功能用於 UpdateVehicleRequest,可記錄先前無法傳送至伺服器的位置資訊。通常是因為車輛未連上網際網路。

maximum_capacity

int32

這輛車可搭載的乘客總數。這項值不包含司機。這個值必須大於或等於 1。

attributes[]

VehicleAttribute

車輛屬性清單。車輛最多可有 100 個屬性,且每個屬性都必須有專屬鍵。

vehicle_type

VehicleType

必要欄位。這輛車的類型。可用於篩選 SearchVehicles 結果中的車輛。也會影響預計抵達時間和路線計算。

license_plate

LicensePlate

車輛的車牌資訊。

route[]
(deprecated)

TerminalLocation

已淘汰:請改用 Vehicle.waypoints

current_route_segment

string

折線,指定駕駛人應用程式預計前往下一個途中的路線。系統也會在 Trip.current_route_segment 中傳回這份清單,列出指派給車輛的所有有效行程。

注意:這個欄位僅供 Driver SDK 使用。目前尚未支援解碼。

current_route_segment_traffic

TrafficPolylineData

僅限輸入。Fleet Engine 會使用這項資訊改善行程分享功能。注意:這個欄位僅供 Driver SDK 使用。

current_route_segment_version

Timestamp

僅供輸出。設定 current_route_segment 的時間。用戶端可以儲存這項資訊,並在日後的 GetVehicle 要求中傳遞,避免傳回未變更的路線。

current_route_segment_end_point

TripWaypoint

current_route_segment 結束的航點。駕駛人可以在 UpdateVehicle 呼叫中提供這項資訊,可以是完整行程的途經地點、途經地點 LatLng,也可以是 current_route_segment 的最後一個 LatLng。如果未完整指定,Fleet Engine 會盡量插補至實際中途點。除非也指定 current_route_segment,否則系統會在 UpdateVehicle 呼叫中忽略這個欄位。

remaining_distance_meters

Int32Value

current_route_segment的剩餘行車距離。此外,系統也會在指派給車輛的所有有效行程的 Trip.remaining_distance_meters 中傳回這個值。如果 current_route_segment 欄位為空白,則值未指定。

eta_to_first_waypoint

Timestamp

waypoints 欄位中第一個項目的預計抵達時間。如果 waypoints 欄位或 Vehicle.current_route_segment 欄位為空白,則值為未指定。

更新車輛時,同一要求中的 remaining_time_seconds 會優先於 eta_to_first_waypoint

remaining_time_seconds

Int32Value

僅限輸入。current_route_segment 的剩餘駕駛時間。如果 waypoints 欄位或 Vehicle.current_route_segment 欄位空白,則值為未指定。如果所有當事人使用相同的時鐘,這個值應與 eta_to_first_waypoint - current_time 相符。

更新車輛時,同一要求中的 remaining_time_seconds 會優先於 eta_to_first_waypoint

waypoints[]

TripWaypoint

指派給這輛車的其餘航點。

waypoints_version

Timestamp

僅供輸出。上次更新 waypoints 欄位的時間。用戶端應快取這個值並傳遞至 GetVehicleRequest,確保只有在更新 waypoints 欄位時才會傳回該欄位。

back_to_back_enabled

bool

指出司機是否接受連續行程。如果 trueSearchVehicles 可能會包含目前已指派給行程的車輛。預設值為 false

navigation_status

NavigationStatus

車輛的導航狀態。

device_settings

DeviceSettings

僅限輸入。駕駛人所用行動裝置的設定資訊。

VehicleType

車輛類型。

欄位
category

Category

車輛類型類別

類別

車輛類型類別

列舉
UNKNOWN 預設值,用於未指定或無法辨識的車輛類別。
AUTO 汽車。
TAXI 任何做為計程車的車輛 (通常須取得執照或受管制)。
TRUCK 一般來說,這類車輛的儲物空間較大。
TWO_WHEELER 機車、輕型機踏車或其他雙輪車輛
BICYCLE 以人力為動力的交通工具。
PEDESTRIAN 人類運輸者,通常會步行或跑步,沿著行人路徑移動。

VehicleAttribute

以鍵/值組合形式說明車輛屬性。「鍵:值」字串長度不得超過 256 個字元。

欄位
key

string

屬性的鍵。索引鍵不得包含半形冒號 (:)。

value

string

屬性的值。

聯集欄位 vehicle_attribute_value。屬性的值可以是字串、布林值或雙精度浮點數類型。vehicle_attribute_value 只能是下列其中一項:
string_value

string

字串類型的屬性值。

注意:這與 value 欄位相同,但後者最終會遭到淘汰。如要使用建立或更新方法,可以使用任一欄位,但強烈建議使用 string_value。如果同時設定 string_valuevalue,兩者必須相同,否則會擲回錯誤。這兩個欄位都會填入回應。

bool_value

bool

布林值型別屬性值。

number_value

double

雙精度浮點數型別的屬性值。

VehicleAttributeList

車輛屬性的清單清單資料類型。

欄位
attributes[]

VehicleAttribute

這個集合中的屬性清單。

VehicleLocation

車輛在特定時間點的位置、速度和航向。

欄位
location

LatLng

車輛位置。傳送至 Fleet Engine 的車輛位置是 GPS 位置。當您在回覆中收到這項資訊時,車輛位置可能是 GPS 位置、輔助位置或其他預估位置。來源是在 location_sensor 中指定。

horizontal_accuracy
(deprecated)

DoubleValue

已淘汰:請改用 latlng_accuracy

latlng_accuracy

DoubleValue

準確度為 location 公尺 (半徑)。

heading

Int32Value

車輛行進方向 (以角度表示)。0 代表北方。有效範圍為 [0,360)。

bearing_accuracy
(deprecated)

DoubleValue

已淘汰:請改用 heading_accuracy

heading_accuracy

DoubleValue

準確度為 heading 度。

altitude

DoubleValue

以高於 WGS84 的公尺數表示。

vertical_accuracy
(deprecated)

DoubleValue

已淘汰:請改用 altitude_accuracy

altitude_accuracy

DoubleValue

準確度為 altitude 公尺。

speed_kmph
(deprecated)

Int32Value

車輛速度 (以公里/小時為單位)。已淘汰:請改用 speed

speed

DoubleValue

車輛速度 (以公尺/秒為單位)

speed_accuracy

DoubleValue

準確度,單位為公尺/秒。speed

update_time

Timestamp

感應器回報 location 的時間 (以感應器的時鐘為準)。

server_time

Timestamp

僅供輸出。伺服器收到位置資訊的時間。

location_sensor

LocationSensor

位置資料供應商 (例如 GPS)。

is_road_snapped

BoolValue

location 是否已對齊道路。

is_gps_sensor_enabled

BoolValue

僅限輸入。指出行動裝置是否已啟用 GPS 感應器。

time_since_update

Int32Value

僅限輸入。自這個位置資訊首次傳送至伺服器以來經過的時間 (以秒為單位)。第一次更新時,這個值會是零。如果時間不明 (例如應用程式重新啟動時),這個值會重設為零。

num_stale_updates
(deprecated)

Int32Value

僅限輸入。已淘汰:現在會使用其他信號判斷位置資訊是否過時。

raw_location

LatLng

車輛原始位置 (未經道路吸附處理)。

raw_location_time

Timestamp

與原始位置資訊相關聯的時間戳記。

raw_location_sensor

LocationSensor

原始位置的來源。預設值為 GPS

raw_location_accuracy

DoubleValue

以公尺為單位的半徑 raw_location 精確度。

flp_location

LatLng

Android 整合式位置預測提供工具提供的位置資訊。

flp_update_time

Timestamp

更新 flp_location 的時間戳記

flp_latlng_accuracy_meters

DoubleValue

準確度為 flp_location 公尺 (半徑)。

flp_heading_degrees

Int32Value

車輛的移動方向 (以度為單位),由 Fused Location Provider 判斷。0 代表北方。有效範圍為 [0,360)。

supplemental_location

LatLng

整合應用程式提供的補充位置資訊。

supplemental_location_time

Timestamp

與補充地點相關聯的時間戳記。

supplemental_location_sensor

LocationSensor

補充位置資訊的來源。預設值為 CUSTOMER_SUPPLIED_LOCATION

supplemental_location_accuracy

DoubleValue

以公尺為單位的半徑 supplemental_location 精確度。

road_snapped
(deprecated)

bool

已淘汰:請改用 is_road_snapped

VehicleMatch

包含車輛和相關預估值,這些預估值與車輛 SearchVehiclesRequest 的有效行程點相符。

欄位
vehicle

Vehicle

必要欄位。符合要求的車輛。

vehicle_pickup_eta

Timestamp

車輛抵達要求中指定取貨點的預計時間。如果值為空白,表示系統無法計算車輛的預計抵達時間。如果 SearchVehiclesRequest.include_back_to_backtrue,且車輛有進行中的行程,vehicle_pickup_eta 會包含完成目前行程所需的時間。

vehicle_pickup_distance_meters

Int32Value

車輛目前位置與要求中指定的上車地點之間的距離,包括現有行程的任何中途上車或下車地點。這段距離包含計算出的行車 (路線) 距離,以及導航終點與要求的上車地點之間的直線距離。(導航終點與要求的上車地點之間的距離通常很短)。如果值為空白,表示計算距離時發生錯誤。

vehicle_pickup_straight_line_distance_meters

Int32Value

必要欄位。車輛與要求中指定上車地點之間的直線距離。

vehicle_dropoff_eta

Timestamp

車輛抵達要求中指定卸貨地點的完整預計時間。預計抵達時間包括在要求中指定的 dropoff_point 之前,停靠任何路線控點的時間。只有在要求中指定下車地點時,系統才會填入值。如果值為空白,表示系統在計算預計抵達時間時發生錯誤。

vehicle_pickup_to_dropoff_distance_meters

Int32Value

車輛從要求中指定的取貨地點到下車地點的行車距離 (以公尺為單位)。這項距離僅指兩點之間的距離,不包括車輛位置或車輛必須先前往的任何其他地點,才能抵達取貨點或送達點。只有在要求中指定 dropoff_point 時,系統才會填入值。如果值為空白,表示系統無法計算要求中指定的取貨地點到送達地點的距離。

trip_type

TripType

必要欄位。用來計算上車地點預計抵達時間的要求行程類型。

vehicle_trips_waypoints[]

Waypoint

用來計算預計抵達時間的航點排序清單。清單包括車輛位置、車輛有效行程的取貨點,以及要求中提供的取貨點。空清單表示無法計算車輛的預計抵達時間。

vehicle_match_type

VehicleMatchType

車輛比對類型。

requested_ordered_by

VehicleMatchOrder

要求排序相符車輛的順序。等同於 ordered_by

ordered_by

VehicleMatchOrder

要求排序相符車輛的順序。等同於 requested_ordered_by

VehicleMatchType

車輛比對類型。

列舉
UNKNOWN 不明的車輛比對類型
EXCLUSIVE 車輛目前沒有已指派的行程,可以前往上車地點。
BACK_TO_BACK 車輛目前已指派給行程,但完成進行中的行程後,即可前往上車地點。系統會根據現有行程計算預計抵達時間和距離。
CARPOOL 車輛有足夠空間可供共乘。
CARPOOL_BACK_TO_BACK 車輛會先完成目前行程,再前往上車地點。系統會根據現有行程計算預計抵達時間和距離。

VehicleState

Vehicle 的狀態。

列舉
UNKNOWN_VEHICLE_STATE 預設值,用於未指定或無法辨識的車輛狀態。
OFFLINE 車輛不接受新的行程。注意:車輛可能會繼續以這種狀態行駛,完成指派的行程。
ONLINE 車輛接受新行程。

VisualTrafficReportPolylineRendering

說明用戶應如何沿著路線為折線的一部分著色。

欄位
road_stretch[]

RoadStretch

(選用步驟) 應沿著折線算繪的道路路段。路段保證不會重疊,也不一定會涵蓋整條路線。

如果沒有要套用樣式的路段,用戶端應為路線套用預設樣式。

RoadStretch

應算繪的一段道路。

欄位
style

Style

必要欄位。要套用的樣式。

offset_meters

int32

必要欄位。樣式應套用在 [offset_meters, offset_meters + length_meters) 之間。

length_meters

int32

必要欄位。要套用樣式的路徑長度。

樣式

路況樣式,表示車流速度。

列舉
STYLE_UNSPECIFIED 未選取任何樣式。
SLOWER_TRAFFIC 交通越來越壅塞。
TRAFFIC_JAM 發生交通壅塞。

途經點

說明 SearchVehiclesResponseVehicleMatch 的路線沿途中間點。在所有其他端點中,這個概念都以 TripWaypoint 表示。

欄位
lat_lng

LatLng

這個中途點的位置。

eta

Timestamp

車輛抵達這個中途點的預估時間。

WaypointType

航點類型。

列舉
UNKNOWN_WAYPOINT_TYPE 不明或未指定的中途點類型。
PICKUP_WAYPOINT_TYPE 接送乘客或物品的中途點。
DROP_OFF_WAYPOINT_TYPE 乘客或物品的下車地點。
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE 多目的地行程的中途目的地路線控點。