Geography
Geography API を使用して、600,000 を超える地域と空港の地理的定義と施設マッピングを表示できます。
地域 (複数)
指定されたパラメータに一致する地域の地理的定義と施設マッピングを返します。
世界中のすべての地域をリクエストするには、ancestor クエリーパラメータを省略します。特定の大陸、国、または他のレベルの地域全体をリクエストするには、その地域の ID を ancestor として指定します。以下の上位地域のリストを参照してください。
地域
リクエストした地域 ID の地理的定義と施設マッピングを返します。
この API を使用して、既知の地域 ID の地理的情報と施設マッピングを取得します。
地理的定義に含まれる施設を取得
地理的定義に基づいてカスタムポリゴン内の施設を返します。
独自の地理的定義を保持しており、Rapid の地理的地域を使用していない場合は、この API を使用して施設マッピングデータベースを構築します。複数都市、都市、周辺地域のような領域の地理的定義に施設を簡単にマッピングできます。
検索フィルターのパラメーター
3 つの検索パラメーターを使用すると、結果をさらに絞り込むことができ、お客様は検索をより正確に行うことができます。
supply_source
はエクスペディアと Vrbo のどちらが宿泊施設を供給しているかを示します。含まれていない場合、このフィルターはデフォルトでsupply_source=expedia
になります。country_code
では国を基準に結果をフィルタリングできます。type
は、都市や周辺地域などの地理エンティティを表します。country_subdivision_code
は、ISO 3166-2 国下位区分への絞り込むを可能にします。area
は地域別の検索を可能にします。詳細は下記を参照ください。
その他の参考情報
地域タイプ
type
オブジェクトは、都市や周辺地域などの地理エンティティを表します。詳細については、地域タイプのリストを参照してください。
エリア
area
オブジェクトは、キロメートル半径と中央緯度 / 経度座標または地域の境界線のいずれかと組み合わせて使用できます。
- Radius と
region_id
を組み合わせると、地域の境界から指定したキロメートル数だけすべての方向に広がるエリアを検索することになります。 - 緯度 / 経度のペアで指定した 1 点に半径を組み合わせると、指定したキロメートル半径の円を描くようにエリアが検索されます。
- 半径は、負ではない整数のキロメートルで指定する必要があります。小数点以下の数字があるとエラーになります。半径 0 は許容されます。
制限事項
- エリアパラメーターを指定する場合、結果は 100 件までに制限されますが、制限パラメーターでさらに絞り込むことができます。
- 結果数が多いため、
point_of_interest
が唯一のtype
として指定されない限り、タイプがpoint_of_interest
の地域はarea
に絞り込まれるリクエストに含まれません。 point_of_interest
が他のタイプとともに指定された場合、point_of_interest
は無視され (エラーは発生しない)、他のすべてのtype
の選択が適用されます。
**例 : **
緯度 / 経度の 50 km 以内の空港の検索 :
type=airport&limit=3&area=50,37.227924,93.310036
3km 圏内と 5km 圏内に制限した、都市 type
の地域 ID エリア検索 :
&area=5,602962&supply_score=expedia&type=city&limit=3
国下位区分コード
ISO 3166-2 国下位区分 (例 : US-MO) のみに結果を絞り込みます。country_subdivision_code
はフィールドと検索パラメーターの両方です。
例 :
ISO コードによる地域検索 :
country_subdivision_code =US-MO
ローカライズ
language
オブジェクトでは、ハイフンでつながった一対の 2 桁の言語と国のコードのみを使用できます。すべての言語オプションについてはこちらを参照してください。コードを使用する前にサポート対象言語を確認してください。応答に含まれる name
フィールドと name_full
フィールドのみが、リクエストした言語で表示されます。応答に含まれるこれ以外の地理的定義は英語で表示されます。
ポリゴン
bounding_polygon
オブジェクトには地域の形状を表す座標のリストが含まれています。地域は 1 つのポリゴンまたは複数のポリゴンのいずれかで表される領域をカバーできます。1 つの座標で表される地域タイプ (観光スポット、鉄道の駅、空港など) には境界ポリゴンがありません。
座標のリストを表示する際、bounding_polygon
オブジェクトでは、GeoJSON 規格に従い、経度、緯度の順に表示します。
地域間の関連
地域間の観光関係は、associations
オブジェクトを用いて示されます。associations
オブジェクト内、モデルにするもの :
- 空港タイプの地域の関連する都市。これにより、特定の空港の目的地を推奨できます。
- 特定の地域の上位観光スポット (POI) これにより、旅行者がカリフォルニア、ロンドン、ブルックリンなどの特定の地域を訪問しているときに、訪問する観光スポットを推奨できます。
地域間の階層
地域間の関係は、ancestors
オブジェクトと descendants
オブジェクトを用いて示されます。世界中で起きる地理学的変動や政治上の変動のため、地域タイプに確固とした階層があるわけではありません。ただし、論理的には、通常 1 つの市は、複数都市、省、州、郡などに関連付けられています。特定の地域の階層を知るには、ancestors
値を使用します。
ancestors
は、指定の地域よりも上のレベルの階層を表します。たとえば、ギリシャのアテネの複数都市の場合、祖先はアッティカ地方で、さらに階層を遡るとギリシャやヨーロッパになります。複数の親を持つ地域もあります。ジュネーブの複数都市はスイスとフランスの国境にあるため、両方の国が祖先となります。descendants
は、指定の地域よりも下のレベルの階層を表します。上記を例にとると、ギリシャの都市ピレウスはギリシャのアテネの複数都市の子孫となります。地域オブジェクト内の子孫地図にはその地域の直接の子 (1 つ下のレベル) のみが記載されます。
tags
および categories
は、パートナーが地理的特徴に関するより詳細な情報をお客様に提供できるようにします。
tags
は、実際にこれらの特徴がどのように命名されているかを反映した方法で特徴を説明することで、地理的特徴に関するより詳細な情報を提供します。例としては、アクティビティ (スキー、競馬場など)、アトラクション、都市区画、地理的な行政区画 (州、教区、地区など) の説明が含まれます。categories
はグローバルに適用可能な地理的特徴の階層を作成し、特定の国または地域の政府構造に関係なく、同等の地理レベルを提供することを目的としています。例には、大陸、国、または州が含まれます。
注 : 複数の供給元を持つパートナーは、使用する地域に独自の供給をレイヤー化する必要があります。
例 :
"categories": [
"place:administrative",
"administrative:country"
],
"tags": [
"geo-admin:country"
]
地域の施設マッピング
施設マッピングは、Region API と Regions API で提供されています。施設マッピングがある地域タイプは high_level_region
、state_province
、multi_city_vicinity
、city
、neighborhood
、point_of_interest
、select countries です。施設マッピングを利用する場合、以下の 2 つの include
パラメータオプションがあります。
property_ids
: このオプションでは地域のポリゴン内の施設のみが表示されます。ポリゴンは閉じた形状で、地域の領域を表します。property_ids_expanded
: 地域のポリゴンに含まれる施設が 100 未満の場合、このオプションではポリゴン内の施設に加え、この地域から半径 30 km 以内の施設も表示されます。このように施設群が拡張されることで、目的地の施設検索結果に十分な数の施設が表示されるようになります。ポリゴンでなく 1 つの座標で示される地域タイプ (観光スポットなど) では、該当地域に関連する施設マッピングを表示できるのはこの拡張オプションのみです。
ポリゴンは、検索データとトランザクションデータを使用するように最適化されており、最も関連性の高いポリゴンの外側の小さな領域に拡張します。
API の詳細
このページで地理関連のエンドポイント定義を調べてから、API Explorer または別のテストソフトウェアを使用して、例とスキーマ定義が実際の出力とどのように比較されるかを理解します。
その他のリソース
すべての Rapid API エンドポイントを試してみたい場合でも、OpenAPI 仕様や Postman コレクションをダウンロードしたい場合でも、必要なリソースが用意されています。