Interface AddressSearcherOptions

AddressSearcherOptions は "searchAddresses" API に送られる パラメータを記述します。

interface AddressSearcherOptions {
    facet?: string;
    limit?: number;
    offset?: number;
    q?: string;
    t?: string;
    version?: string;
}

Properties

facet?: string

結果として返されるファセットをどのレベルで形作るかを指定する ファセット表現。

例: "/東京都"

limit?: number

取得したい項目の最大数。

指定がない場合は100と見なされます。

offset?: number

結果を取得する開始オフセット。

q?: string

The query to search against the address database.

Either q or t must be present.

Example: "東京都 AND 渋谷区"

t?: string

The unprocessed portions of the address string to search against the address database.

Either q or t must be present.

Example: "東京都渋谷区初台"

version?: string

検索を行うデータベースのバージョン。

デフォルトは利用可能な最新バージョンとなります。 例: "2021-04-30"