AddressSearcherQueryは検索クエリとその中に含まれる住所要素を表現します。

interface AddressSearcherQuery {
    block_lot_num: null | string;
    building: null | string;
    city: null | string;
    city_ward: null | string;
    county: null | string;
    floor_room: null | string;
    kyoto_street: null | string;
    prefecture: null | string;
    q: null | string;
    t: null | string;
    town: null | string;
}

Properties

block_lot_num: null | string

「番地」「丁目・番・号」といった要素を表す文字列を正規化し、ハイフンで繋いだ数字としたもの

例: "3-12-14"

building: null | string

建物名 (階名を含まない)

例: "麹町駅前ヒルトップ"

city: null | string

郡や政令指定都市の行政区を含まない市町村及び東京都特別区の名前。

例: "各務原市"

city_ward: null | string

政令指定都市の行政区名。

例: "北区"

county: null | string

郡名。

例: "秩父郡"

floor_room: null | string

階名 (部屋番号等を含む場合がある)

例: "8階801"

kyoto_street: null | string

京都市の特定地域に固有の指示的なフレーズからなる副地域 (通り名)。

例:

  • "先斗町通蛸薬師上る"
  • "大宮通寺之内半丁下る東入"
prefecture: null | string

都道府県名。

例: "東京都"

q: null | string

The query that the search has been performed for.

t: null | string

The unprocessed portions of the address string that the search has been performed for.

town: null | string

町名。

例: 箱石