Geocode POST リクエスト

POSTリクエストでは、単一の入力住所または住所リストをバッチ処理用に送信することができます。オプションでマッチングとジオコーディングの優先設定をGeocodeサービスに指定して、関連する緯度/経度座標とロケーション情報を受信することができます。POSTリクエストの優先設定オプションは、使用可能なオプションの完全集合です。

ベース URI

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

説明:

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

リクエスト パラメータ

POSTリクエストは、次の入力パラメータで構成されます。
  • addresses - ジオコーディングする 1 つ以上の住所。必須
  • type - ジオコードのタイプ。これはオプションです。
  • preferences - マッチングとジオコーディングのオプション。これはオプションです。
これらのオブジェクトとその要素の定義は、以下の表のとおりです。
パラメータ タイプ 説明
注: 次の住所要素の意味、有効値、サポートの有無は、国によって異なります。
  • placeName
  • mainAddress
  • lastLine
  • areaName1
  • areaName2
  • areaName3
  • areaName4
  • postCode1
  • postCode2
  • country

また、一部のマッチングおよびジオコーディング オプションは国によって異なります。各国に固有の情報を確認することが重要です。各国の情報については、付録にある国固有の情報セクションを参照してください。

Addressオブジェクトの addresses 配列。住所配列には、1 つ以上の入力住所を含めることができます。各 Addressオブジェクトには、次の要素を含めることができます。
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 都市の下位区分、または地方を指定します。これはオプションです。
postCode1 String 各国の標準フォーマットで表記された郵便番号。これはオプションです。
postCode2 String 各国の標準フォーマットで表記された拡張郵便番号。これはオプションです。
country String ISO 3166-1 Alpha-3 国コード。必須国コードについては、国参照一覧と ISO 3166-1 国コードを参照してください。
addressNumber String 家または建物番号。
streetName String ストリート名。
unitType String ユニット タイプを指定します。Apt.、Ste.、Bldg. など。
unitValue String ユニットの値/番号を指定します。"3B" など。
geocodeTypeタイプの type オブジェクト。
geocodeType String

実行されるジオコード タイプ。これはオプションです。

Address
ストリート住所にジオコーディングします。こちらがデフォルトです。
Geographic
都市または州の地理的セントロイドにジオコーディングします。
Postal
郵便番号にジオコーディングします。
Preferencesタイプの preferences オブジェクト。以下の要素で構成されます。
注: 以下の要素は Geocodeサービスにのみ適用可能です。
注: 特定の国の preferences 要素のデフォルト値をオーバーライドするには、customPreferences オブジェクトにキー/値のペアを、ISO-3166 の 3 文字の国コード、ピリオド、キー定数の形式で指定します。例: DEU.fallbackToGeographic
returnAllCandidateInfo Boolean 各候補に対して使用可能なすべての情報を返すかどうかを指定します。
True
各候補に対して使用可能なすべての情報を返します。
False
各候補に対して使用可能なすべての情報を返しません。こちらがデフォルトです。
fallbackToGeographic Boolean 住所レベルのジオコードを決定できない場合に、地理的セントロイドを決定しようとするかどうかを指定します。これはオプションです。
True
住所レベルのセントロイドを決定できない場合に地理的セントロイドを返します。こちらがデフォルトです。
False
住所レベルのセントロイドを決定できない場合に地理的セントロイドを返しません。
fallbackToPostal Boolean 住所レベルのジオコードを決定できない場合に、郵便番号セントロイドを決定しようとするかどうかを指定します。これはオプションです。
True
住所レベルのセントロイドを決定できない場合に郵便番号セントロイドを返します。こちらがデフォルトです。
False
住所レベルのセントロイドを決定できない場合に郵便番号セントロイドを返しません。
FALLBACK_TO_WORLD String 国ジオコーダがインストールされていないか、国ジオコーダがジオコーディング データセットなしでインストールされている場合に、World Geocoder (XWG) を使用してジオコードを決定するかどうかを指定します。World Geocoder (XWG) は、XWG ジオコーディング データセットのサポート レベルによって、郵便番号ジオコードまたは地理的ジオコードを返します。これはオプションです。
True
国ジオコーダがインストールされていないか、国ジオコーダがジオコーディング データセットなしでインストールされている場合に、World Geocoder (XWG) を使用してマッチングを行います。
False
国ジオコーダがインストールされていないか、国ジオコーダがジオコーディング データセットなしでインストールされている場合に、World Geocoder (XWG) を使用してマッチングを行いません。こちらがデフォルトです。
maxReturnedCandidates Integer 返される候補の最大数。これはオプションです。整数値でなければなりません。デフォルトは 1 です。
streetOffset Double ストリートレベルのジオコーディングに使うストリートセグメントからのオフセット距離を指定します。距離の指定は streetOffsetUnits オプションで指定した単位で行います。デフォルト値は 7 メートルです。

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

