REST API 機能
モジュールには、デフォルト値とオプションの制御とカスタマイズを行うための REST API メソッドが含まれます。
| REST メソッド | 説明 |
|---|---|
| Data.AddressLine1 | 単一行入力 |
| Data.Category | POI (Point of Interest) カテゴリ |
| Data.City | 検索する都市。AddressLine1 と組み合わせることによって、ターゲット エリア内の候補を返します。 |
| Data.Country | 検索する国を指定 (3 文字の ISO 国コード)。 |
| Data.OriginLatitude | 原点の Y 座標。 |
| Data.OriginLongitude | 原点の X 座標。 |
| Data.PostalCode | Postcode |
| Data.StateProvince | 州または省 |
| Option.BBoxEast | 境界ボックスの東側の境界を表す座標。 |
| Option.BBoxNorth | 境界ボックスの北側の境界を表す座標。 |
| Option.BBoxSouth | 境界ボックスの南側の境界を表す座標。 |
| Option.BBoxWest | 境界ボックスの西側の境界を表す座標。 |
| Option.BoundingBox | 検索を境界ボックスの座標に限定します。 |
| Option.CoordinateSystem | 使用する座標系。現在は EPSG:4326 のみがサポートされています。 |
| Option.Database | Management Console で設定されるデータベースの名前を指定します。複数のデータベースが使用可能である場合は、必須です。 |
| Option.DatabaseSearchOrder | 複数のデータベースが使用可能である場合は、データベースの検索順序を指定します。通常は、読み込まれた順序でデータベースが検索されます。例えば、2, 1, 3, 4 と順序を入力してデフォルトの順序をオーバーライドすることができます。 |
| Option.DefaultCountryCode | Data.Country が指定されない場合のデフォルトの国 (3 文字の ISO 国コード)。 |
| Option.DistanceFromOrigin | XY 検索中心点からの最大距離で指定する検索エリア範囲。 |
| Option.FuzzyMatch | ファジー マッチの種類として、Hard_Match、Soft_Match、または None を指定します。デフォルトは None です。 |
| Option.GeoCompleteDictionaryPreference | 住所辞書またはユーザ辞書 (その国に対するカスタム ユーザ辞書がある場合) に対する辞書の優先設定を指定します。値は、AD_ONLY (住所辞書のみ)、UD_ONLY (ユーザ辞書のみ)、PREFER_AD (住所辞書を優先)、PREFER_UD (ユーザ辞書を優先)、または BOTH_AD_UD (優先設定なしで両方を使用) です。デフォルトは BOTH_AD_UD です。 |
| Option.GeoCompleteLevel | GeoComplete 検索レベル。GeoCompleteAddress、GeoCompletePOI、GeoCompleteCategory、GeoCompleteALL、または FindNearestPOI が指定できます。デフォルトは GeoCompleteALL です。POI データのライセンスを取得してインストールしなければ、GeoCompletePOI、GeoCompleteCategory、および FindNearestPOI は候補を返さず、GeoCompleteAll はストリート候補しか返しません。 |
| Option.Locale | ロケールは、最も近い POI の検索に対してのみ有効です。英語は常に使用可能であり、デフォルトのロケールです。POI カテゴリとサブカテゴリがローカライズされている場合は、[ネイティブ] も選択できます。ネイティブとは、その国の現地語のことです。 注: このオプションは、POI データのライセンスを取得してインストールした場合のみ使用可能です。
|
| Option.MatchOnAddressNumber | 住所番号の一致が必須かどうかを指定します。デフォルトでは、住所番号の一致は必須ではありません。 |
| Option.MaxCandidates | 返す候補の最大数 (1 ～ 100)。または、許容される最大数の候補 (100) を返す場合は -1 を指定します。 |
| Option.NoRestriction | GeoComplete 検索において、距離を制限しません。 |
| Option.Path | オプションのパス。 |
| Option.SearchDistance | 与えられた原点から候補を検索する距離 (半径) を指定します。距離の単位は、SearchRadiusUnits メソッドで定義されます。この距離は、検索距離の制限にも使用されます。 |
| Option.SearchRadiusUnit | Option.SearchDistance で使用する単位。値は、KILOMETERS、MILES、METERS、または FEET です。Management Console で優先設定を変更しない限り、デフォルトは KILOMETERS です。 |