Guide
KOKOCAL QUiCK PANELの使い方
自分のGoogle Driveに作成したセルフホスト型Apps Scriptライブラリを使い、Googleスプレッドシート、スライド、ドキュメントで共通の定型入力サイドパネルを使うためのガイドです。 別ファイルへ展開するときに、各ファイル側で作成するコード量を減らせます。
サイドバーUIと主要ロジックをユーザー自身のDrive上のライブラリに集約します。
各ファイル側にはメニュー、診断、dispatch関数だけを配置します。
Sheets、Slides、Docsで同じDBリストと検索UIを使う設計です。
このツールでできること
KOKOCAL QUiCK PANELは、スプレッドシートを定型文DBとして登録し、A列のラベル、B列の属性、C列の値をサイドパネルから検索・コピー・入力するためのツールです。
生成されるコードには、Drive上のスタンドアロンApps Scriptへ貼るライブラリ本体用ファイルと、各Googleファイル側へ貼るクライアントアダプター用ファイルが含まれます。 サイドバーHTMLからはKOKOCAL_QuickPanel_dispatchを経由して、セルフホスト型ライブラリの処理を呼び出します。
ライブラリ構成
ライブラリ本体
KOKOCAL_QuickPanel_Library.gsとKOKOCAL_QuickPanel_Sidebar.htmlで、サイドバーUI、DB管理、アプリ判定、挿入処理を持ちます。
クライアントアダプター
KOKOCAL_Menu.gsとKOKOCAL_QuickPanel_Client.gsで、メニュー、診断、dispatch関数だけを持ちます。
Identifier固定
ライブラリ追加時のIdentifierはKOKOCAL_QUICK_PANEL_LIBで固定です。ジェネレーター画面で入力する必要はありません。
dispatch方式
google.script.runからライブラリ内部を直接呼ばず、クライアント側の公開関数で中継します。
固定仕様
ジェネレーター画面で選択する項目はメニュー表示言語だけです。その他の値は、迷わず導入できるようKOKOCAL QUiCK PANEL側で固定しています。
入力モード
カーソル位置へ入力し、選択範囲がある場合は置換します。入力できない場所ではコピー機能を使います。
DB読込キャッシュ
登録したスプレッドシートDBの読込結果は5分間キャッシュします。
最大読込行数
1タブあたり最大1000行まで読み込みます。A列ラベル、B列属性、C列値を読み込み対象にします。
ライブラリIdentifier
個別ファイル側でライブラリを追加するときはKOKOCAL_QUICK_PANEL_LIBを入力します。
導入手順
- 1
Driveでライブラリ本体を作成する
Google Driveの任意フォルダで新規Apps Scriptを作成し、KOKOCAL QUiCK PANEL Libraryなどの名前で保存します。
- 2
ライブラリ本体用コードを貼り付ける
KOKOCAL_QuickPanel_Library.gsとKOKOCAL_QuickPanel_Sidebar.htmlを作成し、必要に応じてappsscript-library.jsonをappsscript.jsonへ反映します。
- 3
ライブラリのバージョンを作成する
ライブラリ本体を保存したらバージョンを作成し、プロジェクトのScript IDを控えます。
- 4
対象ファイルでApps Scriptを開く
Googleスプレッドシート、Googleスライド、またはGoogleドキュメントを開き、拡張機能からApps Scriptを開きます。
- 5
個別ファイル側にライブラリを追加する
控えたScript IDでライブラリを追加し、IdentifierをKOKOCAL_QUICK_PANEL_LIBにして作成済みバージョンを選択します。
- 6
個別ファイル用コードを貼り付ける
KOKOCAL_Menu.gsとKOKOCAL_QuickPanel_Client.gsを貼り付けます。必要に応じてappsscript-client.jsonをappsscript.jsonへ反映します。
- 7
KOKOCAL_QuickPanel_setupを実行して再読み込みする
関数ドロップダウンからKOKOCAL_QuickPanel_setupを手動実行し、対象ファイルを再読み込みします。
導入ガイドを保存する
スクリプト生成後は、生成結果カラム右上の「導入ガイドをダウンロード」から、貼り付け用情報、導入方法、確認事項、生成スクリプト、設定JSONを保存できます。 ライブラリ本体用ファイルと個別ファイル用ファイルの貼り分けが必要になるため、作業前に保存しておくと進めやすくなります。
導入後確認事項
ライブラリ診断
KOKOCALメニューから診断を開き、Identifier、接続状態、バージョン情報、固定設定値が表示されることを確認します。
DB登録
A列ラベル、B列属性、C列値を持つスプレッドシートを登録し、DBとタブを切り替えられることを確認します。
検索とコピー
ラベル、属性、値で部分一致検索でき、選択した値をコピーできることを確認します。
各アプリへの入力
Sheetsではアクティブセル、Slidesではテキスト範囲、Docsではカーソルまたは選択範囲への入力を確認します。
注意事項
DB登録情報はユーザーごとに保存
現行仕様では、登録DBリストはUserPropertiesに保存されます。古いDocumentPropertiesによるファイル内共有仕様から変更済みです。
DBの閲覧権限が必要
登録するスプレッドシートDBを読み取る権限がないユーザーは、サイドパネルにデータを表示できません。
入力先は選択状態に依存
SlidesやDocsでは、カーソル位置や選択中オブジェクトによって入力できない場合があります。コピー機能を代替手段として使ってください。