検索リンクの形式

検索リンクの場合、パートナーは検索固有のベース URL を提供します（パートナー構成を参照）。次のクエリ パラメータがサポートされています。

フィールド名 詳細
from_stop_id

（反復可能）ルートの始点となる可能性のある停留所の識別子。

出発駅の stop_id の値。
to_stop_id

（反復可能）ルートの終点となる可能性のある停留所の識別子。

目的地の駅の stop_id の値。
search_date

（日付）ルートの運行日です。

このフィールドには、次の形式文字列で日付が含まれます。

YYYYMMDD
lang

（IETF BCP 47、省略可）予約サイトで選択された言語を示すために使用されるフィールド。

このフィールドの値は IETF BCP 47 に準拠しています（例: en-US）。

選択した言語が利用できない場合や、フィールドが渡されない場合は、予約サイトでフォールバック言語を使用する必要があります。
cur

（ISO 4217、省略可）価格を表示する通貨を示すために使用されるフィールド。

このフィールドの値は ISO 4217 に準拠しています（例: USD）。

選択した通貨を表示できない場合や、フィールドが渡されない場合、予約サイトはフォールバック通貨を使用する必要があります。
utm_source

（文字列、省略可）トラフィックを送信した上位サイトを示すために使用されるフィールド。

有効な値は google_search と google_maps です。

すべての繰り返し可能なパラメータは JSON 配列として指定されます。from_stop_id と to_stop_id の複数の値は、出発地と目的地の複数の駅を表します。

例

この例では、ユーザーは locality1 から locality2 までの電車を検索しています。

  • locality1 は、stop_id が f1 と f2 の駅にマッピングされます。
  • locality2 は、stop_id が t1 と t2 の駅にマッピングされます。
  • サービス日は 20190716 です。

この例では、ベース URL は https://example.com です。

上記のすべての情報を定義するには、パラメータに次の値を使用します。

フィールド名 詳細
from_stop_id ["f1", "f2"]
to_stop_id ["t1", "t2"]
service_date 20190716

エンコード後の最終的な URI は次のようになります。

https://example.com?from_stop_id=%5B%22f1%22,%22f2%22%5D&to_stop_id=%5B%22t1%22,%22t2%22%5D&search_date=20190716

ランディング ページでは、20190716 に f1 駅と f2 駅を出発し、t1 駅と t2 駅に到着する旅程を確認できます。すべてのステーションの組み合わせがサポートされています。

  • f1～t1
  • f1～t2
  • f2～t1
  • f2～t2