Package maps.fleetengine.v1

索引

TripService

行程管理服務。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

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

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)

從機群引擎傳回車輛。

ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

傳回與要求選項符合的供應商相關聯之分頁式分頁清單。

SearchFuzzedVehicles

rpc SearchFuzzedVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

已淘汰:請改用 SearchVehicles

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 中的欄位,並移除要求中未提及的屬性。

UpdateVehicleLocation

rpc UpdateVehicleLocation(UpdateVehicleLocationRequest) returns (VehicleLocation)

已淘汰:請改用 UpdateVehicle 方法。更新車輛位置 會更新車輛位置。

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 正規化表單 C 進行正規化處理。
  • 不得包含以下任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
trip

Trip

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

建立行程時,必填欄位如下:

  • trip_type
  • pickup_point

如果您提供下列欄位,可以使用這些欄位:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

系統會忽略所有其他行程欄位。舉例來說,所有行程的開頭都是 NEWtrip_status,即使您在建立要求中傳入 CANCELEDtrip_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

應傳回的行程欄位子集及其解讀結果。

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 個必要屬性。這與車輛可用的屬性數量上限相符。每個重複字串都應採用「key:value」格式。

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_attributes」、「required_one_of_attributes」和「required_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 未定義 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 位置資訊功能不會關閉,但位置管理工具會在裝置非互動時,限制向供應商發出的所有要求。

LocationSensor

用於判斷位置的感應器或方法。

列舉
UNKNOWN_SENSOR 未指定或不明感應器。
GPS GPS 或輔助 GPS。
NETWORK GPS、行動通信基地台 ID 或 Wi-Fi 存取點。
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 作業系統上的位置提供者。

車輛的導航狀態。

列舉
UNKNOWN_NAVIGATION_STATUS 未指定的導航狀態。
NO_GUIDANCE 駕駛應用程式的導覽功能處於 FREE_NAV 模式。
ENROUTE_TO_DESTINATION 提供即時路線導航功能,駕駛應用程式導覽功能已進入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 (例如工作階段 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

Android 裝置透過呼叫 SDK 的製造商,僅適用於 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 為驅動程式。
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 到 10,000 公尺之間 (含)。

count

int32

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

minimum_capacity

int32

必要欄位。指定行程考量的乘客人數。這個值必須大於或等於 1。駕駛人不會計入容量值。

trip_types[]

TripType

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

maximum_staleness

Duration

將搜尋範圍限制在指定時間內,已將位置更新傳送至 Fleet Engine 的車輛。固定式車輛仍會傳輸地點,不視為已過時。如未設定這個欄位,伺服器會使用五分鐘做為預設值。

vehicle_types[]

VehicleType

必要欄位。將搜尋範圍限制在包含其中一個指定類型的車輛。至少須指定一種交通工具類型。不允許類別為「UNKNOWN」的交通工具類型。

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_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_attributes」、「required_one_of_attributes」和「required_one_of_attributes_sets」欄位。如果在這裡指定非空白值,則下列欄位必須留空:required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets

這個篩選器以 AND 子句的形式運作,搭配其他限制,例如 minimum_capacityvehicle_types

請注意,只有車輛屬性 (例如 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

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

terminal_point_id

TerminalPointId

終點的 ID。

access_point_id
(deprecated)

string

已淘汰。

trip_id
(deprecated)

string

已淘汰。

terminal_location_type
(deprecated)

WaypointType

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

TerminalPointId

用於識別終端點。

欄位
value

string

終端點的專屬 ID。

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

這個欄位支援手動排序行程的路線控點。其中包含了指定車輛的所有其餘路線點,以及該行程的上車和下車路線點。如果行程尚未指派給車輛,機群引擎會忽略這個欄位。基於隱私考量,只有 UpdateTripCreateTrip 呼叫的伺服器會填入這個欄位,而「不是」在 GetTrip 呼叫中會填入。

route[]

LatLng

僅供輸出。這趟行程前往 other_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

已填入的行程欄位子集以及解讀方式。

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 系統已針對 Journey Share 用途填入行程欄位。此檢視適用於伺服器對伺服器通訊,

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 地圖平台叫車和運送服務解決方案客戶能查看流量。

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

必要欄位。更新後的車輛屬性完整清單,包括全新、修改及未變更的屬性。

UpdateVehicleLocationRequest

UpdateVehicleLocation 要求訊息。

欄位
header

RequestHeader

標準的 Fleet Engine 要求標頭。

name

string

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

current_location

VehicleLocation

必要欄位。車輛的最新位置。locationupdate_time 為必填欄位。

current_state

VehicleState

將車輛狀態設為 ONLINEOFFLINE。如果設為 UNKNOWN_VEHICLE_STATE,車輛的狀態將會維持不變。

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

上次回報車輛位置。

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 會利用這項資訊改善分享歷程。注意:這個欄位僅適用於驅動程式 SDK。

current_route_segment_version

Timestamp

僅供輸出。設定 current_route_segment 的時間。這個引數可由用戶端儲存,並在日後的 GetVehicle 要求中傳遞,以免傳回未變更的路徑。

current_route_segment_end_point

TripWaypoint

current_route_segment 結束的路線點。這可以是 UpdateVehicle 呼叫上的駕駛人,可以是完整行程路線控點、路線控點 LatLngcurrent_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

僅限輸入。距離這個位置首次傳送至伺服器的時間 (以秒為單位)。首次更新時,此值會為 0。如果時間不明 (例如應用程式重新啟動),這個值會重設為零。

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