郵便番号住所取得プラグインマニュアル

このプラグインでできること

「郵便番号住所取得プラグイン」は、レコードに入力した郵便番号から住所を自動で取得するプラグインです。
郵便番号を入力してフィールドから離れるだけで、あらかじめ指定した住所フィールドに値が入ります。
住所の入れ方は「都道府県・市区町村・番地以下に分ける」「1つのフィールドにまとめる」など、アプリの構成に合わせて選べます。
住所フィールドを入力不可にして、手入力による表記ゆれを防ぐこともできます。

郵便番号住所取得プラグインの紹介ページを見る

主な機能は次のとおりです。

郵便番号から住所を自動取得し、指定したフィールドへ入力する
郵便番号の表記を「ハイフンあり」または「数字のみ」に自動で整える
住所の入力方式を3パターンから選択する（3分割・2分割・1フィールドに結合）
住所フィールドを編集不可（入力不可）にする
郵便番号を空にすると、住所フィールドを自動でクリアする
設定内容をJSONファイルに出力し、他のアプリへ読み込む

動作環境・前提条件

2-1. 事前に必要なフィールド

プラグインを設定する前に、アプリに次のフィールドを用意してください。
指定できるフィールドが1つも無い場合、設定画面はエラー表示となり設定できません。

用途	必要なフィールドタイプ	必要数
郵便番号	文字列（1行）	1つ
住所	文字列（1行） / 文字列（複数行） / リッチエディター	選択する入力方式により1〜3つ

必要な住所フィールドの数は、「3. 住所の入力方式」でどれを選ぶかによって変わります。

住所の入力方式	必要な住所フィールド数
都道府県 / 市区町村 / 番地以下	3つ
都道府県+市区町村 / 番地以下	2つ
住所を1フィールドに結合	1つ

⚠️ 郵便番号フィールドには「文字列（1行）」しか指定できません。「数値」フィールドは選択肢に表示されません。

⚠️ テーブル（サブテーブル）の中にあるフィールドは、郵便番号・住所のどちらにも指定できません。アプリ直下に配置したフィールドをご利用ください。

2-2. 外部サービスへの通信について

住所の取得には、外部の住所検索サービスを利用します。
社内ネットワークにアクセス制限（プロキシやファイアウォールによる通信制限）がある場合は、次のドメインへの通信を許可してください。

zipcloud.ibsnet.co.jp

⚠️ 上記ドメインへの通信がブロックされていると、郵便番号を入力しても住所が入力されません。この場合、画面上にエラーメッセージは表示されません。住所が入らないときは、まずネットワーク設定をご確認ください。

設定手順

3-1. 設定画面の全体構成

設定画面は、上部のヘッダーと4つの設定セクションで構成されています。

設定画面の全体（ヘッダーと4つの設定セクション）

ヘッダーには次のボタンがあります。

ボタン	説明
「設定保存」	設定内容を保存し、アプリへ反映します
「設定出力」	現在の設定内容をJSONファイルとしてダウンロードします
「設定読込」	JSONファイルから設定内容を読み込みます
閉じるボタン（×）	設定画面を閉じ、前の画面に戻ります

💡 設定画面を開いた直後は「読み込み中...」と表示されます。フィールド情報の取得が終わると、設定項目が表示されます。

3-2. 郵便番号フィールドを設定する

郵便番号を入力するフィールドを指定します。ここで指定したフィールドへの入力が、住所取得のきっかけになります。

設定画面の「1. 郵便番号フィールド」まで画面をスクロールします。
「郵便番号」のプルダウンをクリックします。
郵便番号を入力するフィールドを選択します。

「1. 郵便番号フィールド」で、郵便番号を入力するフィールドを選ぶ

💡 プルダウンの選択肢は「フィールド名 (フィールドコード)」の形式で表示されます。同じ名前のフィールドが複数ある場合は、フィールドコード（フィールドを識別するための文字列）で見分けてください。

💡 未選択の状態では「-- 未選択 --」と表示されます。

3-3. 郵便番号の入力形式を設定する

郵便番号フィールドに保存する表記を選びます。入力した値は、ここで選んだ形式に自動で整えられます。

設定画面の「2. 郵便番号の入力形式」まで画面をスクロールします。
「ハイフンあり（123-4567）」または「数字のみ（1234567）」のどちらかを選択します。

「2. 郵便番号の入力形式」で、ハイフンありか数字のみかを選ぶ