streetOffsetUnits String ストリート オフセットの距離単位を指定します。次のいずれかです。
  • フィート
  • メートル - デフォルト
cornerOffset Double ストリートレベルでのマッチングに使うストリートの終端からのオフセットを指定します。距離の指定は cornerOffsetUnits オプションで指定した単位で行います。この値は、通りの角の住所に交差点と同じジオコードが与えられるのを防ぐために使われます。角に対するジオコード ポイントのオフセット位置を定義します。デフォルト値は 7 メートルです。

以下に、ストリートの終点とオフセット終点の比較図を示します。

cornerOffsetUnits String コーナーオフセットの距離単位を指定します。次のいずれかです。
  • フィート
  • メートル - デフォルト
matchMode String マッチ モードにより、入力住所と参照データとの間のマッチングに適用される柔軟性が決まります。入力と求める出力の品質に応じて、マッチ モードを選択します。以下のマッチ モードがあります。
Exact
非常に厳格な一致を要求します。一致候補の数が最小となる制限の厳しいモードです。処理時間は短くなります。このモードを使用する際には、入力に綴りの間違いや不完全な住所などの問題がないことを確認してください。
Standard
近似一致が求められ、適度な数の一致候補が生成されます。こちらがデフォルトです。
Relaxed
あいまいな一致を許し、生成される一致候補数は最も多くなります。処理時間は長くなりますが、結果としてより多くの一致が得られます。入力に綴りの間違いや不完全な住所などの問題がないと確信できない場合は、このモードを使用します。
Custom
MustMatch フィールドを設定することによってマッチング条件を定義することができます。ただし、MustMatch フィールドはPOST リクエストを使用する場合のみ設定可能です。GETリクエストに対しては、MustMatch のデフォルト値が適用されます。MustMatch フィールドの詳細については、mustMatchFieldsを参照してください。
Interactive (USA only)
単一行住所マッチングに対してのみ使用可能です。このモードは、インタラクティブ マッチングにおける特定のマッチング問題に適切に対処することを目的に設計されています。インタラクティブ モードでは、より柔軟なマッチング パターンが可能で、緩和検索モードよりも多くの一致候補が返される場合もあります。
CASS (USA only)
USPS CASS 規格を確実に遵守するために追加ルールを適用します。このマッチ モードの目的は、USPS の料金割引を受けるために、配達可能な住所を作成することです。郵送用に入力を正規化する場合にこのモードを使用します。このモードでは、多数の一致候補が生成されます。
clientCoordSysName String ジオメトリの変換先の座標系を指定します。形式は、European Petroleum Survey Group (EPSG) コードまたは SRID コードである必要があります。デフォルトは EPSG:4326です。

codespace:codeという形式で、座標参照系を指定します。

customPreferences Map<String key, String value> 国固有の入力優先設定を指定します。このオブジェクトを使用して、以下の項目を指定できます。
  • preferencesmustMatchFields または returnFieldsDescriptor オブジェクト内の (複数の) 要素のデフォルト値に対する、国固有のオーバーライド。
  • 国に対するカスタム入力オプション。
特定の国のデフォルト値をオーバーライドするには、キー定数の前に ISO-3166 の 3 文字の国コードとピリオドを付け、値を指定します。例えば、XML リクエストでは、国のデフォルト値をオーバーライドするための入力は次のようになります。
<customPreferences>
 <entry>
  <key>USA.maxReturnedCandidates</key>
  <value>3</value>
 </entry>
