Method: providers.trips.search

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

HTTP 要求

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/trips:search

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。格式必須為 providers/{provider}。提供者必須是發出此呼叫的服務帳戶所屬 Google Cloud 專案的專案 ID (例如 sample-cloud-project)。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "header": {
    object (RequestHeader)
  },
  "vehicleId": string,
  "activeTripsOnly": boolean,
  "pageSize": integer,
  "pageToken": string,
  "minimumStaleness": string
}
欄位
header

object (RequestHeader)

標準 Fleet Engine 要求標頭。
vehicleId

string

與請求中行程相關聯的車輛。如果未指定，傳回的行程不包含：

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
activeTripsOnly

boolean

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

integer

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

string

將這個值設為先前在 SearchTripsResponse 中傳回的值，以便從先前的結果繼續執行。
minimumStaleness

string (Duration format)

如果指定的話，系統會傳回 (current - minimumStaleness) 時間之後尚未更新的行程。

持續時間以秒為單位，最多 9 個小數位數，結尾為「s」。例如："3.5s"。

回應主體

route.search 回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
欄位
trips[]

object (Trip)

所要求車輛的行程清單。
nextPageToken

string

在 SearchTripsRequest 中傳遞這個符記，即可逐頁瀏覽清單結果。API 會在每次呼叫傳回行程清單，當行程清單未繼續時，就會傳回空白清單。