選択肢	保存される形式
「ハイフンあり（123-4567）」	3桁目と4桁目の間にハイフンが自動で入ります
「数字のみ（1234567）」	ハイフンを除いた数字7桁になります

💡 利用者が全角数字やハイフンありで入力しても、ここで選んだ形式に自動で変換されます。入力のしかたを利用者に周知する必要はありません。

3-4. 住所の入力方式を設定する

取得した住所を、どのようにフィールドへ振り分けるかを選びます。

設定画面の「3. 住所の入力方式」まで画面をスクロールします。
3つの選択肢から、アプリの構成に合うものを選択します。

「3. 住所の入力方式」で、住所の分け方を選ぶ

選択肢	住所の分かれ方
「都道府県 / 市区町村 / 番地以下」	3つのフィールドに分けて入力します
「都道府県+市区町村 / 番地以下」	2つのフィールドに分けて入力します
「住所を1フィールドに結合」	1つのフィールドにまとめて入力します

⚠️ ここで選択した内容によって、次の「4. 紐づけフィールドと編集不可設定」に表示される項目が切り替わります。選択を変更すると表示される行も変わりますので、必ずこの項目を決めてから紐づけ設定を行ってください。

3-5. 紐づけフィールドと編集不可を設定する

取得した住所を、どのフィールドに入力するかを指定します。

設定画面の「4. 紐づけフィールドと編集不可設定」まで画面をスクロールします。
表示されている各行のプルダウンをクリックします。
住所を入力したいフィールドを選択します。
表示されているすべての行について、手順2〜3を繰り返します。

表示される行は、「3. 住所の入力方式」の選択によって次のように変わります。

住所の入力方式	表示される行
「都道府県 / 市区町村 / 番地以下」	「都道府県」「市区町村」「番地以下」
「都道府県+市区町村 / 番地以下」	「都道府県+市区町村」「番地以下」
「住所を1フィールドに結合」	「住所（全結合）」

「都道府県 / 市区町村 / 番地以下」を選んだときの紐づけ行

「都道府県+市区町村 / 番地以下」を選んだときの紐づけ行

「住所を1フィールドに結合」を選んだときの紐づけ行

💡 すでに他の項目で選択したフィールドは、他のプルダウンの選択肢から自動的に除外されます。同じフィールドを2か所に指定することはできません。

続いて、住所フィールドを手入力できないようにする場合の設定です。
設定画面には「編集不可にチェックしたフィールドは、レコード編集時に入力不可（disabled）になります。」と説明が表示されています。

入力不可にしたい行の「編集不可」チェックボックスをクリックします。
チェックが付いたことを確認します。

入力不可にしたい行の「編集不可」にチェックを付ける

💡 「編集不可」にチェックを付けると、レコードの追加画面・編集画面（PC版では一覧画面のインライン編集も）でそのフィールドが入力不可になります。住所は郵便番号から自動で入るため、手入力による表記ゆれを防ぎたい場合に有効です。

⚠️ 「番地以下」まで編集不可にすると、建物名や部屋番号を手入力できなくなります。番地や建物名を入力する運用がある場合は、「番地以下」の「編集不可」にはチェックを付けないでください。

3-6. 設定を保存する

設定画面の上部にある「設定保存」をクリックします。
画面に「設定を保存しました」と表示されることを確認します。

保存すると「設定を保存しました」と表示される

💡 「設定保存」をクリックすると、アプリへの反映（変更を反映）まで自動で行われます。設定画面を閉じたあとに、あらためて「変更を反映」を実行する必要はありません。

💡 キーボードの Ctrl キー（Macは command キー）と S キーを同時に押しても保存できます。

保存に失敗した場合は「設定の保存に失敗しました」と表示されます。時間をおいて、もう一度「設定保存」をクリックしてください。

3-7. 設定の出力・読み込み

設定内容をJSONファイルとして保存し、別のアプリへ取り込むことができます。設定のバックアップや、同じ構成のアプリへの複製に利用します。

3-7-1. 設定を出力する

設定画面の上部にある「設定出力」をクリックします。
ブラウザーのダウンロード先に、JSONファイルが保存されたことを確認します。

設定画面の上部にある「設定出力」ボタン

💡 ファイル名は「zipcode-config-（アプリID）.json」の形式で保存されます。

⚠️ 「設定出力」は、現在画面に表示されている内容を出力します。保存前の変更内容も含まれますのでご注意ください。

3-7-2. 設定を読み込む

