エディタのアドオンを作成する一般的な手順は次のとおりです。
- Apps Script プロジェクトを作成します。
- 組み込みの Apps Script の HTML サービスを使用して、アドオンの外観と動作を定義するコードを記述します。
- アドオンをテストします。
- アドオンを公開します。
スクリプト プロジェクトを作成する
エディタ アドオンは、スタンドアロンの Apps Script プロジェクトです。スタンドアロン スクリプト ガイドには、新しいプロジェクトを作成する手順が記載されています。また、新しいスクリプトを開くこともできます。これにより、プロジェクト ファイル(最初は Untitled project
という名前)がドライブのルート フォルダに配置されます。
コラボレーション
他のユーザーと共同でアドオンを開発する際は、1 つのユーザー アカウントがアドオン プロジェクトを所有します。アドオンを公開すると、1 つのユーザー アカウントがパブリッシャーとして機能します。公開用アカウントには、アドオン スクリプト プロジェクトに対する編集権限が必要ですが、プロジェクト オーナーである必要はありません。
プロジェクトのオーナーが組織を離れたために、アドオンのコードまたは設定にアクセスできなくなる状況を避けることが非常に重要です。
アドオンコードへのアクセス権を失わないようにするため、アドオンを共同編集する際は共有ドライブを使用することをおすすめします。アドオン スクリプト ファイルを共有ドライブ内に配置すると、プロジェクトの唯一のオーナーとなるアカウントが 1 つだけではなくなります。
また、スクリプト プロジェクトの Cloud Platform(GCP)プロジェクトに共同編集者を追加することをおすすめします。これにより、チームのメンバーがいつでもアドオンのクラウド設定にアクセスできるようになります。
アドオンをコーディングする
スクリプト プロジェクトを作成したら、アドオンの外観と動作を定義するためのコードを記述できます。Apps Script の HTMLService を使用して、従来の HTML と CSS を使用してアドオンのユーザー インターフェース(ダイアログとサイドバー)を構築します。エディタのアドオンでは、カスタムのメニュー項目も定義できます。
コーディング中は、エディタ アドオン スタイルガイドでアドオンのユーザー エクスペリエンスを設計する方法のガイドラインを確認します。また、アドオンで発生する可能性のあるさまざまな認可ライフサイクルの状態を理解し、プログラミングする必要があります。
アドオンをテストする
エディタ用アドオンを公開前にテストして、意図したとおりに動作することを確認できます。テストでは、テスト構成を作成し、テスト用のドキュメント、スプレッドシート、フォーム、またはプレゼンテーションを使用する必要があります。
詳しくは、エディタ アドオンをテストするをご覧ください。
アドオンを公開する
アドオンを公開すると、他のユーザー(一般公開することも、ドメイン内のユーザーのみ)に公開することもできます。公開プロセスを開始する前に、パブリケーションの概要を必ずご確認ください。
エディタのアドオンは Google Workspace Marketplace で公開されています。一般公開されているアドオンは、公開前にアドオンの審査を完了する必要があります。
詳しくは、エディタのアドオンを公開するをご覧ください。