Citymapper (独立発行元) (プレビュー)
Citymapper を使用すると、旅の計画とターン バイ ターン方式のナビゲーションを製品に追加できます。 当社のサービスは、業界をリードするグローバルな輸送データと、何十億ものトリップで訓練されたカスタム ルーティング アルゴリズムによって支えられています。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Troy Taylor |
| [URL] | https://www.hitachisolutions.com |
| メール | ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| 発行者 | Troy Taylor |
| Web サイト | https://citymapper.com/ |
| プライバシー ポリシー | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| カテゴリ | ライフスタイルとエンターテインメント |
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| API キー | securestring | この API の API キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 2 つの場所間の移動時間を取得する |
リクエストが行われた時点で、指定された 2 地点間のさまざまな移動モードでの移動時間を決定します。 |
| 2 地点間の e スクーターの方向を取得する |
2 点間のスクートのルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 (これらの結果は、運転者が立っているバッテリー駆動の小型スクーターに最適化されています)。この呼び出しは、ライダーが「開始」地点にスクーターを持っていると仮定し、そこから「終了」地点までが Citymapper のサポートエリア内にある場合に、 e スクーターのルートを提供します。 結果のルートには、単一のスクーター区間が含まれている必要がありますが、この区間の 'path_annotations' プロパティは、ユーザーがスクーターのそばを歩くべきセクションを示している場合があります。 この呼びかけには、スクーター運転手のカバー範囲や駐車場の情報は組み込まれていませんが、他のサービスコールで対応可能な場合があります。 成功した応答 (HTTPコード '200') は、HTTP 応答ごとに 1 つの 'Scooter Route' クレジット (または 'reroute_signature' が使用されている場合は 1 つの 'Scooter Reroute' クレジット) を消費します。 呼び出しが失敗しても、クレジットは消費されません。 |
| 2 地点間のスクーターのルートを取得する |
2 点間のスクーターのルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 (この結果は、運転者が座っている大型の内燃式または電動スクーターに最適化されています)。この呼び出しは、ライダーが「開始」地点にスクーターを持っていると仮定し、そこから「終了」地点までが Citymapper のサポートエリア内にある場合に、電子スクーターのルートを提供します。 結果のルートには、単一のスクーター区間が含まれている必要がありますが、この区間の 'path_annotations' プロパティは、ユーザーがスクーターのそばを歩くべきセクションを示している場合があります。 この呼びかけには、スクーター運転手のカバー範囲や駐車場の情報は組み込まれていませんが、他のサービスコールで対応可能な場合があります。 |
| 2 地点間のタクシーのルートを取得する |
2 地点間のタクシーのルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 乗車場所または降車場所が要求された開始座標と終了座標の近くにない場合、ルートは開始および終了の歩行区間が含まれる場合があります。 応答のサービスは、ローカルの可用性、時刻、およびアカウントに構成されているタクシー サービス統合によって異なります。 このサービスを使用するには、次の 2 つの方法をお勧めします: 「?fetch_on_demand_services=true」で呼び出すことにより、事前にライブ オンデマンド サービスの見積もりを含むタクシー ルートをリクエストできます。または、非ライブ ルートで応答する見積もりを取得せずに最初のリクエストを行い、すぐに 「1/live/routeupdates」 を呼び出して追加のライブ見積もりを取得することもできます。 最初のアプローチはより単純ですが、2 番目のアプローチがユースケースにより適している場合があります。 |
| 2 地点間のレンタル e スクーターの方向を取得する |
最初と最後の徒歩区間を含む、2 点間の e スクーターのルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 これらの結果は、運転者が立つ小型のバッテリー駆動のスクーター用に最適化されています。 この呼び出しは、いくつかの異なる方法で使用できます: 指定されたブランドのスクーターを使用する これは最もシンプルなコールで、'start', 'end', 'brand_id'のみを必要とします。 Citymapper は、ユーザーが「開始」地点にいると想定し、可能であれば、指定されたブランドのスクーターを選択します。 指定された場所でスクーターを使用する 'original_vehicle_location' を 'start'、'end'、'brand_id' に追加することにより、Citymapper はスクーターが指定された場所にあると仮定したルートを計画します。 進行中のルートを更新する 計画したルートから逸脱した場合、ユーザーの現在地からの再ルーティングを含む更新されたルートを取得するために、呼び出し側は、ユーザーの「current_location」を中心に再ルーティングされるべき結果のルートの脚を示す「current_location」と「ride_state」プロパティを追加することができます。 |
| 2 地点間のレンタル スクーターのルートを取得する |
最初と最後の徒歩区間を含む、2 点間のスクーターのルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 (この結果は、運転者が座っている大型の内燃式または電動スクーターに最適化されています。) 注: 現在、結果のルートは、ユーザーが指定された場所に直接乗ることができることを前提としています。駐車場やカバレッジ ゾーンは考慮されません。 したがって、結果のルートには、「travel_mode」「walk」の最初の区間と「travel_mode」「self_piloted」の 2 番目の区間のみが含まれます。 将来のアップデートでは、駐車場とカバレッジ ゾーンが組み込まれ、最終的な「徒歩」区間が追加されます。 この呼び出しは、いくつかの異なる方法で使用できます: 指定されたブランドのスクーターを使用する これは最もシンプルなコールで、'start', 'end', 'brand_id'のみを必要とします。 Citymapper は、ユーザーが「開始」地点にいると想定し、可能であれば、指定されたブランドのスクーターを選択します。 指定された場所でスクーターを使用する 'original_vehicle_location' を 'start'、'end'、'brand_id' に追加することにより、Citymapper はスクーターが指定された場所にあると仮定したルートを計画します。 進行中のルートを更新する 計画したルートから逸脱した場合、ユーザーの現在地からの再ルーティングを含む更新されたルートを取得するために、呼び出し側は、ユーザーの「current_location」を中心に再ルーティングされるべき結果のルートの脚を示す「current_location」と「ride_state」プロパティを追加することができます。 |
| 2 地点間のレンタル自転車ルートを取得する |
最初と最後の徒歩区間を含む、2 点間のレンタル自転車ルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 この呼び出しは、いくつかの異なる方法で使用できます: 指定されたブランドの自転車を使用する これは最もシンプルなコールで、'start', 'end', 'brand_id'のみを必要とします。 Citymapper は、ユーザーが「開始」地点にいると想定し、可能であれば、指定されたブランドの自転車を選択します。 指定された場所で自転車を使用する 'original_vehicle_location' を 'start'、'end'、'brand_id' に追加することにより、Citymapper は自転車が指定された場所にあると仮定したルートを計画します。 進行中のルートを更新する 計画したルートから逸脱した場合、ユーザーの現在地からの再ルーティングを含む更新されたルートを取得するために、呼び出し側は、ユーザーの「current_location」を中心に再ルーティングされるべき結果のルートの脚を示す「current_location」と「ride_state」プロパティを追加することができます。 |
| 2 地点間の自転車ルートを取得する |
2 点間の自転車ルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 この呼び出しは、ライダーが「スタート」地点に自転車を持っていると仮定し、そこから「エンド」地点までが Citymapper のサポートエリア内であれば、自転車ルートを提供します。 結果のルートには、単一の自転車区間が含まれている必要がありますが、この区間の 'path_annotations' プロパティは、ユーザーが自転車のそばを歩くべきセクションを示している場合があります。 この呼びかけには、自転車運転手のカバー範囲や駐車場の情報は組み込まれていませんが、他のサービスコールで対応可能な場合があります。 本サービスでは、始点と終点間の最大大圏間距離を 200km に制限しています。 |
| 2 地点間の運転ルートを取得する |
2 点間の運転ルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 この呼び出しは、ライダーが「スタート」地点に車を持っていると仮定し、そこから「エンド」地点までが Citymapper のサポートエリア内であれば、車の運転ルートを提供します。 結果のルートには、単一の車区間が含まれている必要があります。 本サービスでは、始点と終点間の最大大圏間距離を 1000km に制限しています。 |
| 2 点間の徒歩経路を取得する |
2 点間の徒歩ルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 徒歩ルートは、「travel_mode」が「walk」の 1 つの区間であることが期待されます。 Citymapper がこれらの地点の徒歩経路を計算できない場合 (一般的にカバレッジの理由から)、サービスはコード「400」応答を返します。 本サービスでは、始点と終点間の最大大圏間距離を 100km に制限しています。 |
| 2 点間の通過経路を取得する |
2 地点間の複数の公共交通機関のルートを計算します。 既定では、結果には最大 5 つのルートが含まれます。 通常、ルートの最初と最後に 「travel_mode」 が 「walk」 のものが 1 つずつ、その間に少なくとも 「travel_mode」 が 「transit」 のものが 1 つあります。 |
| シナリオの 2 点間のルートを取得する |
指定されたシナリオに基づいて 2 点間のルートを計算します。 シナリオに応じて、ルートの 1 つ以上のグループを提供できます。 各グループには複数のルートが含まれます。 各ルートには 1 つ以上の区間が含まれます。 |
| 複数のルートの出発と空席情報をライブで取得 |
これにより、「方向」エンドポイントから以前に取得した複数のルートの現在およびライブの出発情報とライブのオンデマンド見積もりが取得されます。 このサービスを使用して更新できるのは、区間の更新可能な詳細を持つ区間が少なくとも 1 つあるルートのみです。 Citymapper が現在の時刻やライブの出発および区間の混乱情報を常に提供できるとは限らないことに注意してください。 成功した応答 (HTTPコード「200」) は、HTTP 応答ごとに 1 つの「Live Update」クレジットを消費します。 呼び出しが失敗しても、クレジットは消費されません。 |
2 つの場所間の移動時間を取得する
リクエストが行われた時点で、指定された 2 地点間のさまざまな移動モードでの移動時間を決定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | string |
ルートの地理的な開始点です。WGS84 の「緯度,経度」フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 |
|
末尾
|
end | True | string |
ルートの地理的な終了地点です。WGS84 の「緯度,経度」フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 |
|
移動の種類
|
traveltime_types | array |
リクエストを試行するさまざまな移動時間タイプのカンマ区切りのリストです。 各リクエスト値は、応答の特定のフィールドに対応します (応答フィールドは、Citymapper がその移動時間タイプの時間を計算できた場合にのみ存在します)。 |値 |応答プロパティ |説明 | | ----- | ----------------- | ------------| |徒歩 | walk_travel_time_minutes |ウォーキング | |トランジット |トランジット時間分 |公共交通機関旅行 | |自転車 |自転車時間分 |自転車旅行 (全行程)| |スクーター | scooter_time_minutes |立ち乗りeスクーター旅行 (全道乗車)| |スクーター | motorscooter_time_minutes |着席スクーター旅行 (全行程) | |車 | car_time_minutes |車での移動 (全行程)。 エンタープライズ プランでのみ利用可能 |このフィールドが省略されているか空の場合、既定値の「walk,transit」が使用されます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
歩行時間
|
walk_travel_time_minutes | integer |
指定された 2 地点間の推定歩行時間 (分単位)。 |
|
移動時間
|
transit_time_minutes | integer |
指定された 2 地点間の公共交通機関の所要時間 (分単位)。 |
|
自転車での時間
|
bike_time_minutes | integer |
2 地点間の自転車移動時間の推定値 (分単位)。 |
|
スクーターでの時間
|
scooter_time_minutes | integer |
2 地点間の e スクーターでの移動時間の推定値 (分単位)。 |
|
モータースクーターでの時間
|
motorscooter_time_minutes | integer |
2 地点間の モータースクーターでの移動時間の推定値 (分単位)。 |
|
運転時間
|
car_time_minutes | integer |
2 地点間の車での移動時間の推定値 (分単位)。 |
2 地点間の e スクーターの方向を取得する
2 点間のスクートのルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 (これらの結果は、運転者が立っているバッテリー駆動の小型スクーターに最適化されています)。この呼び出しは、ライダーが「開始」地点にスクーターを持っていると仮定し、そこから「終了」地点までが Citymapper のサポートエリア内にある場合に、 e スクーターのルートを提供します。 結果のルートには、単一のスクーター区間が含まれている必要がありますが、この区間の 'path_annotations' プロパティは、ユーザーがスクーターのそばを歩くべきセクションを示している場合があります。 この呼びかけには、スクーター運転手のカバー範囲や駐車場の情報は組み込まれていませんが、他のサービスコールで対応可能な場合があります。 成功した応答 (HTTPコード '200') は、HTTP 応答ごとに 1 つの 'Scooter Route' クレジット (または 'reroute_signature' が使用されている場合は 1 つの 'Scooter Reroute' クレジット) を消費します。 呼び出しが失敗しても、クレジットは消費されません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
署名の再ルーティング
|
reroute_signature | string |
再ルーティング (ユーザーの更新位置を考慮した以前の応答への更新を要求) する場合、この値には元のルートで提供された「署名」を設定する必要があります。 これにより、更新されたルートをより効率的に決定できます。 この値は URL エンコードする必要があります。 このパラメーターを指定する場合、'current_location' (該当する場合) または 'start' の場所は、ユーザーの最新の場所に設定する必要があります。 このパラメータが含まれている場合、Citymapper は元のリクエストと大きく異なる場合、例えば「終了」地点が異なる場合や、元のリクエストから 1 時間以上経過している場合、結果を返さない場合があります。 |
|
|
開始方位
|
start_bearing | integer |
北を 0、東を 90 としたとき、北から時計回りに 0 から 359 の間の角度。 この方位は、最初の指示文や経路に影響を与えるために使用されます。最も一般的なのは、現在の方位で継続することで同等の経路が得られる場合、ユーザーにUターンを要求されるのを避けるためです。 これは、ルートの最初の移動方向に影響を与えたい場合にのみ指定する必要があります。 |
|
|
過去のロケーション
|
past_loc_coords | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去にいた場所の座標を最大 10 件までカンマ区切りで指定します。 座標は WGS84 の 'latitude,longitude' 形式である必要があります。 座標は 10 進数である必要があり、最初の6桁の精度のみが使用されます。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の場所の年齢
|
past_loc_ages | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーの過去の所在地を最大10件までカンマ区切りにで指定します。 Ages は現在地からの秒数を整数で指定する必要があります。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_coords」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の位置精度
|
past_loc_accuracies | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去に滞在した場所の GPS 精度を 10 件までカンマ区切りで指定します。 精度は整数メートルでなければなりません。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_coords」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 地点間のスクーターのルートを取得する
2 点間のスクーターのルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 (この結果は、運転者が座っている大型の内燃式または電動スクーターに最適化されています)。この呼び出しは、ライダーが「開始」地点にスクーターを持っていると仮定し、そこから「終了」地点までが Citymapper のサポートエリア内にある場合に、電子スクーターのルートを提供します。 結果のルートには、単一のスクーター区間が含まれている必要がありますが、この区間の 'path_annotations' プロパティは、ユーザーがスクーターのそばを歩くべきセクションを示している場合があります。 この呼びかけには、スクーター運転手のカバー範囲や駐車場の情報は組み込まれていませんが、他のサービスコールで対応可能な場合があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
署名の再ルーティング
|
reroute_signature | string |
再ルーティング (ユーザーの更新位置を考慮した以前の応答への更新を要求) する場合、この値には元のルートで提供された「署名」を設定する必要があります。 これにより、更新されたルートをより効率的に決定できます。 この値は URL エンコードする必要があります。 このパラメーターを指定する場合、'current_location' (該当する場合) または 'start' の場所は、ユーザーの最新の場所に設定する必要があります。 このパラメータが含まれている場合、Citymapper は元のリクエストと大きく異なる場合、例えば「終了」地点が異なる場合や、元のリクエストから 1 時間以上経過している場合、結果を返さない場合があります。 |
|
|
開始方位
|
start_bearing | integer |
北を 0、東を 90 としたとき、北から時計回りに 0 から 359 の間の角度。 この方位は、最初の指示文や経路に影響を与えるために使用されます。最も一般的なのは、現在の方位で継続することで同等の経路が得られる場合、ユーザーにUターンを要求されるのを避けるためです。 これは、ルートの最初の移動方向に影響を与えたい場合にのみ指定する必要があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 地点間のタクシーのルートを取得する
2 地点間のタクシーのルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 乗車場所または降車場所が要求された開始座標と終了座標の近くにない場合、ルートは開始および終了の歩行区間が含まれる場合があります。 応答のサービスは、ローカルの可用性、時刻、およびアカウントに構成されているタクシー サービス統合によって異なります。 このサービスを使用するには、次の 2 つの方法をお勧めします: 「?fetch_on_demand_services=true」で呼び出すことにより、事前にライブ オンデマンド サービスの見積もりを含むタクシー ルートをリクエストできます。または、非ライブ ルートで応答する見積もりを取得せずに最初のリクエストを行い、すぐに 「1/live/routeupdates」 を呼び出して追加のライブ見積もりを取得することもできます。 最初のアプローチはより単純ですが、2 番目のアプローチがユースケースにより適している場合があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
オン ドメイン サービスを取得する
|
fetch_on_demand_services | string |
「true」に設定すると、タクシー サービス統合から追加情報が要求され、より正確で完全な料金、所要時間、およびサービスの可用性が提供され、オンデマンド区間の更新可能な詳細に返されます。 そのため、経路の始点と終点をこれらの第三者サービスに送信する必要があり、一方がユーザーの現在地または直近の位置である場合を含みます。 適用される法律や規制によっては、これを「true」に設定するために、エンド ユーザーから明示的なインフォームド コンセントが必要になる場合があることに注意してください。 「false」に設定するか、省略した場合、サードパーティ サービスへのリクエストは行われません。 |
|
|
ブランド ID
|
brand_ids | array |
このルート リクエストを制限するブランド ID のカンマ区切りのリストです。 省略した場合 (既定)、利用可能なすべてのブランドのタクシー ルートが返されます。 |
|
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 地点間のレンタル e スクーターの方向を取得する
最初と最後の徒歩区間を含む、2 点間の e スクーターのルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 これらの結果は、運転者が立つ小型のバッテリー駆動のスクーター用に最適化されています。 この呼び出しは、いくつかの異なる方法で使用できます: 指定されたブランドのスクーターを使用する これは最もシンプルなコールで、'start', 'end', 'brand_id'のみを必要とします。 Citymapper は、ユーザーが「開始」地点にいると想定し、可能であれば、指定されたブランドのスクーターを選択します。 指定された場所でスクーターを使用する 'original_vehicle_location' を 'start'、'end'、'brand_id' に追加することにより、Citymapper はスクーターが指定された場所にあると仮定したルートを計画します。 進行中のルートを更新する 計画したルートから逸脱した場合、ユーザーの現在地からの再ルーティングを含む更新されたルートを取得するために、呼び出し側は、ユーザーの「current_location」を中心に再ルーティングされるべき結果のルートの脚を示す「current_location」と「ride_state」プロパティを追加することができます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
ブランド ID
|
brand_id | True | string |
このルートに使用する e スクーターのブランドの ID です。 これは、利用可能なスクーターの場所と、関連するカバレッジおよび駐車制限を決定するために必要です。 |
|
状態
|
ride_state | string |
ユーザーがルート上のどこにいるかを示します。 省略した場合、「walking_to_vehicle」が使用されます。 このプロパティを「current_location」とともに使用すると、ユーザーの現在の進行状況を反映する更新されたルートを取得できます。 | 値 | 説明 | | ----- | ----------- | | 車両への歩行 | ユーザーが車両を受け取るために歩いていることを示す | | ライディング |ユーザーが車両に乗っていることを示す | | 最後まで歩く |ユーザーが車両を離れ、目的地に向かって歩いていることを示す | |
|
|
現在の場所
|
current_location | string |
ユーザーの位置に基づいてルートを更新するための、ユーザーの現在の位置です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 このパラメーターは、ユーザーがルートで指定されたパスから分岐した場合に、ユーザーの実際の場所を反映する更新されたルートを取得するために使用されます。 これが指定されている場合、返されるルートにはこの場所が含まれます。 ルートのどの区間にこの場所が含まれるかは、「ride_state」パラメータの値によって決定されます。 |
|
|
開始場所
|
ride_start_location | string |
ルートに沿ったユーザーの移動の車両乗車部分の開始時に使用される車両の場所です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 これは、「ride_state」が「riding」または「walking_to_end」の場合に指定する必要があります。 「ride_state」が「walking_to_vehicle」のときに指定されていない場合 (または指定されていない場合)、Citymapper は指定された「brand_id」に属する最も適切な車両を見つけようとします。 互換性のため、「original_vehicle_location」 はこのパラメータのエイリアスとなります |
|
|
終了場所
|
ride_end_location | string |
ユーザーが走行した経路のうち、乗車終了時に降車した場所です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 これは、「ride_state」が「riding」または「walking_to_end」の場合に指定する必要があります。 他のすべての状態では、このパラメーターは無視されます。 |
|
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
署名の再ルーティング
|
reroute_signature | string |
再ルーティング (ユーザーの更新位置を考慮した以前の応答への更新を要求) する場合、この値には元のルートで提供された「署名」を設定する必要があります。 これにより、更新されたルートをより効率的に決定できます。 この値は URL エンコードする必要があります。 このパラメーターを指定する場合、'current_location' (該当する場合) または 'start' の場所は、ユーザーの最新の場所に設定する必要があります。 このパラメータが含まれている場合、Citymapper は元のリクエストと大きく異なる場合、例えば「終了」地点が異なる場合や、元のリクエストから 1 時間以上経過している場合、結果を返さない場合があります。 |
|
|
開始方位
|
start_bearing | integer |
北を 0、東を 90 としたとき、北から時計回りに 0 から 359 の間の角度。 この方位は、最初の指示文や経路に影響を与えるために使用されます。最も一般的なのは、現在の方位で継続することで同等の経路が得られる場合、ユーザーにUターンを要求されるのを避けるためです。 これは、ルートの最初の移動方向に影響を与えたい場合にのみ指定する必要があります。 |
|
|
過去のロケーション
|
past_loc_coords | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去にいた場所の座標を最大 10 件までカンマ区切りで指定します。 座標は WGS84 の 'latitude,longitude' 形式である必要があります。 座標は 10 進数である必要があり、最初の6桁の精度のみが使用されます。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の場所の年齢
|
past_loc_ages | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーの過去の所在地を最大10件までカンマ区切りにで指定します。 Ages は現在地からの秒数を整数で指定する必要があります。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_coords」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の位置精度
|
past_loc_accuracies | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去に滞在した場所の GPS 精度を 10 件までカンマ区切りで指定します。 精度は整数メートルでなければなりません。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_coords」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 地点間のレンタル スクーターのルートを取得する
最初と最後の徒歩区間を含む、2 点間のスクーターのルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 (この結果は、運転者が座っている大型の内燃式または電動スクーターに最適化されています。) 注: 現在、結果のルートは、ユーザーが指定された場所に直接乗ることができることを前提としています。駐車場やカバレッジ ゾーンは考慮されません。 したがって、結果のルートには、「travel_mode」「walk」の最初の区間と「travel_mode」「self_piloted」の 2 番目の区間のみが含まれます。 将来のアップデートでは、駐車場とカバレッジ ゾーンが組み込まれ、最終的な「徒歩」区間が追加されます。 この呼び出しは、いくつかの異なる方法で使用できます: 指定されたブランドのスクーターを使用する これは最もシンプルなコールで、'start', 'end', 'brand_id'のみを必要とします。 Citymapper は、ユーザーが「開始」地点にいると想定し、可能であれば、指定されたブランドのスクーターを選択します。 指定された場所でスクーターを使用する 'original_vehicle_location' を 'start'、'end'、'brand_id' に追加することにより、Citymapper はスクーターが指定された場所にあると仮定したルートを計画します。 進行中のルートを更新する 計画したルートから逸脱した場合、ユーザーの現在地からの再ルーティングを含む更新されたルートを取得するために、呼び出し側は、ユーザーの「current_location」を中心に再ルーティングされるべき結果のルートの脚を示す「current_location」と「ride_state」プロパティを追加することができます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
ブランド ID
|
brand_id | True | string |
このルートに使用するスクーターのブランドの ID です。 これは、利用可能なスクーターの場所と、関連するカバレッジおよび駐車制限を決定するために必要です。 |
|
状態
|
ride_state | string |
ユーザーがルート上のどこにいるかを示します。 省略した場合、「walking_to_vehicle」が使用されます。 このプロパティを「current_location」とともに使用すると、ユーザーの現在の進行状況を反映する更新されたルートを取得できます。 | 値 | 説明 | | ----- | ----------- | | 車両への歩行 | ユーザーが車両を受け取るために歩いていることを示す | | ライディング |ユーザーが車両に乗っていることを示す | | 最後まで歩く |ユーザーが車両を離れ、目的地に向かって歩いていることを示す | |
|
|
現在の場所
|
current_location | string |
ユーザーの位置に基づいてルートを更新するための、ユーザーの現在の位置です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 このパラメーターは、ユーザーがルートで指定されたパスから分岐した場合に、ユーザーの実際の場所を反映する更新されたルートを取得するために使用されます。 これが指定されている場合、返されるルートにはこの場所が含まれます。 ルートのどの区間にこの場所が含まれるかは、「ride_state」パラメータの値によって決定されます。 |
|
|
開始場所
|
ride_start_location | string |
ルートに沿ったユーザーの移動の車両乗車部分の開始時に使用される車両の場所です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 これは、「ride_state」が「riding」または「walking_to_end」の場合に指定する必要があります。 「ride_state」が「walking_to_vehicle」のときに指定されていない場合 (または指定されていない場合)、Citymapper は指定された「brand_id」に属する最も適切な車両を見つけようとします。 互換性のため、「original_vehicle_location」 はこのパラメータのエイリアスとなります |
|
|
終了場所
|
ride_end_location | string |
ユーザーが走行した経路のうち、乗車終了時に降車した場所です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 これは、「ride_state」が「riding」または「walking_to_end」の場合に指定する必要があります。 他のすべての状態では、このパラメーターは無視されます。 |
|
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
署名の再ルーティング
|
reroute_signature | string |
再ルーティング (ユーザーの更新位置を考慮した以前の応答への更新を要求) する場合、この値には元のルートで提供された「署名」を設定する必要があります。 これにより、更新されたルートをより効率的に決定できます。 この値は URL エンコードする必要があります。 このパラメーターを指定する場合、'current_location' (該当する場合) または 'start' の場所は、ユーザーの最新の場所に設定する必要があります。 このパラメータが含まれている場合、Citymapper は元のリクエストと大きく異なる場合、例えば「終了」地点が異なる場合や、元のリクエストから 1 時間以上経過している場合、結果を返さない場合があります。 |
|
|
開始方位
|
start_bearing | integer |
北を 0、東を 90 としたとき、北から時計回りに 0 から 359 の間の角度。 この方位は、最初の指示文や経路に影響を与えるために使用されます。最も一般的なのは、現在の方位で継続することで同等の経路が得られる場合、ユーザーにUターンを要求されるのを避けるためです。 これは、ルートの最初の移動方向に影響を与えたい場合にのみ指定する必要があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 地点間のレンタル自転車ルートを取得する
最初と最後の徒歩区間を含む、2 点間のレンタル自転車ルートを取得します。 その結果、ルートは地図上に表示するために十分な情報と、推定される時間が表示されます。 この呼び出しは、いくつかの異なる方法で使用できます: 指定されたブランドの自転車を使用する これは最もシンプルなコールで、'start', 'end', 'brand_id'のみを必要とします。 Citymapper は、ユーザーが「開始」地点にいると想定し、可能であれば、指定されたブランドの自転車を選択します。 指定された場所で自転車を使用する 'original_vehicle_location' を 'start'、'end'、'brand_id' に追加することにより、Citymapper は自転車が指定された場所にあると仮定したルートを計画します。 進行中のルートを更新する 計画したルートから逸脱した場合、ユーザーの現在地からの再ルーティングを含む更新されたルートを取得するために、呼び出し側は、ユーザーの「current_location」を中心に再ルーティングされるべき結果のルートの脚を示す「current_location」と「ride_state」プロパティを追加することができます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
ブランド ID
|
brand_id | True | string |
このルートに使用する自転車のブランドの ID です。 これは、利用可能な自転車の場所と、関連するカバレッジおよび駐車制限を決定するために必要です。 |
|
状態
|
ride_state | string |
ユーザーがルート上のどこにいるかを示します。 省略した場合、「walking_to_vehicle」が使用されます。 このプロパティを「current_location」とともに使用すると、ユーザーの現在の進行状況を反映する更新されたルートを取得できます。 | 値 | 説明 | | ----- | ----------- | | 車両への歩行 | ユーザーが車両を受け取るために歩いていることを示す | | ライディング |ユーザーが車両に乗っていることを示す | | 最後まで歩く |ユーザーが車両を離れ、目的地に向かって歩いていることを示す | |
|
|
現在の場所
|
current_location | string |
ユーザーの位置に基づいてルートを更新するための、ユーザーの現在の位置です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 このパラメーターは、ユーザーがルートで指定されたパスから分岐した場合に、ユーザーの実際の場所を反映する更新されたルートを取得するために使用されます。 これが指定されている場合、返されるルートにはこの場所が含まれます。 ルートのどの区間にこの場所が含まれるかは、「ride_state」パラメータの値によって決定されます。 |
|
|
開始場所
|
ride_start_location | string |
ルートに沿ったユーザーの移動の車両乗車部分の開始時に使用される車両の場所です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 これは、「ride_state」が「riding」または「walking_to_end」の場合に指定する必要があります。 「ride_state」が「walking_to_vehicle」のときに指定されていない場合 (または指定されていない場合)、Citymapper は指定された「brand_id」に属する最も適切な車両を見つけようとします。 互換性のため、「original_vehicle_location」 はこのパラメータのエイリアスとなります |
|
|
終了場所
|
ride_end_location | string |
ユーザーが走行した経路のうち、乗車終了時に降車した場所です。 WGS84 '緯度、経度' 形式で提供されます。 座標は 10 進数である必要があり、最初の 6 桁の精度のみが使用されます。 これは、「ride_state」が「riding」または「walking_to_end」の場合に指定する必要があります。 他のすべての状態では、このパラメーターは無視されます。 |
|
|
プロファイル
|
profiles | string |
自転車ルートを計算するときに使用する「プロファイル」を示します。 各プロファイルは異なるルート オプションを生成できるため、通常、より多くのプロファイルを要求すると、より多くのオプションが提供されます。 結果として得られるルートの一部が同じになる場合もあり (1 つのルートが複数の方法で最適化される場合)、プロファイルが常にルートをもたらすとは限らないことに注意してください。 |値 |説明 | | ----- | ----------- | | 静かな |交通量の少ない道路を利用する試み | | レギュラー |既定のプロファイルは、トラフィックと直接性をバランスさせる| |高速 |最短の賢明なルートを見つける試み |プロファイルが指定されていない場合は、「通常」が使用されます。 |
|
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
署名の再ルーティング
|
reroute_signature | string |
再ルーティング (ユーザーの更新位置を考慮した以前の応答への更新を要求) する場合、この値には元のルートで提供された「署名」を設定する必要があります。 これにより、更新されたルートをより効率的に決定できます。 この値は URL エンコードする必要があります。 このパラメーターを指定する場合、'current_location' (該当する場合) または 'start' の場所は、ユーザーの最新の場所に設定する必要があります。 このパラメータが含まれている場合、Citymapper は元のリクエストと大きく異なる場合、例えば「終了」地点が異なる場合や、元のリクエストから 1 時間以上経過している場合、結果を返さない場合があります。 |
|
|
開始方位
|
start_bearing | integer |
北を 0、東を 90 としたとき、北から時計回りに 0 から 359 の間の角度。 この方位は、最初の指示文や経路に影響を与えるために使用されます。最も一般的なのは、現在の方位で継続することで同等の経路が得られる場合、ユーザーにUターンを要求されるのを避けるためです。 これは、ルートの最初の移動方向に影響を与えたい場合にのみ指定する必要があります。 |
|
|
過去のロケーション
|
past_loc_coords | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去にいた場所の座標を最大 10 件までカンマ区切りで指定します。 座標は WGS84 の 'latitude,longitude' 形式である必要があります。 座標は 10 進数である必要があり、最初の6桁の精度のみが使用されます。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の場所の年齢
|
past_loc_ages | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーの過去の所在地を最大10件までカンマ区切りにで指定します。 Ages は現在地からの秒数を整数で指定する必要があります。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_coords」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の位置精度
|
past_loc_accuracies | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去に滞在した場所の GPS 精度を 10 件までカンマ区切りで指定します。 精度は整数メートルでなければなりません。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_coords」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 地点間の自転車ルートを取得する
2 点間の自転車ルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 この呼び出しは、ライダーが「スタート」地点に自転車を持っていると仮定し、そこから「エンド」地点までが Citymapper のサポートエリア内であれば、自転車ルートを提供します。 結果のルートには、単一の自転車区間が含まれている必要がありますが、この区間の 'path_annotations' プロパティは、ユーザーが自転車のそばを歩くべきセクションを示している場合があります。 この呼びかけには、自転車運転手のカバー範囲や駐車場の情報は組み込まれていませんが、他のサービスコールで対応可能な場合があります。 本サービスでは、始点と終点間の最大大圏間距離を 200km に制限しています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
プロファイル
|
profiles | string |
自転車ルートを計算するときに使用する「プロファイル」を示します。 各プロファイルは異なるルート オプションを生成できるため、通常、より多くのプロファイルを要求すると、より多くのオプションが提供されます。 結果として得られるルートの一部が同じになる場合もあり (1 つのルートが複数の方法で最適化される場合)、プロファイルが常にルートをもたらすとは限らないことに注意してください。 |値 |説明 | | ----- | ----------- | | 静かな |交通量の少ない道路を利用する試み | | レギュラー |既定のプロファイルは、トラフィックと直接性をバランスさせる| |高速 |最短の賢明なルートを見つける試み |プロファイルが指定されていない場合は、「通常」が使用されます。 |
|
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
署名の再ルーティング
|
reroute_signature | string |
再ルーティング (ユーザーの更新位置を考慮した以前の応答への更新を要求) する場合、この値には元のルートで提供された「署名」を設定する必要があります。 これにより、更新されたルートをより効率的に決定できます。 この値は URL エンコードする必要があります。 このパラメーターを指定する場合、'current_location' (該当する場合) または 'start' の場所は、ユーザーの最新の場所に設定する必要があります。 このパラメータが含まれている場合、Citymapper は元のリクエストと大きく異なる場合、例えば「終了」地点が異なる場合や、元のリクエストから 1 時間以上経過している場合、結果を返さない場合があります。 |
|
|
開始方位
|
start_bearing | integer |
北を 0、東を 90 としたとき、北から時計回りに 0 から 359 の間の角度。 この方位は、最初の指示文や経路に影響を与えるために使用されます。最も一般的なのは、現在の方位で継続することで同等の経路が得られる場合、ユーザーにUターンを要求されるのを避けるためです。 これは、ルートの最初の移動方向に影響を与えたい場合にのみ指定する必要があります。 |
|
|
過去のロケーション
|
past_loc_coords | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去にいた場所の座標を最大 10 件までカンマ区切りで指定します。 座標は WGS84 の 'latitude,longitude' 形式である必要があります。 座標は 10 進数である必要があり、最初の6桁の精度のみが使用されます。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の場所の年齢
|
past_loc_ages | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーの過去の所在地を最大10件までカンマ区切りにで指定します。 Ages は現在地からの秒数を整数で指定する必要があります。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_coords」と「past_loc_accuracies」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
|
|
過去の位置精度
|
past_loc_accuracies | string |
再ルーティングの動作を改善するオプションのパラメーター。 ユーザーが過去に滞在した場所の GPS 精度を 10 件までカンマ区切りで指定します。 精度は整数メートルでなければなりません。 最新のものを最後に、時系列順に並べる必要があります。 「past_loc_ages」と「past_loc_coords」を一緒に指定する必要があります。 サーバーは最大 10 地点までしか考慮しません。10 地点以上提供された場合、最も新しい地点は無視されます。 サーバーは、30 秒以上前の場所や1秒未満の間隔を無視する可能性があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 地点間の運転ルートを取得する
2 点間の運転ルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 この呼び出しは、ライダーが「スタート」地点に車を持っていると仮定し、そこから「エンド」地点までが Citymapper のサポートエリア内であれば、車の運転ルートを提供します。 結果のルートには、単一の車区間が含まれている必要があります。 本サービスでは、始点と終点間の最大大圏間距離を 1000km に制限しています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 点間の徒歩経路を取得する
2 点間の徒歩ルートを取得し、地図上に表示するのに十分な情報と推定所要時間を提供します。 徒歩ルートは、「travel_mode」が「walk」の 1 つの区間であることが期待されます。 Citymapper がこれらの地点の徒歩経路を計算できない場合 (一般的にカバレッジの理由から)、サービスはコード「400」応答を返します。 本サービスでは、始点と終点間の最大大圏間距離を 100km に制限しています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
プロファイル
|
profiles | string |
徒歩ルートを計算するときに使用する「プロファイル」を示します。 各プロファイルは異なるルート オプションを生成できるため、通常、より多くのプロファイルを要求すると、より多くのオプションが提供されます。 結果として得られるルートの一部が同じになる場合もあり (1 つのルートが複数の方法で最適化される場合)、プロファイルが常にルートをもたらすとは限らないことに注意してください。 すべてのプロファイルがすべての開始ルートと終了ルートで使用できるわけではありません。 利用できないプロファイルは、応答から省略されます。 |値 |説明 | | ----- | ----------- | |高速 |既定のプロファイルは、最も速く実用的なルートを見つけようとします | | メイン道路 |裏通りや公園を避けようとする |プロファイルが指定されていない場合は、'fast' が使用されます。 |
|
|
署名の再ルーティング
|
reroute_signature | string |
再ルーティング (ユーザーの更新位置を考慮した以前の応答への更新を要求) する場合、この値には元のルートで提供された「署名」を設定する必要があります。 これにより、更新されたルートをより効率的に決定できます。 この値は URL エンコードする必要があります。 このパラメーターを指定する場合、'current_location' (該当する場合) または 'start' の場所は、ユーザーの最新の場所に設定する必要があります。 このパラメータが含まれている場合、Citymapper は元のリクエストと大きく異なる場合、例えば「終了」地点が異なる場合や、元のリクエストから 1 時間以上経過している場合、結果を返さない場合があります。 |
|
|
開始方位
|
start_bearing | integer |
北を 0、東を 90 としたとき、北から時計回りに 0 から 359 の間の角度。 この方位は、最初の指示文や経路に影響を与えるために使用されます。最も一般的なのは、現在の方位で継続することで同等の経路が得られる場合、ユーザーにUターンを要求されるのを避けるためです。 これは、ルートの最初の移動方向に影響を与えたい場合にのみ指定する必要があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
2 点間の通過経路を取得する
2 地点間の複数の公共交通機関のルートを計算します。 既定では、結果には最大 5 つのルートが含まれます。 通常、ルートの最初と最後に 「travel_mode」 が 「walk」 のものが 1 つずつ、その間に少なくとも 「travel_mode」 が 「transit」 のものが 1 つあります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
時間
|
time | string |
道案内をする際に、出発時間や到着時間の制約として使用する時間です。 時刻は、 ISO 8601 形式で表され、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
|
時間の種類
|
time_type | string |
「time」 値が指定された場合、返される方向を制限するためにどのように時間が使われるかが決定されます。 これが指定されていない場合は、「depart_approximate」 が使用されます。 「時間」が指定されていない場合、これは効果がありません。 | 値 |説明 | | ----- | ----------- | | 到着 |ユーザーが「時間」またはそれ以前に目的地に到着する方向が選択される| |出発 |方向は、ユーザーが「時間」の後にできるだけ早く出発点を離れると仮定して選択される | |おおよその出発 |「depart」に似ていますが、出発が少し遅れた場合でも、より好ましいオプションを返すために、後で出発できるようにします。 これは、時間が指定されていない場合に、Citymapper がルートを選択する既定の方法です | |
|
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
|
|
Limit
|
limit | integer |
返すルートの最大数です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
シナリオの 2 点間のルートを取得する
指定されたシナリオに基づいて 2 点間のルートを計算します。 シナリオに応じて、ルートの 1 つ以上のグループを提供できます。 各グループには複数のルートが含まれます。 各ルートには 1 つ以上の区間が含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シナリオ ID
|
scenario_id | True | string |
案内用のシナリオ ID です。 |
|
先頭
|
start | True | array |
ルートの地理的な開始点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
末尾
|
end | True | array |
ルートの地理的な終了点。WGS84 の 「latitude,longitude」 フォーマットで表されます。 座標は 10 進数である必要があり、最初の 6 桁のみが使用されます。 |
|
時間
|
time | string |
道案内をする際に、出発時間や到着時間の制約として使用する時間です。 時刻は、 ISO 8601 形式で表され、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
|
時間の種類
|
time_type | string |
「time」 値が指定された場合、返される方向を制限するためにどのように時間が使われるかが決定されます。 これが指定されていない場合は、「depart_approximate」 が使用されます。 「時間」が指定されていない場合、これは効果がありません。 | 値 |説明 | | ----- | ----------- | | 到着 |ユーザーが「時間」またはそれ以前に目的地に到着する方向が選択される| |出発 |方向は、ユーザーが「時間」の後にできるだけ早く出発点を離れると仮定して選択される | |おおよその出発 |「depart」に似ていますが、出発が少し遅れた場合でも、より好ましいオプションを返すために、後で出発できるようにします。 これは、時間が指定されていない場合に、Citymapper がルートを選択する既定の方法です | |
|
|
Language
|
language | string |
エンドユーザーの言語設定を示す IETF BCP 47 言語タグ。 提供された場合、応答には、応答のローカライズ可能な要素 (回転指示など) に使用される言語を示す「言語」プロパティが含まれます。 この言語は、表明された優先順位を満たすための最善の試みですが、 リクエストで表明されていない値を含むかもしれない(これは通常、予備として 'en-US' になります)。 言語設定は、通常、旋回指示など Citymapper が生成するコンテンツにのみ影響することに注意してください。 ストップ名やステータスの説明などの外部コンテンツは、通常、元の言語で渡されます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
経度
|
routes.start.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.start.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
経度
|
routes.end.coordinates.lat | float |
WGS84 エンコーディングの緯度で、10 進精度は 6 桁です。 |
|
緯度
|
routes.end.coordinates.lon | float |
WGS84 エンコーディングの経度で、10 進精度は 6 桁です。 |
|
メートル単位の距離
|
routes.distance_meters | integer |
ルート全体の距離をメートルで表示します。 |
|
長さ
|
routes.duration_seconds | integer |
応答で選択された車両または出発に基づいた、ルート全体を通過するための全体の推定時間 (秒単位)。 |
|
期間の精度
|
routes.duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
書式設定済み
|
routes.price.formatted | string |
フォーマットされた文字列として指定された価格。 既定では、これはルートが発生する地域のネイティブ通貨形式です。 |
|
Amount
|
routes.price.amount | string |
浮動小数点数の精度の問題を回避するために文字列としてエンコードされた 10 進数値としての価格。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も低い料金金額
|
routes.price.amount_range_minimum | string |
この 価格が取り得る値の範囲を表している場合は、最小値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 |
|
最も高い料金金額
|
routes.price.amount_range_maximum | string |
この 価格が取り得る値の範囲を表している場合は、最大値を 10 進数で表し、浮動小数点数の精度の問題を回避するために文字列としてエンコードされます。 通貨記号は含まれず、主要単位と下位単位の区切りは、地域に関係なく常に「.」になります。 範囲が制限されていない場合、これは含まれない場合があります |
|
通貨型
|
routes.price.currency | string |
ISO 4217 形式の 3 文字の価格で表示される通貨です。 |
|
需要乗数
|
routes.price.demand_multipler | float |
通常、タクシー (オンデマンド) 区間の需要があるため、価格が通常より高いことを示します。 まれに 1.0 未満になる場合があります |
|
CO2e 排出量
|
routes.emissions_grams_co2e | float |
ルートの温室効果ガス排出量の推定値で、二酸化炭素換算 (CO2e) のグラム数で表されます。 |
|
脚
|
routes.legs | array of object |
ルートを構成する区間の配列で、通過する順番に並べたもの。 すべての有効なルートには、少なくとも 1 つのルートがあります。 |
|
移動モード
|
routes.legs.travel_mode | string |
移動モードです。 |
|
長さ
|
routes.legs.duration_seconds | integer |
この区間を横断するのに必要な時間 (開始時の待ち時間や搭乗時間を除く)。 また、デュレーションの計算ができない場合、まれに省略する場合があります。 |
|
Path
|
routes.legs.path | string |
区間を横断する地理的経路です。Google のポリライン形式でエンコードされた一連の WGS84 座標で、小数点以下は 5 桁の精度で表されます。 例えば、値 「_flyHbjPDZBTBNDJ」 は、以下の一連の (緯度、経度) 座標をエンコードします: "[(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
方法
|
routes.legs.instructions | array of object |
これは、歩行時やスクーターや自転車の使用時など、ユーザーがナビゲートする必要がある区間をガイドするターン指示のリストを提供します。 |
|
パス インデックス
|
routes.legs.instructions.path_index | integer |
区間の「パス」プロパティによって提供される座標のリストへの 0 ベースのインデックスです。 これは、その指示に従うべき場所を示すため、パスの曲がり角の場所、または区間の開始点または終了点となります。 |
|
Distance
|
routes.legs.instructions.distance_meters | integer |
この指示の前の「パス」のセクションの距離 (メートル)。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
時間
|
routes.legs.instructions.time_seconds | integer |
この命令の前に、ユーザーが「パス」 のセクションを横断するのにかかると予想される時間 (秒単位) です。 タイプ「depart」の最初の指示では、このプロパティは省略されます。 |
|
Description
|
routes.legs.instructions.description_text | string |
ユーザーへの命令の平文の説明です。 |
|
説明の形式
|
routes.legs.instructions.description_format | string |
要素が強調された命令をレンダリングするためのテキスト形式。ここで、'{key}' は、'description_format_replacements' の 'key' に対応するエントリによって定義されたコンテンツに置き換える必要がある文字列の一部を示します。 これにより、必要に応じて、置換によって記述された要素をクライアントが別の形式にすることができます。 キー文字列には、文字「[a-zA-Z0-9]」のみが含まれます。 '{ }' はネストされず、リテラル文字 '{' と '}' はそれぞれエスケープシーケンス '{' と '}' で符号化されます。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
「description_format」の「{}」で囲まれた文字列に対応するキー。 |
|
Text
|
routes.legs.instructions.description_format_replacements.text | string |
「description_format」の「{key}」部分文字列の置き換えに使用されるテキスト。 |
|
タイプ
|
routes.legs.instructions.description_format_replacements.type | string |
この形式の置換によって識別される現実世界の種類を示す値。 これにより、サービス クライアントは、必要に応じてアプリケーション固有のフォーマットを適用できます。 | 値 |説明 | | ----- | -------- | | 通り名 | 通り、道路、またはその他の道路の名前 | | 出口番号 |一般的にロータリーからの出口の番号 | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
関連する「テキスト」の言語を示す IETF BCP 47 言語タグ。 これは周囲の説明文の言語と異なる可能性があることに注意してください。これは、置換対象が現地語の地名で、説明が別の言語である場合によくあることです。 |
|
タイプ
|
routes.legs.instructions.type | string |
指示の種類を示します。 |
|
タイプの方向性
|
routes.legs.instructions.type_direction | string |
この命令を変更する方向を示します。 |
|
出発時間
|
routes.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
routes.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 「route_departure_time」と「route_arrival_time」の更新された値は、更新された出発情報を反映して「service/1/live/routeupdates」で返されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Group ID
|
routes.route_metadata.groups.group_id | string |
ルートが含まれるグループの ID です。 |
|
Group
|
routes.route_metadata.groups.group_name | string |
ルート グループのローカライズされた名前 (「トランジット」または「ル メトロ」など)。 |
|
ルート ポジション
|
routes.route_metadata.groups.route_position | integer |
特定のグループ内の経路の位置をゼロベースで表したもの。 |
|
プロファイル名
|
routes.route_metadata.profile_name | string |
「プロファイル」識別子の人間が読めるローカライズされた名前。 |
|
Profile
|
routes.profile | string |
このルートの計算に使用されたルーティング「プロファイル」を示します。 たとえば、自転車ルート エンドポイント からの応答は、複数のルートを返す場合があります。1 つは「静かな」プロファイルを持ち、もう 1 つは「速い」プロファイルを持っています。 新しい値はいつでも追加できるため、このフィールドを解析するコードは予期しない値を処理できる必要があることに注意してください。 この値は、特定のルーティング プロファイルの選択をサポートするエンドポイントの「プロファイル」要求パラメーターと一致します。 この値は、機械可読のみを目的としています。 ユーザーに表示するプロファイル名については、代わりに「route_metadata」オブジェクトの「profile_name」を使用してください。 |
|
署名
|
routes.signature | string |
このルートを参照するために後続の呼び出しでサーバーに戻される値 (たとえば、「service/1/live/routeupdates」を介してライブの出発情報を要求する場合)。 不透明な値としてあつかうう必要があります。 |
|
要求された時間
|
routes.requested_time | string |
該当する場合、ルート案内を取得するときに出発または到着時間の制約として使用される「時間」パラメーターが含まれます。 |
|
要求された時間のタイプ
|
routes.requested_time_type | string |
該当する場合、返される方向を制約するために「時間」がどのように使用されるかを決定するために使用される「time_type」パラメータが含まれます。 リクエストでパラメータが指定されていない場合、ルートを計画するために既定で使用される「time_type」が返されます。 |
|
Language
|
language | string |
この応答で回転指示などのローカライズ可能なコンテンツをエンコードするために使用される言語を示す IETF BCP 47 言語タグです。 これは、'language' リクエスト パラメータまたは既定の 'en-US' で表される言語設定を満たすための最善の試みを反映します。 |
複数のルートの出発と空席情報をライブで取得
これにより、「方向」エンドポイントから以前に取得した複数のルートの現在およびライブの出発情報とライブのオンデマンド見積もりが取得されます。 このサービスを使用して更新できるのは、区間の更新可能な詳細を持つ区間が少なくとも 1 つあるルートのみです。 Citymapper が現在の時刻やライブの出発および区間の混乱情報を常に提供できるとは限らないことに注意してください。 成功した応答 (HTTPコード「200」) は、HTTP 応答ごとに 1 つの「Live Update」クレジットを消費します。 呼び出しが失敗しても、クレジットは消費されません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
署名
|
signatures | True | array of string |
以前に取得したルートからの '署名' プロパティの配列 |
|
オン デマンド サービスを取得する
|
fetch_on_demand_services | boolean |
更新可能な詳細を含むオンデマンド レッグを含むルートからの 1 つ以上の署名を使用して更新する場合 (例: タクシー ルート案内サービスから)、これが「true」に設定されている場合、より正確で完全な情報を提供するためにタクシー サービス統合から追加情報が要求されます。価格、期間、サービスの可用性。 そのため、オリジナルの経路の始点と終点をこれらの第三者サービスに送信する必要があり、一方がユーザーの現在地または直近の位置である場合を含みます。 適用される法律や規制によっては、これを「true」に設定するために、エンド ユーザーから明示的なインフォームド コンセントが必要になる場合があることに注意してください。 「false」に設定するか、省略した場合、サードパーティ サービスへのリクエストは行われません。 このパラメーターが「true」に設定されていないと、区間の更新を生成できない場合、応答は更新可能な詳細内でこれを示します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
区間の更新
|
route_updates.leg_updates | array of |
これは、更新可能な詳細オブジェクトの並列配列であり、更新される元のルートの各区間に 1 つずつあります。 徒歩区間に対応するものは空になりますが、トランジット区間に対応する詳細には更新された出発情報が含まれます。 |
|
出発時間
|
route_updates.route_departure_time | string |
利用可能な出発情報をもとに、ユーザーがこのルートに出発すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
到着時刻
|
route_updates.route_arrival_time | string |
利用可能な出発情報と予想される移動速度から、ユーザーがこのルートの終点に到着すると Citymapper が見なす時刻です。 これは、ユーザーがルートの開始点にいると仮定して計算されます。 時刻は、 ISO 8601 形式で表され、イベントが発生した日付、時刻、タイムゾーンが含まれます。 たとえば、「2020-08-19T08:10:42-04:00」は、東部夏時間で2020年8月19日午前8時10分を表します。 |
|
長さ
|
route_updates.route_duration_seconds | integer |
ルート全体を横断するための全体の推定時間 (秒単位)。 この値は、このルート更新応答に含まれる特定の出発情報を使用するために再計算されるため、元のルートの「duration_seconds」値を置き換えます。 たとえば、関係するサービスが稼働していないため、与えられた時間にルートを完了できない場合など、持続時間が計算できない稀な状況では、省略される場合があります。 |
|
DurationAccuracy
|
route_updates.route_duration_accuracy | string |
「duration_seconds」の精度レベルをどのようにユーザーに表示すべきかに関する「Citymapper」の評価。 これは、主に時刻に使用される「出発地」の「種類」に基づいていますが、Citymapper アプリのために時間をかけて開発された追加のヒューリスティックが含まれています。 このフィールドが提供されていない場合は、値「scheduled」を使用する必要があります。 |値 | 説明 | | ----- | ----------- | |推定 |その計算には通常よりも多くの不確実性が含まれているため、おおよその期間と見なす必要があります。 これは最も低い精度です。 | |予定 | 通常、公開された時刻表情報に基づく通常の期間です。 | | ライブ | 主にリアルタイム/ライブの出発情報に基づく期間です。 これは最も高い精度です。 | |
|
署名の要求
|
route_updates.request_signature | string |
これは更新要求からのルート「署名」であり、この更新を正しいルートに関連付けるために使用する必要があります。 |