GeocodeServiceResponse オブジェクト

Geocodeサービスへのリクエストに対して返される GeocodeServiceResponse オブジェクトには、次の要素が含まれています。

totalPossibleCandidates — 可能性のある候補の総数。
totalMatches — 一致の総数。
candidates — 入力住所に一致した 1 つ以上の候補のリスト。各一致候補に対して、マッチング情報とロケーション情報が返されます。

名前	タイプ	説明
totalPossibleCandidates	Integer	可能性のある候補の総数を示します。
totalMatches	Integer	一致の総数を示します。
Candidateイプの candidates オブジェクト。1 つ以上の一致候補の配列と、関連する住所情報、一致情報、およびロケーション情報で構成されます。以下の要素を含みます。
precisionLevel	Integer	ジオコードの精度を表すコード。次のいずれかです。 0 この候補住所の座標情報はありません。 1 補間されたストリート住所。 2 ストリートセグメントの中間点。 3 郵便番号 1 セントロイド。 4 部分郵便番号 2 セントロイド。 5 郵便番号 2 セントロイド。 6 交差点。 7 POI (point-of-interest)。(データベースに POI データが含まれる場合) 8 州/省セントロイド。 9 郡セントロイド。 10 都市セントロイド。 11 地方セントロイド。 12-15 未指定のカスタム項目用に予約されています。 16 結果は住所ポイント。 17 住所ポイントデータを使って候補セグメントデータを修正することによって、結果が生成されています。 18 結果は、中央線オフセット機能を使用して投影された住所ポイント。中央線オフセット機能を使用するには、ポイントとストリート範囲の両方のデータベースが必要です。注: 米国ではこのフィールドは返されません。米国のジオコーディングの精度情報については、ロケーションコードを参照してください。
formattedStreetAddress	String	フォーマット済みのメイン住所行。
formattedLocationAddress	String	フォーマット済みの最後の住所行。
identifier	String	ストリートレベルまたはポイントレベルの候補の場合は通常、セグメント ID です。
precisionCode	String	ジオコードの精度を表すコード。ジオコード結果文字列のフォーマットは、`match_category[additional_match_information]`です。一致カテゴリには、次のものがあります。 Z1 郵便番号 1 セントロイドとの郵便番号の一致。 Z2 郵便番号 2 セントロイドとの郵便番号の部分的な一致。 Z3 郵便番号 2 セントロイドとの郵便番号の一致。 G1 エリア名 1 セントロイドとの地理的な一致。 G2 エリア名 2 セントロイドとの地理的な一致。 G3 エリア名 3 セントロイドとの地理的な一致。 G4 エリア名 4 セントロイドとの地理的な一致。 'S' カテゴリの一致は、レコードが単一の住所候補に一致したことを意味します。 SX 交差点に位置するポイント。 SC 最も近いセグメントから予測された家レベルに位置するポイントと一致。 S0 座標はありませんが、住所の一部がソースデータと一致した可能性があります。 S4 ジオコードは、ストリートセントロイドに位置します。 S5 ジオコードは、ストリート住所に位置します。 S7 ジオコードは、家の場所のポイント間を補間したストリート住所に位置します。 S8 家の場所に位置するポイントと一致。追加のマッチ情報は、`HPNTSCSZA`という形式をとります。該当するコンポーネントが一致しなかった場合は、その文字の箇所にダッシュ (-) が表示されます。 H 家番号。 P ストリートの前置方位記号。 N ストリート名。 T ストリートタイプ。 S ストリートの後置方位記号。 C 都市の名前。 Z 郵便番号。 A ジオコーディングデータセット。 U カスタムユーザ辞書。注: 国固有の意味と値の詳細については、「グローバル結果コード」を参照してください。
sourceDictionary	String	候補情報とデータのソースとなる辞書。ソースの辞書は、設定されているどの辞書から候補が得られたかを 0 基準の整数値で示します。辞書が 1 つしかない場合、この値は常に "0" になります。
Matching オブジェクト。入力のどの部分が一致したかを表します。次の要素で構成されます。
matchOnAddressNumber	Boolean	入力住所番号が候補の住所番号と一致したかどうかを表します。 True 入力住所番号は候補の住所番号と一致しています。 False 入力住所番号は候補の住所番号と一致していません。
matchOnPostCode1	Boolean	入力の postCode1 フィールドが候補の postCode1 フィールドと一致したかどうかを表します。 True 入力の postCode1 は候補の postCode1 と一致しています。 False 入力の postCode1 は候補の postCode1 と一致していません。
matchOnPostCode2	Boolean	入力の postCode2 フィールド (拡張郵便番号) が候補の postCode2 フィールドと一致したかどうかを表します。 True 入力の postCode2 は候補の postCode2 と一致しています。 False 入力の postCode2 は候補の postCode2 と一致していません。
matchOnAreaName1	Boolean	入力の areaName1 フィールドが候補の areaName1 フィールドと一致したかどうかを表します。 True 入力の areaName1 は候補の areaName1 と一致しています。 False 入力の areaName1 は候補の areaName1 と一致していません。
matchOnAreaName2	Boolean	入力の areaName2 フィールドが候補の areaName2 フィールドと一致したかどうかを表します。 True 入力の areaName2 は候補の areaName2 と一致しています。 False 入力の areaName2 は候補の areaName2 と一致していません。
matchOnAreaName3	Boolean	入力の areaName3 フィールドが候補の areaName3 フィールドと一致したかどうかを表します。 True 入力の areaName3 は候補の areaName3 と一致しています。 False 入力の areaName3 は候補の areaName3 と一致していません。
matchOnAreaName4	Boolean	入力の areaName4 フィールドが候補の areaName4 フィールドと一致したかどうかを表します。 True 入力の areaName4 は候補の areaName4 と一致しています。 False 入力の areaName4 は候補の areaName4 と一致していません。
matchOnStreetName	Boolean	入力ストリート名が候補のストリート名と一致したかどうかを表します。 True 入力ストリート名は候補のストリート名と一致しています。 False 入力ストリート名は候補のストリート名と一致していません。
matchOnStreetType	Boolean	入力ストリートタイプが候補のストリートタイプと一致したかどうかを表します。 True 入力ストリートタイプは候補のストリートタイプと一致しています。 False 入力ストリートタイプは候補のストリートタイプと一致していません。
matchOnStreetDirectional	Boolean	入力ストリート方位記号が候補のストリート方位記号と一致したかどうかを表します。 True 入力ストリート方位記号は候補のストリート方位記号と一致しています。 False 入力ストリート方位記号は候補のストリート方位記号と一致していません。
matchOnPlaceName	Boolean	入力場所名が候補の場所名と一致したかどうかを表します。 True 入力場所名は候補の場所名と一致しています。 False 入力場所名は候補の場所名と一致していません。
geometry オブジェクト。返されるジオコード。次の要素で構成されます。
coordinates	Double	候補のジオコード。x (緯度) および y (経度) 座標がカンマで区切って指定されます。
crs	String	候補のジオコードに使用される座標参照系。
type	String	ジオメトリタイプ。戻り値は常に `Point`です。

address オブジェクト。返された候補住所。以下の要素の一部を含む場合があります。
注: 次の住所要素の意味、有効値、サポートの有無は、国によって異なります。 placeName mainAddress lastLine areaName1 areaName2 areaName3 areaName4 postCode1 postCode2 country また、一部のマッチングおよびジオコーディングオプションは国によって異なります。各国に固有の情報を確認することが重要です。各国の情報については、付録にある国固有の情報セクションを参照してください。
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	マップ	候補の範囲に関連するローカル値のマップ。
units:CandidateRangeUnit オブジェクト。候補の範囲のユニットに関する情報を含みます。次の要素で構成されます。
placeName	String	候補の場所または建物の名前 (該当する場合)。
unitType	String	ユニットタイプ (APT や STE など)。
highUnitValue	String	範囲内のユニット番号の最大値。
lowUnitValue	String	範囲内のユニット番号の最小値。
customValues	マップ	ユニットに関連するローカル値のマップ。