エディタのアドオンを作成する

エディタ アドオンを作成する際の一般的な手順は次のとおりです。

  1. Apps Script プロジェクトを作成します。
  2. アドオンの外観と動作を定義するコードを記述します。このコードには、Apps Script の組み込みの HTML サービスを使用します。
  3. アドオンをテストします。
  4. アドオンを公開します。

スクリプト プロジェクトを作成する

エディタ アドオンは、スタンドアロンの Apps Script プロジェクトです。スタンドアロン スクリプト ガイドでは、新しいプロジェクトを作成する手順が説明されています。新しいスクリプトを開くこともできます。これを行うと、プロジェクト ファイル(最初の名前は Untitled project)がドライブのルートフォルダに配置されます。

コラボレーション

他のユーザーと共同でアドオンを開発する場合、アドオン プロジェクトは 1 つのユーザー アカウントが所有します。アドオンを公開する場合、1 つのユーザー アカウントが公開元として機能します。公開アカウントにはアドオン スクリプト プロジェクトへの編集アクセス権が必要ですが、プロジェクト オーナーである必要はありません。

プロジェクトのオーナーが組織を退職したために、アドオンのコードや設定にアクセスできなくなる状況を回避することが非常に重要です。

アドオン コードへのアクセス権を失わないようにするには、アドオンの共同編集時に共有ドライブを使用することをおすすめします。アドオン スクリプト ファイルを共有ドライブに配置すると、プロジェクトの単一の所有者が存在しないようになります。

また、スクリプト プロジェクトの Cloud Platform(GCP)プロジェクトに共同編集者を追加することをおすすめします。これにより、チーム内の誰かがアドオンの Cloud 設定に常にアクセスできるようになります。

アドオンをコーディングする

スクリプト プロジェクトを作成したら、アドオンの外観と動作を定義するコードを記述できます。Apps Script の HtmlService を使用して、従来の HTML と CSS を使用してアドオンのユーザー インターフェース(ダイアログとサイドバー)を作成します。エディタ アドオンでは、カスタムのメニュー項目も定義できます。

コードを記述する際は、アドオンのユーザー エクスペリエンスを設計する方法に関するガイドラインとして、エディタ アドオン スタイルガイドを参照してください。また、アドオンで発生する可能性があるさまざまな認可ライフサイクルの状態を理解し、それに合わせてプログラムを作成してください。

アドオンをテストする

エディタ アドオンは、公開前にテストして、想定どおりに動作することを確認できます。テストを行うには、テスト構成を作成し、テスト用ドキュメント、スプレッドシート、フォーム、プレゼンテーションを使用する必要があります。

詳しくは、エディタ アドオンをテストするをご覧ください。

アドオンを公開する

アドオンを公開すると、他のユーザー(一般公開またはドメイン内のユーザーのみ)が利用できるようになります。公開プロセスを開始する前に、公開の概要をご確認ください。

エディタ アドオンは Google Workspace Marketplace で公開されます。一般公開されるアドオンは、公開前にアドオンの審査を完了する必要があります。

詳しくは、エディタ アドオンの公開をご覧ください。