</customPreferences>
国のカスタム入力オプションは、以下の国に対して提供されています。 また、カスタム ユーザ辞書と標準ジオコーディング データセットの両方をサポートしている国については、キー KEY_CUSTOM_DICTIONARY_USAGE によってカスタム優先設定を設定できます。このキーは、カスタム辞書と標準辞書の両方がジオコーディング エンジンで使用可能な場合の検索とマッチングの優先設定を定義します。このオプションは、フォワード ジオコーディングにのみ使用可能です。詳細については、標準およびカスタム辞書使用時の検索とマッチングの優先設定を参照してください。各国がカスタム ユーザ辞書をサポートしているかどうかという情報については、その国の「サポートされているジオコーディング データセット」セクションを参照してください。
preferredDictionaryOrder List<String> 複数の辞書がインストールされている場合に、辞書の検索順序を指定します。デフォルトの検索順序は、辞書が設定された順序です。
FieldsMatchingタイプの mustMatchFields オブジェクト。一致候補を判断するための一致条件を設定できます。これらのオプションを有効にするには、matchMode フィールドをCustom に設定する必要があります。このオブジェクトは、次の要素で構成されます。
注: 特定の国の mustMatchFields 要素のデフォルト値をオーバーライドするには、customPreferences オブジェクトにキー/値のペアを、ISO-3166 の 3 文字の国コード、ピリオド、キー定数の形式で指定します。例: CAN.matchOnAddressNumber
matchOnAddressNumber Boolean
True
入力住所番号が一致する必要があります。
False
入力住所番号が一致する必要はありません。こちらがデフォルトです。
matchOnPostCode1 Boolean
True
入力された PostCode1 フィールドが一致する必要があります。
False
入力された PostCode1 フィールドが一致する必要はありません。こちらがデフォルトです。
matchOnAreaName1 Boolean
True
入力された AreaName1 フィールドが一致する必要があります。
False
入力された AreaName1 フィールドが一致する必要はありません。こちらがデフォルトです。
matchOnAreaName2 Boolean
True
入力された AreaName2 フィールドが一致する必要があります。
False
入力された AreaName2 フィールドが一致する必要はありません。こちらがデフォルトです。
注: このオプションは、米国ではサポートされていません。
matchOnAreaName3 Boolean
True
入力された AreaName3 フィールドが一致する必要があります。
False
入力された AreaName3 フィールドが一致する必要はありません。こちらがデフォルトです。
matchOnAreaName4 Boolean
True
入力された AreaName4 フィールドが一致する必要があります。
False
入力された AreaName4 フィールドが一致する必要はありません。こちらがデフォルトです。
matchOnAllStreetFields Boolean
True
入力ストリート名、タイプ、方位記号の各フィールドが一致する必要があります。
False
入力ストリート名、タイプ、方位記号の各フィールドが一致する必要はありません。こちらがデフォルトです。
mustMatchInput Boolean
True
その他の「必ず一致」のフィールドは無視され、値が指定されたすべての使用可能な入力フィールド (郵便番号、エリア名など) と一致しなければ、候補は返されません。
False
その他の「必ず一致」のフィールドは有効です。値が指定されたどの特定の入力フィールドとも一致しなくても、候補は返されます。こちらがデフォルトです。
ReturnsFieldsDescriptorタイプの returnFieldsDescriptor オブジェクト。候補に対して返される追加データを制御します。デフォルトでは、拡張候補情報は返されませんが、追加の情報が使用可能な場合は、以下の方法で制御できます。
注: 特定の国の returnFieldsDescriptor 要素のデフォルト値をオーバーライドするには、customPreferences オブジェクトにキー/値のペアを、ISO-3166 の 3 文字の国コード、ピリオド、キー定数の形式で指定します。例: AUS.returnAllCustomFields
returnAllCustomFields Boolean
True
候補に対するすべてのカスタム フィールドを返します。
False
候補に対するフィールドの標準セットのみを返します。こちらがデフォルトです。
returnedCustomFieldKeys List<String> 候補の customFields 出力で返されるカスタム フィールドを表すキーのリストを指定します。例えば、“CTYST_KEY” や “DATATYPE” です。デフォルトは空です。
注: 国に対して複数のキー/値のペアを指定するには、返すカスタム フィールドの名前をスペースで区切ります。例:"USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY"。この情報を持つ候補の customFields 出力には、これらのキーを含む 3 つのカスタム フィールドがあります。
注: カスタム フィールドは国によって異なります。各国の情報については、詳細情報が記載された付録の「国固有の情報」で該当するセクションを参照してください。
returnMatchDescriptor Boolean
True
候補のどの部分が入力住所と一致したかを表す、マッチ記述子オブジェクトを返します。
False
マッチ記述子オブジェクトを返しません。こちらがデフォルトです。
returnStreetAddressFields Boolean
True
formattedStreetAddress フィールドを構成する、以下に示す個々のストリート フィールドをすべて個別に返します。
  • MAIN_ADDRESS — ストリート名の基本部分。例: “13 River Ave” の “River”
  • THOROUGHFARE_TYPE — ストリート名の前または後に付くことがある、Ave、Via、St、Rd などの大ストリートタイプ。
  • ADDRESS_ID — ソース データ内の住所に対する一意の識別子。
  • PRE_ADDRESS — 主ストリート名の前に付く冠詞などを値に含めることができます。例: “Calle de la mesa” の “de la”
  • POST_ADDRESS — 主ストリート名の後に付く語句を値に含めることができます。例: “Calle Ramon Perez de la tiedra” の "de la tiedra"
  • PRE_DIRECTIONAL — 主ストリート名の前に付く方位記号を値に含めることができます。例: “123 South Main St” の “South”
  • POST_DIRECTIONAL — 主ストリート名の後に付く方位記号を値に含めることができます。例: “123 River St SW” の “SW”
False
個々のストリート フィールドを個別に返しません。これらの値を formattedStreetAddress フィールドに入れて返します。こちらがデフォルトです。
returnUnitInformation Boolean
True
可能な場合には、単位のタイプと単位の値の情報を個別に unitType および unitValue フィールドで、また formattedStreetAddress フィールドでも返します。
False
可能な場合には、単位のタイプと単位の値の情報を formattedStreetAddress フィールドでのみ返します。こちらがデフォルトです。