エディタ用アドオンを構築する前に、Apps Script の割り当てと制限事項を確認して、プロジェクトの設計がこれらのガイドラインに沿っていることを確認してください。開発プロセスの早い段階でこれらの上限を把握しておくと、後で発生する可能性のある問題を回避できます。Apps Script は、自分自身、チーム、組織向けの軽量なアドオン開発に最適です。ただし、多数のユーザーを処理する必要がある大規模なアドオンを構築する場合、低レイテンシが必要な場合、インフラストラクチャを完全に制御する必要がある場合は、別のランタイム環境で Google Workspace アドオンを開発することを検討してください。
エディタ用アドオンを作成する際は、次の一般的な手順に沿って行ってください。
- Apps Script プロジェクトを作成します。
- 組み込みの Apps Script HTML サービスを使用して、アドオンの外観と動作を定義するコードを記述します。
- アドオンをテストします。
- アドオンを公開します。
スクリプト プロジェクトを作成する
エディタ用アドオンは、スタンドアロンの Apps Script プロジェクトです。スタンドアロン スクリプト ガイドには、新しいプロジェクトを作成する手順が記載されています。新しいスクリプトを開くこともできます。この場合、プロジェクト ファイル(最初は Untitled project という名前)はドライブのルートフォルダに配置されます。
コラボレーション
アドオンの開発で他のユーザーと共同作業を行う場合、アドオン プロジェクトは 1 つのユーザー アカウントが所有します。アドオンを公開すると、1 つのユーザー アカウントがパブリッシャーとして機能します。公開アカウントには、アドオン スクリプト プロジェクトに対する編集アクセス権が必要です。ただし、プロジェクト オーナーである必要はありません。
プロジェクトの所有者が組織を離れたために、アドオンのコードや設定にアクセスできなくなる状況を避けることが非常に重要です。
アドオン コードへのアクセス権を失わないようにするため、アドオンで共同作業を行う場合は、共有ドライブを使用することをおすすめします。アドオン スクリプト ファイルを共有ドライブに配置すると、プロジェクトの唯一のオーナーとなるアカウントがなくなります。
また、スクリプト プロジェクトの Cloud Platform(GCP)プロジェクトに共同編集者を追加することもおすすめします。これにより、チームのメンバーがアドオンのクラウド設定に常にアクセスできるようになります。
アドオンをコーディングする
スクリプト プロジェクトを作成したら、アドオンの外観と動作を定義するコードの作成を開始できます。Apps Script の HtmlService を使用して、従来の HTML と CSS を使用してアドオンのユーザー インターフェース(ダイアログとサイドバー)を構築します。エディタ アドオンでは、カスタムのメニュー項目を定義することもできます。
コーディングの際は、エディタ アドオンのスタイルガイドを参照して、アドオンのユーザー エクスペリエンスを設計する方法に関するガイドラインを確認してください。また、アドオンが遭遇する可能性のあるさまざまな認証ライフサイクル状態を理解し、それに対応したプログラミングを行うようにしてください。
アドオンをテストする
エディタ用アドオンを公開前にテストして、想定どおりに動作することを確認できます。テストを行うには、テスト構成を作成し、テスト用のドキュメント、スプレッドシート、フォーム、プレゼンテーションを使用する必要があります。
詳しくは、エディタ アドオンをテストするをご覧ください。
アドオンを公開する
アドオンを公開すると、一般ユーザーまたはドメイン内のユーザーがアドオンを利用できるようになります。公開プロセスを開始する前に、パブリケーションの概要を必ずご確認ください。
エディタ用アドオンは Google Workspace Marketplace に公開されます。一般公開されるアドオンは、公開前にアドオンの審査を完了する必要があります。
詳しくは、エディタ アドオンの公開をご覧ください。