GTFS realtimeリファレンス¶
GTFSGTFS realtimeフィードを使用すると、交通事業者は、サービスへの混乱 (駅の閉鎖、路線の運行停止、重大な遅延など)、車両の位置、到着予定時刻に関するリアルタイム情報を消費者に提供できます。
フィード仕様のバージョン 2.0 については、このサイトで説明され、ドキュメント化されています。有効なバージョンは2.0
、1.0
です。
用語の定義¶
必須¶
GTFS リアルタイム v2.0 以降では、必須 列は、交通事業者データが有効で、使用するアプリケーションにとって意味をなすためにプロデューサーが提供するしなければならないフィールドを示します。
必須 フィールドでは次の値が使用されます:
- 必須: このフィールドは、GTFS リアルタイム フィード プロデューサーが提供するしなければならない。
- 条件付きで必須: このフィールドは、フィールド 説明 で概説されている特定の条件下では必須です。これらの条件以外では、フィールドは任意です。
- 任意: このフィールドは任意であり、プロデューサーが実装する必須はありません。ただし、基礎となる自動車両位置システム(例: VehiclePosition
timestamp
)でデータが利用可能な場合は、可能であればプロデューサーがこれらの任意フィールドを提供することが推奨 セマンティック要件は GTFS リアルタイム バージョン 1.0 では定義されていないため、gtfs_realtime_version
が1
のフィードはこれらの要件を満たさないしてもよいがあることに注意してください(詳細については、セマンティック要件の提案を参照してください)。
カーディナリティ¶
- カーディナリティ*は、特定のフィールドに提供してもよい要素の数を表し、次の値を持ちます。
- 1- このフィールドには 1つの要素を指定してもよい。これは、プロトコル バッファの 必須 および 任意 基数 にマップされます。
- 多数- このフィールドには多数の要素 (0、1、またはそれ以上) を指定してもよい。これは、プロトコル バッファの 繰り返し 基数 にマップされます。
フィールドが必須、条件付きで必須、または任意 であるかどうかを確認するには、常に 必須 フィールドと 説明 フィールドを参照してください。プロトコル バッファのカーディナリティについては、gtfs-realtime.proto
を参照してください。
プロトコル バッファのデータ型¶
フィード要素の記述には、次のプロトコル バッファのデータ型が使用されます:
- message: 複合型
- enum: 固定値のリスト
試験的なフィールド試験的というラベルの付いたフィールドは変更される可能性があり、まだ正式に仕様に採用されていません。実験的フィールドは、将来正式に採用されるしてもよい。¶
要素インデックス¶
要素¶
message FeedMessage¶
フィードmessageの内容。ストリーム内の各messageは、適切な HTTP GET リクエストへの応答として取得されます。リアルタイム フィードは常に、既存の GTFS フィードとの関連で定義されます。すべてのエンティティ ID は、GTFS フィードを基準にして解決されます。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
header | FeedHeader | 必須 | 1つ | このフィードとフィードmessageに関するメタデータ。 |
entity | FeedEntity | 条件付きで必須 | 複数 | フィードの内容。交通システムに関するリアルタイム情報がある場合は、このフィールドを指定するしなければならない。このフィールドが空の場合、ユーザーはシステムに関するリアルタイム情報がないものと想定するするべきである。 |
message FeedHeader¶
フィード メッセージに含まれる、フィードに関するメタデータ。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
gtfs_realtime_version | string | 必須 | 1つ | フィード仕様のバージョン。現在のバージョンは 2.0 です。 |
incrementality | Incrementality | 必須 | 1 | |
timestamp | uint64 | 必須 | 1 | このタイムスタンプは、このフィードの内容が作成された瞬間を識別します (サーバー時間)。POSIX 時間 (つまり、1970年1月1日 00:00:00UTC からの秒数)。リアルタイム情報を生成するシステムと消費するシステム間の時間のずれを回避するには、タイム サーバーからタイムスタンプを取得することを強くお勧めします。数秒までの時間差は許容されるため、Stratum 3 またはそれより低い Strata サーバーを使用することはまったく問題ありません。 |
feed_version | string | 任意 | 1 つ | リアルタイム データのベースとなる GTFS フィードの feed_info.feed_version に一致する文字列。ユーザーはこれを使用して、現在アクティブな GTFS フィードや、ダウンロード可能な新しいフィードを識別できます。 |
enum Incrementality¶
現在のフェッチが増分かどうかを決定します。
- FULL_DATASET: このフィード更新により、フィードの以前のすべてのリアルタイム情報が上書きされます。したがって、このアップデートでは、既知のすべてのリアルタイム情報の完全なスナップショットが提供される予定です。
- DIFFERENTIAL: 現在、このモードはサポートされていません。このモードを使用するフィードの動作は未指定です。GTFS realtimeメーリング リストで、DIFFERENTIAL モードの動作を完全に指定することについて議論されており、その議論が完了した時点でドキュメントが更新されます。
値
値 |
---|
FULL_DATASET |
DIFFERENTIAL |
message FeedEntity¶
交通フィード内のエンティティの定義 (または更新)。エンティティが削除されない場合は、trip_update
、vehicle
、alert
、shape
、stop
、または trip_modification
か1つを入力する必要があります。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
id | string | 必須 | 1つ | このエンティティのフィード固有の識別子。ID はIncrementalityサポートを提供するためだけに使用されます。フィードによって参照される実際のエンティティは、明示的なセレクターによって指定するしなければならない(詳細については、以下のEntitySelector を参照してください)。 |
is_deleted | bool | 任意 | 1つ | このエンティティを削除するかどうか。Incrementalityが DIFFERENTIAL のフィードに対してのみ指定する必要がするべきである。このフィールドは、Incrementalityが FULL_DATASET のフィードには指定するべきではない。 |
trip_update | TripUpdate | 条件付きで必須 | 1つ | 便の出発遅延に関するリアルタイムのデータ。trip_update、vehicle、alert、または shape のフィールドのうち少なくとも 1つを指定するしなければならない。これらのフィールドすべてを空にすることはできません。 |
vehicle | VehiclePosition | 条件付きで必須 | 1つ | 車両のリアルタイムのPositionに関するデータ。trip_update、vehicle、alert、または shape のフィールドのうち少なくとも 1つを指定するしなければならない。これらのフィールドすべてを空にすることはできません。 |
alert | アラート | 条件付きで必須 | 1つ | リアルタイム アラートに関するデータ。trip_update、vehicle、alert、shape のフィールドのうち少なくとも 1つを指定するしなければならない。これらのフィールドすべてを空にすることはできません。 |
shape | 形状 | 条件付きで必須 | 1つ | 迂回路などのリアルタイムで追加されたルート形状に関するデータ。trip_update、vehicle、alert、shape のフィールドのうち少なくとも 1つを指定するしなければならない。これらのフィールドすべてを空にすることはできません。 注意: このフィールドはまだ試験的であり、変更される可能性があります。将来、正式に採用されるしてもよいがあります。 |
stop | Stop | 条件付きで必須 | 1つ | 新しい停留所がフィードに動的に追加されました。 注意:このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
trip_modifications | TripModifications | 条件付きで必須 | 1つ | 迂回などの特定の変更によって影響を受ける旅行のリスト。 注意:このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
message TripUpdate¶
便中の車両の進行状況に関するリアルタイム更新。便更新エンティティ の一般的な説明も参照してください。
ScheduleRelationship の値に応じて、TripUpdate では以下を指定できます。
- スケジュールに沿って進む便。
- ルートに沿って進むが、スケジュールは固定されていない便。
- スケジュールに関して追加または削除された便。
- 静的 GTFS の既存の便のコピーである新しい便。TripProperties で指定されたサービス日時で実行されます。
更新は、将来の予測到着/出発イベント、またはすでに発生した過去のイベントに対して行うことができます。ほとんどの場合、過去のイベントに関する情報は測定値であるため、その不確実性の値は 0 にすることを推奨。ただし、これが当てはまらない場合もあり、その場合は過去のイベントの不確実性の値が 0 以外になることが許可されます。更新の不確実性が 0 でない場合、更新は完了していない便のおおよその予測であるか、測定が正確でないか、更新はイベント発生後に検証されていない過去の予測であったかのいずれかです。
車両が同じブロック内で複数の便を提供している場合 (便とブロックの詳細については、GTFS trips.txtを参照してください):
- フィードには、車両が現在提供している便の TripUpdate を含める必要があります。プロデューサーは、将来の便の予測の品質に自信がある場合は、この車両のブロックに現在の便の後の 1つ以上の便の TripUpdate を含めることが推奨されます。同じ車両に複数の TripUpdate を含めると、車両が 1つの便から別の便に移行する際に乗客に予測が「突然表示される」のを回避でき、また、下流の便に影響する遅延 (既知の遅延が便間の予定の乗り継ぎ時間を超える場合など) を乗客に事前に通知できます。
- それぞれの TripUpdate エンティティは、ブロックでスケジュールされている順序と同じ順序でフィードに追加する必要はありません。たとえば、
trip_ids
が 1、2、3 で、すべて 1つのブロックに属する便があり、車両が便 1、便 2、便 3 の順に移動する場合は、trip_update
エンティティは任意の順序で表示できます。たとえば、便 2、便 1、便 3 の順で追加できます。
更新では、すでに完了した旅程を記述できることに注意してください。このためには、旅程の最後の停留所の更新を提供すれば十分です。最後の停留所への到着時刻が過去である場合、クライアントは便全体が過去であると結論付けます (重要ではありませんが、先行する停留所等の更新も提供できます)。このオプションは、スケジュールより早く完了したが、スケジュールによると現時点で便がまだ進行中である便に最も関連しています。この便の更新を削除すると、クライアントは便がまだ進行中であると想定する可能性があります。フィード プロバイダーは過去の更新を消去できますが、必須ではないことに注意してください。これは、これが実際に役立つ 1つのケースです。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
trip | TripDescriptor | 必須 | 1つ | このmessageが適用される便。実際の便インスタンスごとに最大 1つのTripUpdateエンティティが存在します。存在しない場合は、予測情報が利用できないことを意味します。便がスケジュールどおりに進んでいることを意味するわけではありません。 |
vehicle | VehicleDescriptor | 任意 | 1つ | この便にサービスを提供する車両に関する追加情報。 |
stop_time_update | StopTimeUpdate | 条件付きで必須 | 複数 | 便の StopTimes の更新 (将来の予測と、場合によっては過去の停止時刻、つまりすでに発生した停止時刻の両方)。更新はstop_sequenceで並べ替えるしなければならないがあり、次に指定された stop_time_update までの便のすべての後続の停留所等に適用する必要があります。 trip.schedule_relationship が CANCELED、DELETED、または DUPLICATED でない限り、少なくとも 1つの stop_time_update を便に指定するしなければならないがあります。便がキャンセルまたは削除された場合は、stop_time_updates を指定する必要はありません。キャンセルまたは削除された便に stop_time_updates が指定されている場合、trip.schedule_relationship は、stop_time_updates および関連する schedule_relationship よりも優先されます。便が重複している場合は、新しい便のリアルタイム情報を示すために stop_time_updates を指定してもよい。 |
timestamp | uint64 | 任意 | 1つ | 将来の StopTimes を推定するために車両のリアルタイムの進行状況が測定された最新の瞬間。過去の StopTimes が指定されている場合、到着/出発時刻はこの値よりも早くなるしてもよい。 POSIX 時間 (つまり、1970 年 1 月 1 日 00:00:00 UTC からの秒数)。 |
delay | int32 | 任意 | 1つ | 便の現在のスケジュールの偏差。遅延は、予測が GTFS の既存のスケジュールと比較して指定される場合にのみ指定するするべきである。 遅延 (秒単位) は、正 (車両が遅れていることを意味する) または負 (車両が予定より進んでいることを意味する) になります。遅延が 0 の場合、車両は正確に時間通りであることを意味します。 StopTimeUpdates の遅延情報は、便レベルの遅延情報よりも優先されるため、便レベルの遅延は、 StopTimeUpdate遅延値が指定された便の次の停留所までのみ伝播されます。 フィード プロバイダーは、データの鮮度を評価するために、遅延値が最後に更新された日時を示すTripUpdate.timestamp 値を提供することを強くお勧めします。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
trip_properties | TripProperties | 任意 | 1つ | 便の更新されたプロパティを提供します。 注意: このmessageはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
message StopTimeEvent¶
単一の予測イベント (到着または出発) のタイミング情報。タイミングは、遅延および/または推定時間、および不確実性で構成されます。
- 遅延は、GTFS の既存のスケジュールを基準にして予測が示される場合に使用するべきである。
- 時間は、予測スケジュールがあるかどうかに関係なく指定するするべきである。時間と遅延の両方が指定されている場合は、時間が優先されます (ただし、通常、スケジュールされた便に対して時間が指定されている場合は、GTFS のスケジュールされた時間 + 遅延に等しくするするべきである)。
不確実性は、時間と遅延の両方に等しく適用されます。不確実性は、実際の遅延の予想される誤差を大まかに指定します (ただし、その正確な統計的意味はまだ定義されていません)。たとえば、コンピューターのタイミング制御下で運転される列車の場合、不確実性が 0 になることがあります。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
delay | int32 | 条件付きで必須 | 1つ | 遅延 (秒単位) は正 (車両が遅れていることを意味する) または負 (車両がスケジュールより進んでいることを意味する) になります。遅延が 0 の場合、車両は正確に時間通りです。StopTimeEvent 内では遅延または時間のいずれかを指定するしなければならない。両方のフィールドを空にすることはできません。 |
time | int64 | 条件付きで必須 | 1つ | 絶対時間としてのイベント。 POSIX 時間 (つまり、1970 年 1 月 1 日 00:00:00 UTC からの秒数) StopTimeEvent内では、遅延または時間のいずれかを指定するしなければならない。両方のフィールドを空にすることはできません。 |
uncertainty | int32 | 任意 | 1つ | 不確実性が省略されている場合は、不明と解釈されます。完全に確実な予測を指定するには、不確実性を 0 に設定します。 |
message StopTimeUpdate¶
便中の特定の停留所の到着イベントや出発イベントのリアルタイム更新。TripDescriptor および 便更新エンティティ ドキュメントの停車時間更新に関する一般的な説明も参照してください。
過去と未来の両方のイベントの更新を提供できます。プロデューサーは過去のイベントを削除できますが、必須ではありません。 更新はstop_sequenceまたは stop_id のいずれかを介して特定の停留所にリンクされるため、これらのフィールドのいずれかが必ず設定されているしなければならないます。1つの旅程で同じ stop_id を複数回訪れる場合は、その旅程のその stop_id のすべての StopTimeUpdates でstop_sequence を指定するするべきである。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
stop_sequence | uint32 | 条件付きで必須 | 1つ | 対応する GTFS フィードのstop_times.txtと同じであるしなければならない。 StopTimeUpdate内ではstop_sequenceまたは stop_id のいずれかを指定するしなければならない。両方のフィールドを空にすることはできませんStopTimeProperties.assigned_stop_id は、予測の対象となる停留所を区別するために、同じ stop_id を複数回訪れる便(ループなど) で必須です。StopTimeProperties.assigned_stop_id が設定されている場合は、stop_sequence も設定するしなければならない。 |
stop_id | string | 条件付きで必須 | 1つ | 対応する GTFS フィードのstops.txtと同じである必要がしなければならない。StopTimeUpdate 内ではstop_sequenceまたは stop_id のいずれStopTimeProperties.assigned_stop_id を指定するしなければならない。両方のフィールドを空にすることはできません。StopTimeProperties.assigned_stop_id が設定StopTimeUpdateれている場合は、stop_id を省略してstop_sequence のみを使用することをお勧めします。 StopTimeProperties.assigned_stop_id とstop_id が設定されている場合、stop_id はassigned_stop_id と一致するしなければならない。 |
arrival | StopTimeEvent | 条件付きで必須 | 1つ | schedule_relationship が空または SCHEDULED の場合、 StopTimeUpdate内で arrive または destination のいずれかを指定するしなければならない。両方のフィールドを空にすることはできません。schedule_relationship が SKIPPED の場合、arrival と destination の両方を空にすることができしてもよい。schedule_relationship が NO_DATA の場合、arrival と destination の両方を空にするしなければならない。 |
departure | StopTimeEvent | 条件付きで必須 | 1つ | schedule_relationship が空または SCHEDULED の場合、 StopTimeUpdate内で arrive または destination のいずれかを指定するしなければならない。両方のフィールドを空にすることはできません。schedule_relationship が SKIPPED の場合、arrival と destination の両方を空にするしてもよい。 schedule_relationship が NO_DATA の場合、到着と出発は空でなければしなければならない。 |
departure_occupancy_status | OccupancyStatus | 任意 | 1つ | 指定された停留所から出発した直後の車両の乗客の占有状況の予測。指定されている場合は、 stop_sequence を指定するしなければならない。リアルタイムの到着または出発の予測を提供せずに、departure_occupancy_status を提供するには、このフィールドに値を入力し、 StopTimeUpdate.schedule_relationship = NO_DATA を設定します。 注意: このフィールドはまだ試験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
schedule_relationship | ScheduleRelationship | 任意 | 1つ | デフォルトの関係は SCHEDULED です。 |
stop_time_properties | StopTimeProperties | 任意 | 1つ | GTFS stop_times.txt内で定義されている特定のプロパティのリアルタイム更新 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
enum ScheduleRelationship¶
この StopTime と静的スケジュールの関係。
値
値 | コメント |
---|---|
SCHEDULED | 車両は、必ずしもスケジュールの時刻に従っているわけではありませんが、静的な停留所等スケジュールに従って進んでいます。これがデフォルトの動作です。到着と出発の少なくとも1つを指定するしなければならない。頻度ベースの便(exact_times = 0 の GTFS frequencies.txt) には SCHEDULED 値を指定するべきではない、代わりに UNSCHEDULED を使用するするべきである。 |
SKIPPED | 停留所はスキップされます。つまり、車両はこの停留所には停車しません。到着と出発は任意です。設定されている場合、SKIPPED は同じルート内の後続の停留所等には伝播されません (つまり、車両はルート内の後続の停留所等にも停止しますが、それらの停留所等にもschedule_relationship: SKIPPED のstop_time_update がある場合には除きます)。ルート内の前の停留所からの遅延は SKIPPED停留所にも伝播します。つまり、 SKIPPED停留所後の停留所に対して arrivalまたは departure予測を含む stop_time_updateが設定されていない場合、 SKIPPED停留所の上流の予測は、後続の停留所の stop_time_updateが提供されるまで、ルート内の SKIPPED 停留所後の停留所と後続の停留所等地に伝播します。 |
NO_DATA | この停留所にはデータがありません。リアルタイムのタイミング情報がないことを示します。設定すると、NO_DATA は後続の停留所等にも伝播されるため、リアルタイムのタイミング情報がない停留所を指定するには、この方法を推奨するべきではない。NO_DATA が設定されている場合は、到着も出発も指定しないでするべきである。 |
UNSCHEDULED | 車両は、頻度ベースの旅程 (GTFS frequencies.txtで exact_times = 0) を運行しています。この値は、GTFS frequencies.txtで定義されていない便、または GTFS frequencies.txtで exact_times = 1.の便には使用しないでください。schedule_relationship : schedule_relationship: UNSCHEDULEDの stop_time_updatesを含む便では、 TripDescriptor schedule_relationship: UNSCHEDULED`も設定するしなければならない。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。 |
message StopTimeProperties¶
GTFS stop_times.txt内で定義されている特定のプロパティのリアルタイム更新。
注意: このmessageはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
assigned_stop_id | string | 任意 | 1つ | リアルタイムの停留所割り当てをサポートします。GTFS stops.txt で定義されているstop_id を参照します。新しい assigned_stop_id によって、エンドユーザーの乗車体験が GTFS stop_times.txt で定義されたstop_id と大幅に異なることはするべきではない。言い換えれば、新しい停留所が追加のコンテキストなしでアプリ内に表示された場合は、エンドユーザーがこの新しいstop_id を異常な変更 と見なすべきではするべきではないん。たとえば、このフィールドは、GTFS stop_times.txt で元々定義された停留所と同じ駅に属するstop_id を使用してプラットフォームの割り当てに使用することを目的としています。リアルタイムの到着または出発の予測を提供せずに停留所を割り当てるには、このフィールドに値を入力し、 StopTimeUpdate.schedule_relationship = NO_DATA を設定します。このフィールドに値を入力する場合は、 StopTimeUpdate.stop_sequence を入力するしなければならないが、StopTimeUpdate.stop_id は入力するべきではない。停留所の割り当ては、他の GTFS リアルタイム フィールドにも反映されるするべきである(例: VehiclePosition.stop_id )。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。 |
message TripProperties¶
便の更新されたプロパティを定義します
注意: このmessageはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。
.
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
trip_id | string | 条件付きで必須 | 1 | (CSV) GTFS trips.txtで定義されている既存の便の複製であるが、異なるサービスdateおよび/または時刻 ( TripProperties.start_date およびTripProperties.start_time を使用して定義) に開始する新しい便の識別子を定義します。(CSV) GTFS のtrips.trip_id の定義を参照してください。その値は、(CSV) GTFS で使用されている値と異なる必要がしなければならない。このフィールドは、schedule_relationship がDUPLICATED の場合に必須です。それ以外の場合、このフィールドに値を入力することはしてはいけない、コンシューマーによって無視されます。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
start_date | string | 条件付きで必須 | 1つ | 複製された便が実行されるサービスdate。YYYYMMDD 形式で提供するしなければならない。このフィールドは、schedule_relationship がDUPLICATED の場合に必須です。それ以外の場合は、このフィールドに値を入力してはしてはいけない、コンシューマーによって無視されます。注意: このフィールドはまだ試験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
start_time | string | 条件付きで必須 | 1 | 重複している便の出発開始時刻を定義します。(CSV) GTFS のstop_times.departure_time の定義を参照してください。重複した便の予定到着時刻と出発時刻は、元の便のdeparture_time とこのフィールドのオフセットに基づいて計算されます。たとえば、GTFS の旅程に停留所 A のdeparture_time が10:00:00 、停留所 B のdeparture_time が10:01:00 で、このフィールドに10:30:00 の値が入力されている場合、複製された旅程の停留所 B のスケジュールされたdeparture_time は10:31:00 になります。リアルタイム予測のdelay 値は、この計算されたスケジュール時間に適用され、予測時間を決定します。たとえば、停留所 B の出発delay が30 の場合、予測される出発時刻は10:31:30 です。リアルタイム予測のtime 値にはオフセットが適用されず、提供された予測時間を示します。たとえば、停留所 B の出発time が10:31:30 と指定されている場合、予測出発時刻は 10:31:30になります。このフィールドは、 schedule_relationshipが DUPLICATED`の場合に必須。それ以外の場合、このフィールドに値を入力するしてはいけない、消費者によって無視されます。注意: このフィールドはまだ試験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。 |
shape_id | string | 任意 | 1つ | この旅程の車両移動経路の形状が元のものと異なる場合に、その形状を指定します。(CSV) GTFS で定義された形状、またはリアルタイム フィードの新しい形状エンティティを参照します。(CSV) GTFS のtrips.shape_id の定義をご覧ください。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
message VehiclePosition¶
特定の車両のリアルタイム位置情報。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
trip | TripDescriptor | 任意 | 1つ | この車両がサービスを提供している便。特定の便インスタンスで車両を識別できない場合は、空または一部にすることができます。 |
vehicle | VehicleDescriptor | 任意 | 1つ | この便を提供している車両に関する追加情報。各エントリには、一意の車両IDがするべきである。 |
position | Position | 任意 | 1つ | この車両の現在のPosition。 |
current_stop_sequence | uint32 | 任意 | 1つ | 現在の停留所の停車シーケンス インデックス。current_stop_sequence の意味 (つまり、それが参照する停留所) は、current_status によって決まります。current_status が指定されていない場合は、IN_TRANSIT_TO が指定されたものとみなされます。 |
stop_id | string | 任意 | 1つ | 現在の停留所を識別します。値は、対応する GTFS フィード内のstops.txtの値と同じであるしなければならない。StopTimeProperties.assigned_stop_id を使用してStopTimeProperties.assigned_stop_id stop_id を割り当てる場合、このフィールドもstop_id の変更を反映するするべきである。 |
current_status | VehicleStopStatus | 任意 | 1つ | 現在の停止に関する車両の正確な状態。current_stop_sequence がない場合は無視されます。 |
timestamp | uint64 | 任意 | 1つ | 車両のPositionが測定された瞬間。POSIX 時間 (つまり、1970 年 1 月 1 日 00:00:00 UTC からの秒数)。 |
congestion_level | CongestionLevel | 任意 | 1つ | |
occupancy_status | OccupancyStatus | オプション | 1つ | 車両または客車の乗客の占有状態。 multi_carriage_details に車両ごとのOccupancyStatusが設定されている場合、このフィールドは、乗客を受け入れるすべての車両を考慮して車両全体を記述するするべきである。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
occupancy_percentage | uint32 | 任意 | 1つ | 車両内の乗客の占有率を示すパーセンテージ値。値 100 は、座席と立席の両方の定員を含む、車両が設計された最大占有率を表し、現在の運行規則で許可されています。設計された最大定員よりも多くの乗客がいる場合、値は 100 を超えることがありしてもよい。occupancy_percentage の精度は、個々の乗客が車両に乗り降りするのを追跡できないほど低くするするべきである。multi_carriage_details に車両ごとの occupancy_percentage が設定されている場合、このフィールドは、乗客を受け入れるすべての車両を考慮して車両全体を記述するするべきである。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。 |
multi_carriage_details | CarriageDetails | 任意 | 多数 | この車両の複数の客車の詳細。最初の出現は、現在の移動方向を前提として、車両の最初の客車を表します。multi_carriage_details フィールドの出現回数は、車両の客車数を表します。また、事業者車、保守用車両など、乗客がプラットフォームのどこに立つべきかに関する貴重な情報を提供する、乗車できない車両も含まれます。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
enum VehicleStopStatus¶
Values
Value | Comment |
---|---|
INCOMING_AT | 車両が停車場に到着しようとしています (停車場表示では、通常、車両シンボルが点滅します)。 |
STOPPED_AT | 車両が停車場に停止しています。 |
IN_TRANSIT_TO | 車両が前の停車場を出発し、移動中です。 |
enum CongestionLevel¶
この車両に影響を与えている混雑レベル。
Values
Value |
---|
UNKNOWN_CONGESTION_LEVEL |
RUNNING_SMOOTHLY |
STOP_AND_GO |
CONGESTION |
SEVERE_CONGESTION |
enum OccupancyStatus¶
車両または客車の乗客の占有状態。
個々のプロデューサーは、すべてのOccupancyStatus値を公開しないしてもよい。したがって、コンシューマーは、 OccupancyStatus値が線形スケールに従うと想定してはしてはいけない。コンシューマーは、プロデューサーが示し意図した状態としてOccupancyStatus値を表すするべきである。同様に、プロデューサーは、実際の車両占有状態に対応するOccupancyStatus値を使用するしなければならない。
線形スケールでの乗客の占有階・フロアを説明するには、occupancy_percentage
を参照してください。
注意: このフィールドはまだ実験的であり、変更される可能性があります。将来、正式に採用されるしてもよい。
値
値 | コメント |
---|---|
EMPTY | ほとんどの基準では車両が空であるとみなされ、乗客はほとんどいないか、まったくいませんが、乗客を受け入れています。 |
MANY_SEATS_AVAILABLE | 車両または客車の空席数が多い。使用可能な総座席数のうち、このカテゴリに該当するほど空いている座席の数は、プロデューサーの裁量で決定されます。 |
FEW_SEATS_AVAILABLE | 車両または客車の空席数が少ない。使用可能な総座席数のうち、このカテゴリに該当するほど空いている座席の数は、プロデューサーの裁量で決定されます。 |
STANDING_ROOM_ONLY | 現在、車両または客車は立っている乗客のみを収容できます。 |
FULL | ほとんどの基準では車両は満員と見なされますが、乗客の乗車を許可している可能してもよいがあります。 |
NOT_ACCEPTING_PASSENGERS | 車両または客車は乗客を受け入れていません。車両または客車は通常、乗客の乗車を受け入れます。 |
NO_DATA_AVAILABLE | その時点で、車両または客車に利用可能な占有データがありません。 |
NOT_BOARDABLE | 車両または客車は乗車できず、乗客を受け入れることはありません。特別な車両や客車(エンジン、メンテナンス用客車など)に役立ちます。 |
message CarriageDetails¶
複数の客車で構成された車両に使用される、客車固有の詳細。
注意: このmessageはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
id | string | 任意 | 1つ | 客車の ID。車両ごとに一意であるするべきである。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
label | string | 任意 | 1つ | 車両を識別するために乗客に表示さしてもよい、ユーザーに表示されるラベル。例: "7712"、"Car ABC-32" など... 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
occupancy_status | OccupancyStatus | 任意 | 1つ | この車両のこの車両の乗車状況。デフォルトはNO_DATA_AVAILABLE に設定されています。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
occupancy_percentage | int32 | 任意 | 1 | この車両のこの車両の占有率。"VehiclePosition.occupancy_percentage" と同じルールに従います。この車両のデータが利用できない場合は -1 を使用します。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
carriage_sequence | uint32 | 必須 | 1 | 車両の CarriageStatus リスト内の他の車両に対するこの車両の順序を識別します。移動方向の最初の車両の値は1.である必要がしなければならない。2 番目の値は移動方向の 2 番目の車両に対応し、値 2 であるしなければならないがあります。以下同様です。たとえば、移動方向の最初の車両の値は1.です。移動方向の 2 番目の車両の値が 3 の場合、コンシューマーはすべての車両のデータ (つまり、multi_carriage_details フィールド) を破棄します。データのないキャリッジは、有効な carrier_sequence 番号で表すしなければならない、データのないフィールドは省略するするべきである(代わりに、それらのフィールドを含めて、データなし の値に設定することもできます)。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
message Alert¶
公共交通事業者ネットワークで何らかのインシデントが発生したことを示すアラート。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
active_period | TimeRange | 任意 | 複数 | アラートをユーザーにするべきである時間。指定しない場合は、フィードに表示される限りアラートが表示されます。複数の範囲が指定されている場合は、そのすべての範囲でアラートが表示されます。 |
informed_entity | EntitySelector | 必須 | 複数 | このアラートをユーザーに通知するするべきであるエンティティ。少なくとも 1つの inform_entity を指定するしなければならない。 |
cause | Cause | 条件付きで必須 | 1つ | cause_detail が含まれている場合は、Cause も含める必要がしなければならない。 |
cause_detail | TranslatedString | 任意 | 1つ | アラートの原因の説明。事業者固有の言語を使用できます。Cause よりも具体的です。cause_detail が含まれている場合は、Cause も含めるしなければならない。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
effect | Effect | 条件付きで必須 | 1つ | effect_detail が含まれている場合は、Effect も含めるしなければならない。 |
effect_detail | TranslatedString | 任意 | 1つ | アラートの効果の説明。事業者固有の言語を使用できます。Effect よりも具体的です。effect_detail が含まれている場合は、Effect も含めるしなければならない。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい性があります。 |
url | TranslatedString | 任意 | 1つ | アラートに関する追加情報を提供する URL。 |
header_text | TranslatedString | 必須 | 1つ | アラートのヘッダー。このプレーン テキスト文字stringは、たとえば太字で強調表示されます。 |
description_text | TranslatedString | 必須 | 1つ | アラートの説明。このプレーン テキスト文字stringは、アラートの本文としてフォーマットされます (または、ユーザーによる明示的な展開 要求で表示されます)。説明の情報は、ヘッダーの情報に追加されるするべきである。 |
tts_header_text | TranslatedString | 任意 | 1つ | テキスト読み上げの実装に使用されるアラートのヘッダーを含むText。このフィールドは、header_text のテキスト読み上げバージョンです。header_text と同じ情報を含めるするべきであるが、テキスト読み上げとして読み取れる形式にする必要があります (たとえば、省略形は削除、数字はスペルアウトなど)。 |
tts_description_text | TranslatedString | 任意 | 1つ | テキスト読み上げの実装に使用されるアラートの説明を含むText。このフィールドは、description_text のテキスト読み上げバージョンです。description_text と同じ情報を含めるするべきであるが、テキスト読み上げとして読み取れる形式にする必要があります (たとえば、省略形は削除、数字はスペルアウトなど)。 |
severity_level | SeverityLevel | 任意 | 1つ | アラートの重大度。 |
image | TranslatedImage | 任意 | 1つ | アラートTextに沿って表示される 1つのTranslatedImage 。迂回、駅の閉鎖などのアラート効果を視覚的に説明するために使用されます。画像はアラートの理解を深めるするべきである、重要な情報の唯一の場所であってはしてはいけない。次の種類の画像は推奨されません : 主にTextを含む画像、追加情報を含まないマーケティングまたはブランド画像。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
image_alternative_text | TranslatedString | 任意 | 1つ | image フィールドでリンクされた画像の外観を説明するText(たとえば、画像を表示できない場合や、アクセシビリティの理由でユーザーが画像を見ることができない場合など)。HTML alt 画像のTextの仕様 を参照してください。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。 |
enum Cause¶
このアラートの原因。
値
値 |
---|
UNKNOWN_CAUSE |
OTHER_CAUSE |
TECHNICAL_PROBLEM |
STRIKE |
DEMONSTRATION |
ACCIDENT |
HOLIDAY |
WEATHER |
MAINTENANCE |
CONSTRUCTION |
POLICE_ACTIVITY |
MEDICAL_EMERGENCY |
enum Effect¶
この問題が影響を受けるエンティティに与える影響。
値
値 |
---|
NO_SERVICE |
REDUCED_SERVICE |
SIGNIFICANT_DELAYS |
DETOUR |
ADDITIONAL_SERVICE |
MODIFIED_SERVICE |
OTHER_EFFECT |
UNKNOWN_EFFECT |
STOP_MOVED |
NO_EFFECT |
ACCESSIBILITY_ISSUE |
enum SeverityLevel¶
アラートの重大度。
注意: このフィールドはまだ実験的であり、変更される可能性があります。将来、正式に採用されるしてもよい。
値
値 |
---|
UNKNOWN_SEVERITY |
INFO |
WARNING |
SEVERE |
message TimeRange¶
時間間隔。t
が開始時刻以上で終了時刻より小さい場合、間隔は時刻 t
でアクティブであると見なされます。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
start | uint64 | 条件付きで必須 | 1つ | 開始時刻、POSIX 時間 (つまり、1970 年 1 月 1 日 00:00:00 UTC からの秒数)。指定されていない場合、間隔はマイナス無限大で始まります。TimeRangeが指定されている場合は、start または end のいずれかを指定するしなければならない。両方のフィールドを空にすることはできません。 |
end | uint64 | 条件付きで必須 | 1つ | 終了時刻、POSIX 時間 (つまり、1970 年 1 月 1 日 00:00:00 UTC からの秒数)。指定されていない場合、間隔はプラス無限大で終了します。TimeRangeが指定されている場合は、start または end のいずれかを指定するしなければならない。両方のフィールドを空にすることはできません。 |
message Position¶
車両の地理的Position。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
latitude | float | 必須 | 1 | WGS-84 座標系での北緯。 |
longitude | float | 必須 | 1 | WGS-84 座標系での東経。 |
bearing | float | 任意 | 1つ | 真北から時計回りの度数で表した方位。つまり、0 は北、90 は東です。これはコンパス方位、または次の停止地点または中間地点への方向になります。これは、クライアントが以前のデータから計算できる以前の位置のシーケンスから推測されるするべきではない。 |
odometer | double | 任意 | 1つ | 走行距離計の値 (メートル単位)。 |
speed | float | 任意 | 1つ | 車両によって測定された瞬間速度 (メートル/秒単位)。 |
message TripDescriptor¶
GTFS 便の単一のインスタンスを識別する記述子。
単一の便インスタンスを指定するには、多くの場合、trip_id
だけで十分です。ただし、次の場合には、単一の便インスタンスを解決するために追加の情報が必要です:
- frequencies.txtで定義されている便の場合、
trip_id
に加えてstart_date
とstart_time
が必須。 - 便が 24 時間以上続く場合、または翌日の予定便と重なるように遅れる場合は、
trip_id
に加えてstart_date
が必須です。 trip_id
フィールドを指定できない場合は、route_id
、direction_id
、start_date
、およびstart_time
をすべて指定するしなければならない。
すべての場合において、trip_id
に加えてtrip_id
route_id
を指定する場合、route_id
はGTFS trips.txtで特定の便に割り当てられた
route_id`と同じであるしなければならないがあります。
trip_id
フィールドは、単独でも、または次のフィールドと組み合わせても、他のTripDescriptorフィールドは、複数の便インスタンスを識別するために使用できます。たとえば、GTFS frequencies.txt exact_times=0 の便では、 TripDescriptor でtrip_id を単独で指定しないでするべきである。start_time も、特定の時刻に開始する単一の便インスタンスに解決される必須があるためです。TripDescriptorが単一の便インスタンスに解決されない場合 (つまり、0 個以上の便インスタンスに解決される場合)、エラーと見なされ、エラーのあるTripDescriptorを含むエンティティはコンシューマーによって破棄されるしてもよい。
trip_idが不明な場合は、 TripUpdateの駅シーケンス ID では不十分であり、stop_id も提供するしなければならない。さらに、絶対的な到着/出発時刻も提供するしなければならないTripDescriptor.route_id は、ルートのすべての便に影響するルート全体のアラートを指定する Alert EntitySelector内では使用できません。代わりにEntitySelector.route_idを使用してください。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
trip_id | string | 条件付きで必須 | 1つ | このセレクタが参照する GTFS フィードのtrip_id 。非定期運行の便(GTFS frequencies.txtで定義されていない便) の場合、このフィールドだけで旅程を一意に識別できます。GTFS frequencies.txtで定義されている定期運行の便の場合、 trip_id、start_time、start_date はすべて必須です。スケジュールベースの便(GTFS frequencies.txtで定義されていない便)の場合、 trip_idを省略できるのは、 route_id、 direction_id 、 start_time 、 start_date の組み合わせによって旅程を一意に識別でき、それらのフィールドがすべて指定されている場合のみです。 schedule_relationship がTripUpdate内で DUPLICATED の場合、 trip_id は複製される静的 GTFS からの旅程を識別します。 schedule_relationship がVehiclePosition内で DUPLICATED の場合、 trip_id は複製される新しい旅程を識別し、対応するTripUpdateの値を含めるしなければならない。 TripProperties。 trip_id。 |
route_id | string | 条件付きで必須 | 1つ | このセレクタが参照する GTFS からのroute_id 。 trip_idを省略した場合、ルートインスタンスを識別するために、 route_id、 direction_id 、 start_time 、および schedule_relationship=SCHEDULED をすべて設定するしなければならない。ルートのすべての便に影響するルート全体のアラートを指定するために、 Alert EntitySelector内でTripDescriptor.route_idを使用しするべきではない。代わりにEntitySelector.route_id を使用してください。 |
direction_id | uint32 | 条件付きで必須 | 1つ | GTFS フィードのtrips.txtファイルの direction_id。このセレクタが参照する便の移動方向を示しますtrip_idを省略した場合、 direction_id を指定するしなければならない。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
start_time | string | 条件付きで必須 | 1 | この旅程インスタンスの当初の予定開始時刻。trip_idが非頻度ベースの旅程に対応する場合、このフィールドは省略するか、GTFS フィードの値と同じにするするべきである。trip_idがGTFS frequencies.txtで定義された頻度ベースの旅程に対応する場合、start_time は必須であり、旅程の更新と車両の位置のために指定するしなければならない。旅程が exact_times=1 の GTFS レコードに対応する場合、start_time は対応する期間のfrequencies.txt のstart_time より headway_secs の倍数 (0 を含む) 後にするしなければならない。旅程が exact_times=0 に対応する場合、start_time は任意でかまいませしてもよいが、当初は旅程の最初の出発時刻になると予想されます。一度設定されると、この頻度ベースの exact_times=0 の旅程の start_time は、最初の出発時刻が変更された場合でも不変と見なすするべきである。その時間変更は、代わりにStopTimeUpdateに反映されるしてもよいtrip_idを省略する場合は、 start_time を指定するしなければならない。フィールドの形式とセマンティクスは、GTFS/frequencies.txt/start_time と同じです (例: 11:15:35 または 25:15:35)。 |
start_date | string | 条件付きで必須 | 1つ | この旅程インスタンスの開始date(YYYYMMDD 形式)。スケジュールされた便(GTFS frequencies.txtで定義されていない便) の場合、翌日のスケジュールされた旅程と重なるほど遅れている便を明確にするために、このフィールドを指定するしなければならない。たとえば、毎日 8:00 と 20:00 に出発し、12 時間遅れている列車の場合、同じ時間に 2つの異なる便が存在することになります。このフィールドは指定できますが、このような衝突が不可能なスケジュールでは必須ではありません。たとえば、1 時間遅れている車両はスケジュールとは関係がないと見なされる、1 時間ごとのスケジュールで実行されるサービスなどです。このフィールドは、GTFS frequencies.txtで定義されている頻度ベースの便では必須。trip_idが省略されている場合は、start_date を指定するしなければならない。 |
schedule_relationship | ScheduleRelationship | 任意 | 1つ | この便と静的スケジュールの関係。TripDescriptorがAlert EntitySelector で指定されている場合、一致する便インスタンスを識別するときに、schedule_relationship フィールドはコンシューマーによって無視されます。 |
modified_trip | ModifiedTripSelector | 任意 | 1つ | この旅行に対して行われた変更へのリンク (形状の変更、停車地の削除または追加)。このフィールドを指定する場合、 TripDescriptor のtrip_id 、 route_id 、 direction_id 、 start_time 、 start_date フィールドは、ModifiedTripSelector 値を探していない消費者による混乱を避けるために、空のままにしておく必要があります。 |
enum ScheduleRelationship¶
この便と静的スケジュールの関係。旅程が GTFS に反映されていない臨時スケジュールに従って行われる場合、SCHEDULED ではなく ADDED としてマークする必要があります。
値
値 | コメント |
---|---|
SCHEDULED | GTFS スケジュールに従って運行されている、またはスケジュールされた運行に十分近いため関連付けられている運行。 |
ADDED | 故障した車両を交換するため、または突然の乗客の増加に対応するためなど、運行スケジュールに加えて追加された運行。 注: 現在、このモードを使用するフィードの動作は指定されていません。GTFS GitHub (1) (2) (3) では、ADDED 運行を完全に指定するか廃止するかについて議論されており、その議論が確定次第、ドキュメントが更新されます。 |
UNSCHEDULED | スケジュールが関連付けられていない運行中の旅程 - この値は、GTFS frequencies.txt で exact_times = 0 に定義されている旅程を識別するために使用されます。GTFS frequencies.txt で定義されていない旅程や、GTFS frequencies.txt で exact_times = 1 に定義されている旅程を説明するために使用しないでください。schedule_relationship: UNSCHEDULED の旅程では、すべての StopTimeUpdates も schedule_relationship: UNSCHEDULED に設定する必要があります。 |
CANCELED | スケジュールに存在していたが削除された旅程。 |
DUPLICATED | サービス開始日時を除き、既存のスケジュールされた旅程と同じ新しい旅程。 TripUpdate.TripProperties.trip_id 、TripUpdate.TripProperties.start_date 、および TripUpdate.TripProperties.start_time と一緒に使用して、静的 GTFS から既存の旅程をコピーしますが、開始日は異なるサービス日付および/または時刻にします。(CSV) GTFS (calendar.txt または calendar_dates.txt ) 内の元の旅程に関連するサービスが今後 30 日以内に運行される場合、旅程の複製が許可されます。複製する旅程は、TripUpdate.TripDescriptor.trip_id によって識別されます。この列挙では、 TripUpdate.TripDescriptor.trip_id によって参照される既存の旅程は変更されません。プロデューサーが元の旅程をキャンセルする場合は、CANCELED の値を持つ別の TripUpdate を公開する必要があります。 GTFS の frequencies.txt で定義されている、exact_times が空または 0 に等しい旅程は複製できません。新しい旅程の VehiclePosition.TripDescriptor.trip_id には、TripUpdate.TripProperties.trip_id の一致する値が含まれている必要があり、VehiclePosition.TripDescriptor.ScheduleRelationship も DUPLICATED に設定する必要があります。重複した旅程を表すために ADDED 列挙を使用していた既存のプロデューサーとコンシューマーは、移行ガイド に従って DUPLICATED 列挙に移行する必要があります。 |
DELETED | スケジュールに存在していたが削除された旅程で、ユーザーに表示してはいけません。 交通事業者プロバイダーが、対応する便に関する情報を消費アプリケーションから完全に削除し、乗客に便がキャンセルされたと表示されないようにするには、CANCELED ではなく DELETED を使用する必要があります。たとえば、便が別の便に完全に置き換えられる場合などです。この指定は、複数の便がキャンセルされ、代替サービスに置き換えられる場合に特に重要になります。消費者がキャンセルに関する明確な情報を表示すると、より重要なリアルタイム予測が妨げられます。 注意: このフィールドはまだ 実験的 であり、変更される可能性があります。将来正式に採用される可能性があります。 |
message ModifiedTripSelector¶
サービスが旅行の変更の影響を受ける場合、ModifiedTripSelector
を使用して旅行を選択します。詳細については、旅行のModification仕様を参照してください。
値
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
modifications_id | string | 必須 | 1つ | 含まれるTripModifications オブジェクトがこの旅程に影響を与えるFeedEntity のid |
affected_trip_id | string | 必須 | 1つ | modifications_id によって変更される GTFS フィードからのtrip_id |
start_time | string | 任意 | 1つ | 頻度に基づいて変更された旅程に適用される、この旅程インスタンスの当初のスケジュール開始時刻。TripDescriptor のstart_timeと同じ定義です。 |
start_date | string | 任意 | 1つ | 変更された旅行に適用される、この旅行インスタンスの開始date(YYYYMMDD 形式)。TripDescriptor のstart_dateと同じ定義です。 |
message VehicleDescriptor¶
便を実行する車両の識別情報。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
id | string | 任意 | 1つ | 車両の内部システム ID。車両ごとに一意でするべきである、システム内を進む車両を追跡するために使用されます。このID は、エンドユーザーには表示しするべきではない。そのためには、labelフィールドを使用します |
label | string | 任意 | 1つ | ユーザーに表示されるラベル。つまり、正しい車両を識別するために乗客に表示するしなければならないもの。 |
license_plate | string | 任意 | 1つ | 車両のナンバー プレート。 |
wheelchair_accessible | WheelchairAccessible | 任意 | 1つ | 指定されている場合、静的 GTFS の wheelchair_accessible 値を上書きできます。 |
enum WheelchairAccessible¶
特定の便が車椅子でアクセス可能かどうか。利用可能な場合、この値は静的 GTFS の wheelchair_accessible 値を上書きするべきである。
値
値 | コメント |
---|---|
NO_VALUE | 便には車椅子でのアクセスに関する情報がありません。これはデフォルトの動作です。静的 GTFS に wheelchair_accessible 値が含まれている場合、上書きされません。 |
UNKNOWN | 便にはアクセシビリティ値がありません。この値により、GTFS の値が上書きされます。 |
WHEELCHAIR_ACCESSIBLE | 便には車椅子でアクセスできます。この値により、GTFS の値が上書きされます。 |
WHEELCHAIR_INACCESSIBLE | 便には車椅子でアクセスできません。この値により、GTFS の値が上書きされます。 |
message EntitySelector¶
GTFS フィード内のエンティティのセレクター。フィールドの値は、GTFS フィード内の適切なフィールドに対応している必要があります。少なくとも 1つの指定子を指定する必要があります。複数の指定子を指定する場合、それらは論理 AND
演算子で結合されていると解釈されます。さらに、指定子の組み合わせは、GTFS フィード内の対応する情報と一致している必要があります。つまり、アラートを GTFS 内のエンティティに適用するには、提供されているすべての EntitySelector フィールドと一致する必要があります。たとえば、route_id: "5"
および route_type: "3"
フィールドを含む EntitySelector は、route_id: "5"
バスにのみ適用され、route_type: "3"
の他のルートには適用されません。プロデューサーがアラートを route_id: "5"
と route_type: "3"
の両方に適用する場合、route_id: "5"
を参照する EntitySelector と route_type: "3"
を参照する EntitySelector の 2 つを別々に提供する必要があります。
少なくとも 1つの指定子を指定するしなければならない。EntitySelectorのすべてのフィールドを空にすることはできません。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
agency_id | string | 条件付きで必須 | 1つ | このセレクタが参照する GTFS フィードの agency_id。 |
route_id | string | 条件条件付きで必須 | 1つ | このセレクタが参照する GTFS のroute_idが指定されている場合は、 route_idも指定するしなければならない。 |
route_type | int32 | 条件付きで必須 | 1つ | このセレクタが参照する GTFS の route_type。 |
direction_id | uint32 | 条件付きで必須 | 1つ | GTFS フィードtrips.txtファイルの direction_id。route_id で指定されたroute_idの 1 方向のすべての便を選択するために使用されます。direction_id が指定されている場合は、 route_idも指定するしなければならない。 注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
trip | TripDescriptor | 条件付きで必須 | 1つ | このセレクタが参照する GTFS の旅程インスタンス。このTripDescriptor は、GTFS データ内の単一の旅程インスタンスに解決されるしなければならない(たとえば、プロデューサーは exact_times=0 の便に対してtrip_idのみを提供することはできません)。このTripDescriptor内にScheduleRelationshipフィールドが設定されている場合、コンシューマーが GTFS の旅程を識別しようとすると無視されます。 |
stop_id | string | 条件付きで必須 | 1つ | このセレクタが参照する GTFS フィードの stop_id。 |
message TranslatedString¶
Textのスニペットまたは URL の言語別バージョンを含む国際化message。messageから文字列の 1つが取得されます。解決は次のように進行します: UI 言語が翻訳の言語コードと一致する場合、最初に一致する翻訳が選択されます。デフォルトの UI 言語 (例: 英語) が翻訳の言語コードと一致する場合、最初に一致する翻訳が選択されます。翻訳に未指定の言語コードがある場合は、その翻訳が選択されます。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
translation | Translation | 必須 | 多数 | 少なくとも1つの翻訳を指定するしなければならない。 |
message Translation¶
言語にマップされたローカライズされたstring。
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
text | string | 必須 | 1つ | messageを含む UTF-8string。 |
language | string | 条件付きで必須 | 1つ | BCP-47 言語コード。言語が不明な場合、またはフィードに対して国際化が行われていない場合は省略できます。最大で 1つの翻訳に未指定の言語タグを指定できます。翻訳が複数ある場合は、言語を指定するしなければならない。 |
message TranslatedImage¶
言語ごとの画像バージョンを含む国際化されたmessage。messageからの画像が 1つ取得されます。解決は次のように進行します: UI 言語が翻訳の言語コードと一致する場合、最初に一致する翻訳が選択されます。デフォルトの UI 言語 (例: 英語) が翻訳の言語コードと一致する場合、最初に一致する翻訳が選択されます。翻訳に未指定の言語コードがある場合は、その翻訳が選択されます。
注意: このmessageはまだ実験的であり、変更される可能性があります。将来、正式に採用されるしてもよい。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
localized_image | LocalizedImage | 必須 | 多数 | 少なくとも 1つのローカライズされた画像を指定するしなければならない。 |
message LocalizedImage¶
言語にマップされたローカライズされたイメージのURL。
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
url | string | 必須 | 1つ | イメージにリンクする URL を含むstring。リンクされるイメージは 2 MB 未満でしなければならない。イメージが大幅に変更され、コンシューマー側で更新が必須場合、プロデューサーは URL を新しいものに更新するしなければならない。 URL は http://または https://を含む完全修飾 URL でするべきである、URL 内の特殊文字は正しくエスケープするしなければならない。完全修飾 URL 値の作成方法については、次の http://www.w3.org/Addressing/URL/4_URI_Recommentations.html を参照してください。 |
media_type | string | 必須 | 1つ | 表示する画像の種類を指定するための IANA メディア タイプ。タイプは "image/" で始まるしなければならない。 |
language | string | 条件付きで必須 | 1つ | BCP-47 言語コード。言語が不明な場合、またはフィードに対して国際化が行われていない場合は省略できます。最大で 1つの翻訳に未指定の言語タグを指定できます。翻訳が複数ある場合は、言語を指定するしなければならない。 |
message Shape¶
形状が (CSV) GTFS の一部ではない場合 (アドホック迂回など) に車両がたどる物理的な経路を説明します。ルート形状は便に属し、より効率的な送信のためにエンコードされたポリラインで構成されます。ルート形状は停留所等の位置を正確に横切る必要はありませんが、トリップ上のすべての停留所等は、そのトリップの形状からわずかな距離内、つまり形状 ポイントを結ぶ直線セグメントの近くに配置するするべきである。
注意: このmessageはまだ試験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
shape_id | string | 必須 | 1つ | 形状の識別子。(CSV) GTFS で定義されているshape_id とは異なる必要がしなければならない。注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
encoded_polyline | string | 必須 | 1つ | 形状のエンコードされたポリライン表現。このポリラインには少なくとも 2つのポイントが含まれているしなければならない。エンコードされたポリラインの詳細については、https://developers.google.com/maps/documentation/utilities/polylinealgorithm をご覧ください。 注意: このフィールドはまだ試験的であり、変更される可能性があります。将来正式に採用されるしてもよい。 |
message Stop¶
フィードに動的に追加された新しい停留所を表します。すべてのフィールドは、(CSV) GTFS 仕様で説明されているとおりです。新しい停留所の場所タイプは 0
(ルート可能な停留所) です。
注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
stop_id | string | 必須 | 1つ | 停留所の識別子。(CSV) GTFS で定義されているstop_id と異なる必要がしなければならない。 |
stop_code | TranslatedString | 任意 | 1つ | (CSV) GTFS の [停留所等.stop_code](https:](https: ) の定義を参照してください。 |
stop_name | TranslatedString | 必須 | 1つ | (CSV) GTFS の 停留所等 .stop_name の定義を参照してください。 |
tts_stop_name | TranslatedString | 任意 | 1つ | (CSV) GTFS の 停留所等.tts_stop_name の定義を参照してください。 |
stop_desc | TranslatedString | 任意 | 1つ | (CSV) GTFS の 停留所等.stop_desc の定義を参照してください。 |
stop_lat | float | 必須 | 1つ | (CSV) GTFS の 停留所等.stop_lat の定義を参照してください。 |
stop_lon | float | 必須 | 1つ | (CSV) GTFS の 停留所等.stop_lon の定義を参照してください。 |
zone_id | string | 任意 | 1つ | (CSV) GTFS の 停留所等.zone_id の定義を参照してください。 |
stop_url | TranslatedString | 任意 | 1つ | (CSV) GTFS の 停留所等.stop_url の定義を参照してください。 |
parent_station | string | 任意 | 1つ | (CSV) GTFS の 停留所等.parent_station の定義を参照してください。 |
stop_timezone | string | 任意 | 1つ | (CSV) GTFS の 停留所等 の定義を参照してください。 |
wheelchair_boarding | WheelchairBoarding | 任意 | 1つ | (CSV) GTFS の 停留所等 の定義を参照してください。 |
level_id | string | 任意 | 1つ | (CSV) GTFS の 停留所等 の定義を参照してください。 |
platform_code | TranslatedString | 任意 | 1つ | (CSV) GTFS の 停留所等 の定義を参照してください。 |
enum WheelchairBoarding¶
Values
Value | Comment |
---|---|
UNKNOWN | 停留所のアクセシビリティ情報がありません。 |
AVAILABLE | この停留所の一部の車両には、車椅子の乗客が乗車できます。 |
NOT_AVAILABLE | この停留所では車椅子での乗車はできません。 |
message TripModifications¶
「TripModifications」メッセージは、迂回などの特定の変更によって影響を受ける類似の便のリストを識別します。
注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
selected_trips | SelectedTrips | 必須 | 多数 | このTripModificationsの影響を受ける選択された便のリスト。少なくとも 1つの SelectedTrips を含める必要があります。値 start_times が設定されている場合、1つのtrip_idを持つ SelectedTrips を最大 1つリストできます。 |
start_times | string | 任意 | 多数 | trip_ids で定義されたtrip_idのリアルタイム便記述子の開始時刻のリスト。頻度ベースの便でtrip_idの複数の出発をターゲットにするのに役立ちます。 |
service_dates | string | 必須 | 多数 | Modificationが発生する日付 (YYYYMMDD 形式)。trip_idは、特定のサービスdateに実行される場合にのみ変更されます。便はすべての運行日に実行する必須はありません。プロデューサーは、次の 1 週間以内に発生する迂回のみを送信する必要がするべきである。提供された日付は、ユーザー向けの情報として使用しするべきではない。ユーザー向けの開始日と終了dateを提供する必要がある場合は、リンクされたサービスアラートで service_alert_id を使用して提供できます。 |
modifications | Modification | 必須 | 多数 | 影響を受ける便に適用する変更のリスト。 |
message Modification¶
Modification
メッセージは、start_stop_selector
から始まる、影響を受ける各便に対する変更を説明します。
注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。
特定の便に対するModificationの効果を示す例。このModificationは、他のいくつかの便にも適用されるしてもよい。_
伝播された迂回遅延は、Modificationの終了後にすべての停留所等に影響します。便に複数の変更がある場合、遅延は累積されます。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
start_stop_selector | StopSelector | 必須 | 1つ | このModificationによって影響を受ける元の便の最初の停留所の停留所セレクター。end_stop_selector と組み合わせて使用します。start_stop_selector は必須であり、travel_time_to_stop で使用される参照停留所を定義するために使用されます。詳細については、travel_time_to_stop を参照してください |
end_stop_selector | StopSelector | 条件付きで必須 | 1つ | このModificationによって影響を受ける元の便の最後の停留所の停留所セレクター。選択は包括的であるため、そのModificationによって 1つの stop_time のみが置き換えられる場合は、start_stop_selector と end_stop_selector は同等であるしなければならない。stop_time が置き換えられない場合は、end_stop_selector を指定ししてはいけない。それ以外の場合は必須。 |
propagated_modification_delay | int32 | 任意 | 1つ | Modificationによって挿入された最後の停留所の後のすべての出発時刻と到着時刻に追加する遅延の秒数。Modificationが形状のみに影響する場合 (つまり、end_stop_selector も replacement_stops も指定されていない場合)、遅延の伝播は start_stop_selector の後続の停留所で始まります。正または負の数値を指定できます。同じ便に複数の変更が適用されると、便が進むにつれて遅延が蓄積されます。値が指定されていない場合、コンシューマーは他のデータに基づいて propagated_modification_delay を補間または推測するしてもよいがあります。 |
replacement_stops | ReplacementStop | 任意 | 複数 | 元の便の停留所を置き換える、代替の停留所等のリスト。新しい停車時刻の長さは、置き換えられた停車時刻の数よりも短くなったり、同じになったり、長くなったりするしてもよい。 |
service_alert_id | string | 任意 | 1つ | ユーザー向けの通信用にこのModificationを説明するAlert を含むFeedEntity messageからのid 値。 |
last_modified_time | uint64 | 任意 | 1つ | このタイムスタンプは、Modificationが最後に行われた瞬間を識別します。POSIX 時間 (つまり、1970 年 1 月 1 日 00:00:00 UTC からの秒数) です。 |
message StopSelector¶
停止のセレクターstop_id
またはstop_sequence
のいずれか。2つの値のうち少なくとも 1つを指定するしなければならない。
注意: このフィールドはまだ試験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
stop_sequence | uint32 | 条件付きで必須 | 1つ | 対応する GTFS フィードのstop_times.txtと同じであるしなければならないがあります。StopSelector 内ではstop_sequence またはstop_id のStopSelectorかを指定するしなければならない。両方のフィールドを空にすることはできません。 stop_sequence は、同じ stop_id を複数回訪れる便(ループなど) で、予測の対象となる停留所を明確にするために必須です。 |
stop_id | string | 条件付きで必須 | 1つ | 対応する GTFS フィードのstops.txtと同じであるしなければならないがあります。StopSelector 内ではstop_sequence またはstop_id のStopSelectorかを指定するしなければならない。両方のフィールドを空にすることはできません。 |
message SelectedTrips¶
関連する形状を持つ選択された便のリスト。
注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
trip_ids | uint32 | 多数 | 1つ | 元の (CSV) GTFS のtrip_idのリストで、含まれている置換によって影響を受けます。少なくとも 1つのtrip_idを含める必要があります。 |
shape_id | string | 必須 | 1つ | このSelectedTripsで変更された便の新しい形状のID-RT Shapemessageを使用して追加された新しい形状、または GTFS-Static フィードのshapes.txtで定義されている既存の形状を参照するしてもよいます。 |
message ReplacementStop¶
各 ReplacementStop
メッセージは、便で訪問する停留所を定義し、オプションで停留所までの推定移動時間を指定します。
注意: このフィールドはまだ実験的であり、変更される可能性があります。将来正式に採用されるしてもよいがあります。
Modificationが旅程の最初の停留所に影響する場合、その停留所はModificationの参照停留所としても機能します。
フィールド
フィールド名 | タイプ | 必須 | カーディナリティ | 説明 |
---|---|---|---|---|
stop_id | string | 必須 | 1つ | 旅程で今後訪問される代替の停留所ID-RT のStop messageを使用して追加された新しい停留所、または (CSV) GTFS フィードのstops.txt で定義されている既存の停留所をしてもよいする場合があります。停留所にはlocation_type=0 (ルート可能な停留所等) がしなければならない。 |
travel_time_to_stop | int32 | 任意 | 1つ | この停留所への到着時間と参照停留所への到着時間の差 (秒単位)。参照停留所は、start_stop_selector の前の停留所です。Modificationが便の最初の停留所で開始される場合、便の最初の停留所が参照停留所になります。この値は単調に増加するしなければならないがあり、元の便の最初の停留所が参照停留所である場合にのみ負の数になるしてもよい。 値が指定されていない場合、消費者は他のデータに基づいて travel_time_to_stop を補間または推測するしてもよい。 |