Method: providers.trips.search

特定の車両のすべてのルートを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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) 以降に更新されていないルートを返します。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

レスポンスの本文

trips.search のレスポンス メッセージを返します。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
フィールド
trips[]

object (Trip)

リクエストされた車両のルートのリスト。
nextPageToken

string

このトークンを SearchTripsRequest で渡して、リストの結果を表示します。API は呼び出しのたびにルートリストを返し、それ以上の結果がなくなると、ルートリストは空になります。