Geocode GET リクエスト

GETリクエストでは、入力住所と、マッチングおよびジオコーディングの優先設定をGeocode サービスに送信し、候補オブジェクトを提示するレスポンスを受信することができます。候補オブジェクトには、関連する緯度/経度座標や、各候補に関するその他のマッチング情報およびロケーション情報が含まれます。GETリクエストの優先設定オプションは、POST リクエストで使用可能なすべてのオプションのサブセットです。

ベース URI

http://<server>:<port>/rest/GlobalGeocode/geocode.[content type]

説明:

.[content type] は、指定されたコンテンツ タイプがデフォルトで使用されることを示します。これはオプションです。
json
JSONコンテンツ ネゴシエーションによって置き換えられない限り、デフォルトのコンテンツ タイプは HTTP です
xml
XMLコンテンツ ネゴシエーションによって置き換えられない限り、デフォルトのコンテンツ タイプは HTTP です

[query parameters] については、次のセクションで説明します。リクエストで入力されたキー/値の各ペアは、アンパサンド (&&) で区切られています。

クエリ パラメータ

以下の表に、GETサービスに対するGeocode クエリ パラメータを示します。レスポンスの詳細については、GeocodeServiceResponse オブジェクトを参照してください。

パラメータ タイプ 説明
注: 次の住所要素の意味、有効値、サポートの有無は、国によって異なります。
  • placeName
  • mainAddress
  • lastLine
  • areaName1
  • areaName2
  • areaName3
  • areaName4
  • postCode1
  • postCode2
  • country

また、一部のマッチングおよびジオコーディング オプションは国によって異なります。各国に固有の情報を確認することが重要です。各国の情報については、付録にある国固有の情報セクションを参照してください。
placeName String 入力住所に関連する建物名、場所名、POI (ポイント情報)、会社または企業名。これはオプションです。例:

Pitney Bowes
4750 Walnut St.
Boulder, CO 80301
mainAddress String 単一行入力 — 他のフィールドが全く入力されていない場合、mainAddress の内容は単一行入力として処理され、複数の住所フィールド要素をまとめて入力することができます。住所フィールドの入力順序は、その国の通常の住所書式に従う必要があります。これはオプションです。例:

4750 Walnut St., Boulder CO, 80301

ストリート住所 — 住所フィールド (placeName、lastLine、postalCode など) が個別に入力されている場合、このフィールドの内容はストリート住所として処理され、会社名、家番号、建物名、およびストリート名を含むことができます。これはオプションです。

交差点の入力—交差点を入力するには、2 個のアンパサンド (&&) で区切られた 2 つのストリート名を指定します。
lastLine String 住所の最終行。これはオプションです。
areaName1 String 最大の地理的地域を指定します。通常は、州または省です。これはオプションです。
areaName2 String 二次的な地理的地域を指定します。通常は、郡または地区です。これはオプションです。
areaName3 String 都市または町の名前を指定します。これはオプションです。
areaName4 String 都市の下位区分、または地方を指定します。これはオプションです。
postalCode String 各国の標準フォーマットで表記された郵便番号。これはオプションです。
country String ISO 3166-1 Alpha-3 国コード。必須国コードについては、国参照一覧と ISO 3166-1 国コードを参照してください。
matchMode String マッチ モードにより、入力住所と参照データとの間のマッチングに適用される柔軟性が決まります。入力と求める出力の品質に応じて、マッチ モードを選択します。以下のマッチ モードがあります。
Exact
非常に厳格な一致を要求します。一致候補の数が最小となる制限の厳しいモードです。処理時間は短くなります。このモードを使用する際には、入力に綴りの間違いや不完全な住所などの問題がないことを確認してください。
Standard
近似一致が求められ、適度な数の一致候補が生成されます。こちらがデフォルトです。
Relaxed
あいまいな一致を許し、生成される一致候補数は最も多くなります。処理時間は長くなりますが、結果としてより多くの一致が得られます。入力に綴りの間違いや不完全な住所などの問題がないと確信できない場合は、このモードを使用します。
Custom
MustMatch フィールドを設定することによってマッチング条件を定義することができます。ただし、MustMatch フィールドはPOST リクエストを使用する場合のみ設定可能です。GETリクエストに対しては、MustMatch のデフォルト値が適用されます。MustMatch フィールドの詳細については、mustMatchFieldsを参照してください。
Interactive (USA only)
単一行住所マッチングに対してのみ使用可能です。このモードは、インタラクティブ マッチングにおける特定のマッチング問題に適切に対処することを目的に設計されています。インタラクティブ モードでは、より柔軟なマッチング パターンが可能で、緩和検索モードよりも多くの一致候補が返される場合もあります。
CASS (USA only)
USPS CASS 規格を確実に遵守するために追加ルールを適用します。このマッチ モードの目的は、USPS の料金割引を受けるために、配達可能な住所を作成することです。郵送用に入力を正規化する場合にこのモードを使用します。このモードでは、多数の一致候補が生成されます。
fallbackGeo Boolean 住所レベルのジオコードを決定できない場合に、地理的セントロイドを決定しようとするかどうかを指定します。これはオプションです。
True
住所レベルのセントロイドを決定できない場合に地理的セントロイドを返します。こちらがデフォルトです。
False
住所レベルのセントロイドを決定できない場合に地理的セントロイドを返しません。
fallbackPostal Boolean 住所レベルのジオコードを決定できない場合に、郵便番号セントロイドを決定しようとするかどうかを指定します。これはオプションです。
True
住所レベルのセントロイドを決定できない場合に郵便番号セントロイドを返します。こちらがデフォルトです。
False
住所レベルのセントロイドを決定できない場合に郵便番号セントロイドを返しません。
maxCands Integer 返される候補の最大数。これはオプションです。整数値でなければなりません。デフォルトは 1 です。
streetOffset Double ストリートレベルのジオコーディングに使うストリートセグメントからのオフセット距離を指定します。距離の指定は streetOffsetUnits オプションで指定した単位で行います。デフォルト値は 7 メートルです。

オフセット距離は、ジオコードがストリートの中央に位置付けられるのを防ぐために、ストリートレベルのジオコーディングで使われます。ストリートレベルのジオコーディングを行うと、住所が位置するストリートの中心点の緯度/経度が返されますが、これを補正するのがオフセットです。住所が指し示す建物はストリートの真上に建っているわけではないので、路上のポイントに相当する住所のジオコードが返されるのは不都合です。ジオコードは、ストリートに面して建つ建物の場所を表している必要があります。例えば、50 フィートのオフセットは、ジオコードがストリートの中心から 50 フィート離れた場所を表すことを意味します。距離は、住所のストリートセグメントから垂直方向に計算されます。また、オフセットは、ストリートをはさんで向かい合う住所が同じポイントになるのを防ぐ目的にも使われます。以下に、オフセット ポイントと元のポイントとの比較図を示します。
streetOffsetUnits String ストリート オフセットの距離単位を指定します。次のいずれかです。
  • フィート
  • メートル - デフォルト
cornerOffset Double ストリートレベルでのマッチングに使うストリートの終端からのオフセットを指定します。距離の指定は cornerOffsetUnits オプションで指定した単位で行います。この値は、通りの角の住所に交差点と同じジオコードが与えられるのを防ぐために使われます。角に対するジオコード ポイントのオフセット位置を定義します。デフォルト値は 7 メートルです。

以下に、ストリートの終点とオフセット終点の比較図を示します。
cornerOffsetUnits String コーナーオフセットの距離単位を指定します。次のいずれかです。
  • フィート
  • メートル - デフォルト