設定画面の上部にある「設定読込」をクリックします。
ファイル選択画面で、読み込むJSONファイルを選択します。
「設定を読み込みますか？」というメッセージが表示されます。
内容を確認し、「読み込む」をクリックします。
「設定を読み込みました」と表示されることを確認します。
画面上の設定内容を確認します。
「設定保存」をクリックして確定します。

「設定を読み込みますか？」の確認ダイアログ

⚠️ 読み込むと、現在の設定はすべて上書きされます。読み込んだだけでは確定しません。必ず「設定保存」をクリックしてください。

⚠️ 読み込み先のアプリに存在しないフィールドは、取り込まれません。取り込めなかった項目がある場合は、「※ このアプリに存在しないため取り込めなかったフィールドがあります：」というメッセージとともに項目名が表示されます。その項目は、あらためて手動で選択してください。

読み込み時に表示されるメッセージは次のとおりです。

メッセージ	意味・対処
「読み込みできません」	設定できるフィールドがアプリにありません。フィールドを追加してから、もう一度お試しください
「読み込みに失敗しました」	ファイルの中身を読み取れませんでした。ファイルが壊れていないか確認してください
「設定ファイルの形式が正しくありません」	このプラグインの「設定出力」で作成したファイルを選択してください。別のプラグインで出力したファイルは読み込めません

3-8. 設定時に表示されるエラーと対処

「設定保存」をクリックしたときや設定画面を開いたときに、画面上部へ赤字でメッセージが表示されることがあります。

メッセージ	対処
「郵便番号フィールドを選択してください。」	「1. 郵便番号フィールド」でフィールドを選択してください
「（項目名）の入力先フィールドを選択してください。」	「4. 紐づけフィールドと編集不可設定」で、未選択の行のフィールドを選択してください
「同じフィールドを重複して選択しています。郵便番号・住所フィールドは別々に設定してください。」	郵便番号と住所に同じフィールドを指定しています。別々のフィールドを選択してください
「郵便番号に選択できる文字列1行フィールドがありません。」	アプリに「文字列（1行）」フィールドを追加してください
「住所の入力先に選択できる文字列フィールドがありません。」	アプリに「文字列（1行）」「文字列（複数行）」「リッチエディター」のいずれかのフィールドを追加してください
「設定画面の初期化に失敗しました。時間をおいて再度開いてください。」	一度設定画面を閉じ、時間をおいてから開き直してください

操作手順

4-1. レコードを追加するときに住所を自動入力する

アプリの一覧画面で、レコードの追加画面を開きます。
郵便番号フィールドに、郵便番号を入力します。
郵便番号フィールド以外の場所をクリックし、フィールドからフォーカスを外します。
郵便番号の表記が、設定した形式に整えられたことを確認します。
住所フィールドに住所が入力されたことを確認します。

郵便番号を入力する前のレコード追加画面

💡 住所は、フィールドからフォーカスが外れたタイミングで取得されます。入力途中では取得されません。

💡 全角数字で入力しても、半角数字に自動変換されます。ハイフンや空白が含まれていても正しく処理されます。

⚠️ 郵便番号が7桁に満たない場合は「郵便番号は7桁で入力してください。」というエラーが表示され、住所フィールドは空になります。

郵便番号が7桁に満たないときのエラー

4-2. レコードを編集するときに住所を自動入力する

レコードの詳細画面で、編集画面を開きます。
郵便番号フィールドの値を書き換えます。
郵便番号フィールド以外の場所をクリックし、フィールドからフォーカスを外します。
住所フィールドの値が、新しい郵便番号の住所に置き換わったことを確認します。
「保存」をクリックします。

⚠️ 郵便番号を変更すると、住所フィールドの値は上書きされます。番地や建物名を手入力していた場合、その内容も上書きされますのでご注意ください。

「編集不可」を設定している場合、対象の住所フィールドは入力不可の状態で表示されます。

「編集不可」を設定した住所フィールドは入力不可で表示される

4-3. 一覧画面のインライン編集で住所を自動入力する

一覧画面上でレコードを直接編集する場合も、住所の自動入力が動作します。

一覧画面で、編集したいレコードの編集アイコンをクリックします。
郵便番号フィールドに、郵便番号を入力します。
郵便番号フィールド以外の場所をクリックし、フィールドからフォーカスを外します。
住所フィールドに住所が入力されたことを確認します。
保存アイコンをクリックします。

