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 が最後に変更された時刻を示します。intermediateDestinations が変更されないように、intermediateDestinationIndex を更新する際は、サーバーがこの値をキャッシュに保存し、UpdateTripRequest に渡す必要があります。

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

intermediateDestinationIndex

integer

TripStatusENROUTE_TO_INTERMEDIATE_DESTINATION の場合は、[0..N-1] の数値で、次に通過する中間目的地を示します。TripStatusARRIVED_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)

出力のみ。このルートで最初に残るウェイポイントの最初の入口までの予想ルート。最初の地点は別のルートに属している可能性があります。

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

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)

入力されるルート フィールドのサブセットと、その解釈方法。

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 レスポンスに含まれるさまざまな Trip フィールド セットのセレクタ。詳しくは AIP-157 をご覧ください。ビューが追加される可能性があります。

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

Methods

create

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

get

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

update

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