REST Resource: providers.trips

リソース: Trip

ルートのメタデータ。

JSON 表現 
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
フィールド
name

string

出力専用。形式は「providers/{provider}/trips/{trip}」です。
vehicleId

string

このルートを運行する車両の ID。
tripStatus

enum (TripStatus)

ルートの現在のステータス。
tripType

enum (TripType)

ルートのタイプ。
pickupPoint

object (TerminalLocation)

お客様が集荷すると示している場所。
actualPickupPoint

object (StopLocation)

入力のみのお客様が実際にピックアップされた場所と時間。このフィールドは、実際の集荷情報に関するフィードバックをプロバイダが提供するものです。
actualPickupArrivalPoint

object (StopLocation)

入力のみのドライバーが集合場所に到着した実際の時刻と場所。このフィールドは、乗車地点での実際の到着情報についてプロバイダがフィードバックを提供するためのものです。
pickupTime

string (Timestamp format)

出力専用。乗客が乗車する推定時刻、または乗車時刻の実際の時刻のいずれかを指定します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
intermediateDestinations[]

object (TerminalLocation)

ルートで（乗車と降車に加えて）中間地点の停車地。当初は、共有ルートではサポートされません。
intermediateDestinationsVersion

string (Timestamp format)

intermediateDestinations が最後に変更された日時を示します。サーバーは、この値をキャッシュに保存し、intermediateDestinationIndex の更新時に UpdateTripRequest で渡して、intermediateDestinations が変更されないようにする必要があります。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
intermediateDestinationIndex

integer

TripStatus が ENROUTE_TO_INTERMEDIATE_DESTINATION の場合、車両が次に通過する中間目的地を示す [0..N-1] の数値。TripStatus が ARRIVED_AT_INTERMEDIATE_DESTINATION の場合、車両が現在位置している中間目的地を示す [0..N-1] の数値。この値はプロバイダによって設定されます。intermediateDestinations がない場合、このフィールドは無視されます。
actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

入力のみのドライバーが中間地点に到着した実際の時刻と場所。このフィールドは、中間地点の実際の到着情報に関するフィードバックを提供するために使用します。
actualIntermediateDestinations[]

object (StopLocation)

入力のみの顧客が中間地点で乗車した実際の時刻と場所。このフィールドは、中間地点での実際の集荷情報について、運送業者がフィードバックを提供するものです。
dropoffPoint

object (TerminalLocation)

お客様が降車すると示されている場所。
actualDropoffPoint

object (StopLocation)

入力のみのお客様を降ろした実際の時間と場所。このフィールドは、プロバイダが実際の降車情報に関するフィードバックを提供するものです。
dropoffTime

string (Timestamp format)

出力専用。乗客が最終目的地で降車される推定時刻、または実際に降車される時刻のいずれか。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
remainingWaypoints[]

object (TripWaypoint)

出力専用。現在地から降車地点までのフルパス。この経路には、他のルートのウェイポイントが含まれている場合があります。
vehicleWaypoints[]

object (TripWaypoint)

このフィールドでは、ルートの経由地を手動で並べ替えることができます。割り当てられた車両の残りのウェイポイントと、このルートの乗車と降車のウェイポイントがすべて含まれています。ルート車両が割り当てられていない場合、このフィールドは無視されます。プライバシー上の理由から、このフィールドは trips.update 呼び出しと trips.create 呼び出しでのみサーバーによって設定され、trips.get 呼び出しでは設定されません。
route[]

object (LatLng)

出力専用。このルートで、残りの Waypoint の最初の通過地点までの予想ルート。最初のウェイポイントは別のルートに属している場合があります。
currentRouteSegment

string

出力専用。次のウェイポイントへのエンコードされたパス。

注: このフィールドは、Driver SDK と Consumer SDK でのみ使用することを目的としています。デコードはまだサポートされていません。
currentRouteSegmentVersion

string (Timestamp format)

