GeocodeServiceResponse オブジェクト

Reverse Geocode サービスへのリクエストに対して返される GeocodeServiceResponse オブジェクトには、次の要素が含まれています。
  • totalPossibleCandidates— 可能性のある候補の総数。
  • totalMatches— 一致の総数。
  • candidatesオブジェクト — 入力座標に一致した 1 つ以上の候補のリスト。各候補に対して、マッチング情報と住所情報が返されます。
表 1. GeocodeServiceResponse 要素の定義
名前 タイプ 説明
totalPossibleCandidates Integer 可能性のある候補の総数を示します。
totalMatches Integer 一致の総数を示します。
Candidateイプの candidates オブジェクト。1 つ以上の一致候補の配列と、関連する住所情報、一致情報、およびロケーション情報で構成されます。以下の要素を含みます。
precisionLevel Integer ジオコードの精度を表すコード。次のいずれかです。
0
この候補住所の座標情報はありません。
1
補間されたストリート住所。
2
ストリートセグメントの中間点。
3
郵便番号 1 セントロイド。
4
部分郵便番号 2 セントロイド。
5
郵便番号 2 セントロイド。
6
交差点。
7
POI (ポイント情報)。(データベースに POI データが含まれる場合)
8
州/省セントロイド。
9
郡セントロイド。
10
都市セントロイド。
11
地方セントロイド。
12-15
未指定のカスタム項目用に予約されています。
16
結果は住所ポイント。
17
住所ポイント データを使って候補セグメント データを修正することによって、結果が生成されています。
18
結果は、中央線オフセット機能を使用して投影された住所ポイント。中央線オフセット機能を使用するには、ポイントとストリート範囲の両方のデータベースが必要です。
注: 米国ではこのフィールドは返されません。米国のジオコーディングの精度情報については、ロケーション コードを参照してください。
formattedStreetAddress String

フォーマット済みのメイン住所行。
formattedLocationAddress String フォーマット済みの最後の住所行。
precisionCode 文字列 返されるリバース ジオコーディング結果コードです。定義は付録に記されています。米国については住所のロケーション コードを、その他すべての国についてはリバース ジオコーディングの 'R' 結果コードを参照してください。
sourceDictionary String 候補情報とデータのソースとなる辞書。ソースの辞書は、設定されているどの辞書から候補が得られたかを 0 基準の整数値で示します。辞書が 1 つしかない場合、この値は常に "0" になります。
geometry オブジェクト。返されるジオコード。次の要素で構成されます。
coordinates Double 候補のジオコード。x (緯度) および y (経度) 座標がカンマで区切って指定されます。
crs String 候補のジオコードに使用される座標参照系。
type String ジオメトリ タイプ。戻り値は常に Pointです。
address オブジェクト。返された候補住所。以下の要素の一部を含む場合があります。
注: 次の住所要素の意味は、国によって異なります。
  • mainAddress
  • areaName1
  • areaName2
  • areaName3
  • areaName4
  • postCode1
  • postCode2

各国の情報については、詳細情報が記載された付録にある国固有の情報セクションを参照してください。
mainAddressLine String 候補の住所行。
addressLastLine String 候補の最後の住所行。
placeName String 企業、会社、組織、事業、または建物名。
areaName1 String 州、省、または地域。
areaName2 String 郡または地区。
areaName3 String 都市、町、または郊外。
areaName4 String 地方
postCode1 String 主要な郵便番号。
postCode2 String 候補住所が存在する場所の補助的な郵便番号。
country String Country
addressNumber String 家または建物番号。
streetName String ストリート名。
unitType String ユニット タイプ。Apt.、Ste.、Bldg. など。
unitValue String ユニットの値/番号。"3B" など。
customFields オブジェクト 返されるフィールドと対応する値は、国によって異なります。付録にある国固有の情報セクションを参照してください。
ranges:CandidateRange オブジェクト。候補の範囲に関する情報を含みます。次の要素で構成されます。
placeName String 候補の場所または建物の名前 (該当する場合)。
lowHouse String 候補のストリート範囲にある家番号の最小値。
highHouse String 候補のストリート範囲にある家番号の最大値。
side String 候補の範囲が、ストリートの左側と右側のどちらに存在するかという情報。
LEFT
範囲は、ストリートの左側に面しています。
RIGHT
範囲は、ストリートの右側に面しています。
BOTH
範囲は、ストリートの左側と右側の両方にあります。
UNKNOWN
範囲がストリートのどちら側に面しているかという情報はありません。
oddEvenIndicator String 候補の範囲の家番号に関する情報。
ODD
範囲には、奇数の家番号が含まれます。
EVEN
範囲には、偶数の家番号が含まれます。
BOTH
範囲には、奇数と偶数の両方の家番号が含まれます。
IRREGULAR
範囲には、奇数と偶数の両方の家番号が不規則な順序で含まれます。
UNKNOWN
範囲内の家番号が奇数か偶数かという情報はありません。
customValues マップ 候補の範囲に関連するローカル値のマップ。