Package maps.fleetengine.v1

索引

TripService

行程管理服務。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

在車隊引擎中建立行程,並傳回新行程。

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

所有其他欄位均為選填欄位,如有提供。

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 正規化表單 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

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

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

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

current_route_segment_version

Timestamp

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

remaining_waypoints_version

Timestamp

表示擷取 Trip.remaining_waypoints 時的最低時間戳記 (不含)。如果自此時間戳記以來未變更,回應中就不會設定 remaining_waypoints。如果未指定這個欄位,系統一律會擷取 remaining_waypoints

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 欄位必須留空。

這個篩選函式可做為 AND 子句,但具有其他限制條件,例如 vehicle_stateon_trip_only

請注意,系統僅支援車輛屬性查詢 (例如 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 輔助 GPS、基地台 ID 或 WiFi 存取點。
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 傳送位置更新的車輛。即使一般車輛仍在傳輸位置資訊,也不算過時。如未設定這個欄位,伺服器會使用 5 分鐘做為預設值。

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 等點 (以 0 為基底的索引),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

必要欄位。表示行程路線控點的位置。

terminal_point_id
(deprecated)

TerminalPointId

已淘汰:改為指定 point 欄位。

access_point_id
(deprecated)

string

已淘汰:改為指定 point 欄位。

trip_id
(deprecated)

string

已淘汰。

terminal_location_type
(deprecated)

WaypointType

已淘汰:「Vehicle.waypoint」會使用這項資料。

TerminalPointId

已淘汰:Fleet Engine 不再支援 TerminalPoints。請改用 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

僅供輸出。這趟行程的預期路徑,可前往 back_waypoints 中第一個項目。請注意,第一個路線點可能屬於不同的行程。

current_route_segment

string

僅供輸出。下一個路標的經過編碼的路徑。

注意:這個欄位僅供驅動程式 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 的時間。

注意:這個欄位僅供驅動程式 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」。由車隊引擎計算。系統會忽略來自用戶端的任何更新。

view

TripView

要填入的 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 回應中不同行程欄位組合的選取器。請參閱 AIP-157 瞭解相關背景資訊。可能會增加額外的觀看次數。

列舉
TRIP_VIEW_UNSPECIFIED 預設值。為了回溯相容,API 會預設為 SDK 檢視畫面。為確保穩定性和支援,建議客戶選擇 SDK 以外的 TripView
SDK 包含可能無法透過公開可用的程式庫解釋或支援的欄位。
JOURNEY_SHARING_V1S 系統會針對「旅程分享」用途填入行程欄位。這個檢視畫面適用於伺服器對伺服器通訊。

TripWaypoint

說明車輛路線上的停靠點,或車輛行程的終點。

欄位
location

TerminalLocation

此航點的位置。

trip_id

string

與這個路線控點相關聯的行程。

waypoint_type

WaypointType

這個路線控點在這趟行程中扮演的角色,例如上車或下車。

path_to_waypoint[]

LatLng

從上一個路線控點到目前路線點的路徑。清單中的第一個路線點為未定義。只有在使用者提出要求時,系統才會填入這個欄位。

encoded_path_to_waypoint

string

從上一個路標到目前路標的經過編碼的路徑。

注意:這個欄位僅供驅動程式 SDK 和 Consumer SDK 使用。目前不支援解碼。

traffic_to_waypoint

ConsumableTrafficPolyline

前往此路線的路況。請注意,只有 Google 地圖平台乘車和配送服務解決方案客戶才能查詢路況。

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

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

下列欄位由車隊引擎維護。請勿使用 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

「更新車輛要求訊息。

欄位
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

車輛上次回報的位置。

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 中傳回。

注意:這個欄位僅供驅動程式 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

以鍵/值組合描述車輛屬性。「key:value」字串的長度不得超過 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 半徑的準確度,以公尺為單位。

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

VehicleMatchOrder

這輛車的實際訂單。通常這麼做會符合要求的「order_by」欄位,但在特定情況下 (例如內部伺服器錯誤) 可使用其他方法 (例如 PICKUP_POINT_STRAIGHT_DISTANCE)。

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 多目的地行程的中繼目的地路線控點。