返される候補に関する情報

返される標準的なフィールド セットには、次の要素が含まれます。

• 一致の総数
• 可能性のある候補の総数
• 候補住所
• 候補範囲
• マッチングされたフィールド
• ジオコード座標 (ジオコーディング操作用)
• 結果コード

これらのフィールドが返されるかどうかは、設定されているジオコーディング データセットで提供されているデータの種類に依存します。使用可能な出力フィールドとその定義については、それぞれの国のセクションを参照してください。また、カスタム出力フィールドが存在する国もあります。使用可能なカスタム出力フィールドについては、付録 A - 国固有の情報にあるそれぞれの国のセクションを参照してください。

また、次のような情報を追加で返すように指定できます。

• 返される候補の最大数。
• 候補ごとに提供可能なすべての情報を返すか、特定の住所フィールドのみを返すか。これらの追加フィールドは、returnFieldsDescriptor を使用して指定します。以下のオプションが使用可能です。
  • returnMatchDescriptor - 候補のどの部分が入力住所と一致したかを表す、マッチ記述子オブジェクトを返します。
  • returnStreetAddressFields - formattedStreetAddress フィールドを構成する、個々のストリート フィールドをすべて個別に返します。これには、メイン住所の基本部分、大ストリート タイプ、前置/後置方位記号などがあります。
  • returnUnitInformation - 可能な場合には、単位のタイプと単位の値の情報を個別に unitType および unitValue フィールドで、また formattedStreetAddress フィールドでも返します。
  • returnAllCustomFields - 候補に対するすべてのカスタム フィールドを返します。
  • returnedCustomFieldKeys - 候補の customFields 出力で返されるカスタム フィールドを表すキーのリストを指定します。例えば、“CTYST_KEY” や “DATATYPE” です。
    注: 国に対して複数のキー/値のペアを指定するには、返すカスタム フィールドの名前をスペースで区切ります。このフィールド情報を持つ候補の customFields 出力には、これらのキーを含むカスタム フィールドがあります。

    以下は REST JSON リクエストの例です。

    "preferences" : {
        "customPreferences" : {
          "USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY"
        }
    }

    注: カスタム フィールドは国によって異なります。各国の情報については、詳細情報が記載された付録の「国固有の情報」で該当するセクションを参照してください。

REST API における、追加で返す候補情報の指定

詳細については、Geocode POST リクエストを参照してください。