出力専用。ルートが最後に変更された日時を示します。

注: このフィールドは、Driver SDK と Consumer SDK による使用のみを目的としています。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

出力専用。currentRouteSegment 沿いの交通状況（利用可能な場合）を示します。

注: このフィールドは、Driver SDK と Consumer SDK による使用のみを目的としています。
currentRouteSegmentTrafficVersion

string (Timestamp format)

出力専用。currentRouteSegmentTraffic が最後に変更された時刻を示します。

注: このフィールドは、Driver SDK と Consumer SDK による使用のみを目的としています。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
currentRouteSegmentEndPoint

object (TripWaypoint)

出力専用。currentRouteSegment の終点となる地点。
remainingDistanceMeters

integer

出力専用。currentRouteSegment フィールドの残りの走行距離。ルートが車両に割り当てられていない場合、ルートが完了またはキャンセルされた場合、値は指定されません。
etaToFirstWaypoint

string (Timestamp format)

出力専用。次のウェイポイントまでの所要時間（remainingWaypoints フィールドの最初のエントリ）。ルートが無効（完了またはキャンセル済み）の場合、またはルートが無効（完了またはキャンセル済み）の場合、値は指定されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
remainingTimeToFirstWaypoint

string (Duration format)

出力専用。ルートデータが返されたときから Trip.eta_to_first_waypoint の時間までの経過時間。ルートが無効（完了またはキャンセル済み）の場合、またはルートが無効（完了またはキャンセル済み）の場合、値は指定されません。

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

string (Timestamp format)

出力専用。remainingWaypoints が最後に変更された日時（ウェイポイントが追加、削除、変更された日時）を示します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
remainingWaypointsRouteVersion

string (Timestamp format)

出力専用。remainingWaypoints.path_to_waypoint と remainingWaypoints.traffic_to_waypoint が最後に変更された時刻を示します。クライアント アプリは、この値をキャッシュに保存し、GetTripRequest で渡して、remainingWaypoints のパスとトラフィックが更新された場合にのみ返されるようにする必要があります。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
numberOfPassengers

integer

変更不可。このルートの乗客数を示します。ドライバーは含まれません。vehicles.search レスポンスで返される車両には、空き容量が必要です。
lastLocation

object (VehicleLocation)

出力専用。経路上の車両の最終報告位置を示します。
lastLocationSnappable

boolean

出力専用。車両の lastLocation を currentRouteSegment にスナップできるかどうかを示します。lastLocation または currentRouteSegment が存在しない場合は false。Fleet Engine によって計算されます。クライアントからの更新は無視されます。
view

enum (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 ドライバー、乗客、またはライドシェア プロバイダによって乗車前にキャンセルされた。

StopLocation

停車地（乗車または降車）が行われた実際の場所。

JSON 表現 
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
フィールド
point

object (LatLng)

必須。実際の場所を示します。
timestamp

string (Timestamp format)

停止が発生した日時を示します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
stopTime
(deprecated)

string (Timestamp format)

入力のみの非推奨です。タイムスタンプ フィールドを使用します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

TripView

trips.get レスポンスのさまざまなルート フィールドのセレクタ。コンテキストについては AIP-157 をご覧ください。今後、ビューが追加される可能性はあります。

列挙型
TRIP_VIEW_UNSPECIFIED デフォルト値。下位互換性を確保するため、API はデフォルトで SDK ビューになります。安定性とサポートを確保するため、SDK 以外の TripView を選択することをおすすめします。
SDK 一般公開されているライブラリでは解釈できない、またはサポートできないフィールドが含まれます。
JOURNEY_SHARING_V1S [ルート] フィールドには、移動経路の共有ユースケースでデータが入力されます。このビューはサーバー間通信を目的としています。

メソッド

create

 Fleet Engine でルートを作成し、新しいルートを返します。

get

 1 回のルートに関する情報を取得します。
特定の車両のすべてのルートを取得します。

update

 ルートデータを更新します。