⚠️ 一覧画面のインライン編集で動作させるには、その一覧に郵便番号フィールドと住所フィールドの両方が表示されている必要があります。一覧に表示されていないフィールドには値が入りません。

⚠️ 一覧画面のインライン編集は、パソコン（PC）版のみ対応しています。

4-4. 郵便番号を削除・変更したときの動作

郵便番号の入力状態によって、住所フィールドの動きが変わります。

郵便番号の状態	住所フィールドの動作
7桁が入力されている	住所が取得され、入力されます
1〜6桁しか入力されていない	住所が空になり、「郵便番号は7桁で入力してください。」と表示されます
空欄（すべて削除した）	住所が空になります。エラーは表示されません
該当する住所が見つからない	住所が空になります。エラーは表示されません

💡 8桁以上の数字を入力した場合は、先頭7桁だけが使われます。郵便番号フィールドの値も7桁に整えられます。

💡 住所を消したいときは、郵便番号フィールドの値をすべて削除してください。住所フィールドも自動で空になります。

4-5. 入力形式ごとの住所の入り方

住所の入力方式ごとに、フィールドへ入る値は次のようになります。

例として、取得結果が「東京都」「千代田区」「千代田」だった場合を示します。

住所の入力方式	紐づけ項目	入力される値
「都道府県 / 市区町村 / 番地以下」	「都道府県」	東京都
	「市区町村」	千代田区
	「番地以下」	千代田
「都道府県+市区町村 / 番地以下」	「都道府県+市区町村」	東京都千代田区
	「番地以下」	千代田
「住所を1フィールドに結合」	「住所（全結合）」	東京都千代田区千代田

💡 郵便番号によっては「番地以下」に相当する情報が無い場合があります。その場合、「番地以下」のフィールドは空欄になります。

💡 番地や建物名は自動では入りません。取得後に手入力してください。

4-6. モバイルでの利用

スマートフォン版（モバイル）でも、レコードの追加画面・編集画面で住所の自動入力が動作します。

モバイルでレコードの追加画面または編集画面を開きます。
郵便番号フィールドに、郵便番号を入力します。
郵便番号フィールド以外の場所をタップし、フィールドからフォーカスを外します。
住所フィールドに住所が入力されたことを確認します。

モバイルの編集画面で住所が入力された状態

⚠️ モバイルでは、一覧画面のインライン編集には対応していません。

制限事項・注意点

5-1. フィールドに関する制限

郵便番号フィールドに指定できるのは「文字列（1行）」のみです。
住所フィールドに指定できるのは「文字列（1行）」「文字列（複数行）」「リッチエディター」のみです。
テーブル（サブテーブル）の中にあるフィールドは、郵便番号・住所のどちらにも指定できません。
郵便番号と住所に、同じフィールドを指定することはできません。
郵便番号フィールドが画面に表示されていない場合、住所の自動入力は動作しません。

5-2. 動作に関する制限

住所の自動入力は、郵便番号フィールドからフォーカスが外れたときに動作します。入力途中では動作しません。
一覧画面のインライン編集はPC版のみ対応です。モバイルでは動作しません。
レコード一括更新やファイル読み込み（CSVの取り込み）では、住所の自動入力は動作しません。
設定画面で郵便番号フィールドが未選択の場合、プラグインは何も動作しません。
住所は郵便番号を基準に入力されます。番地・号・建物名・部屋番号は自動では入りません。

5-3. 通信に関する注意

住所の取得には外部の住所検索サービスを利用します。zipcloud.ibsnet.co.jp への通信を許可してください。
通信に失敗した場合、住所フィールドは変更されず、画面上にエラーメッセージも表示されません。住所が入らない場合はネットワーク環境をご確認ください。
同じ画面を開いている間、一度取得した郵便番号の結果は再利用されます。画面を再読み込みすると、あらためて取得されます。
取得できる住所は、外部の住所検索サービスが保持しているデータに基づきます。新しく設定された郵便番号などは、取得できない場合があります。

5-4. 設定変更時の注意

「3. 住所の入力方式」を変更すると、「4. 紐づけフィールドと編集不可設定」の項目が切り替わります。変更後は、必ず紐づけフィールドを設定し直してください。
すでに登録済みのレコードの住所は、設定を変更しても自動では書き換わりません。既存レコードを更新する場合は、レコードごとに郵便番号を入力し直してください。
「設定読込」で設定を読み込んだだけでは確定しません。「設定保存」をクリックしてください。

« マニュアルの一覧に戻る