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"

回應主體

Trip.search 回應訊息。

如果成功,回應主體即會包含具有以下結構的資料:

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

object (Trip)

要求車輛的行程清單。

nextPageToken

string

在 SearchTripsRequest 中傳遞這個權杖,以便分頁清單結果。API 會在每次呼叫中傳回行程清單,而如果行程清單已無其他結果,就會是空白的。