おすすめの方法

アドオンの設計に関するガイドに沿って、ユーザーの全体的なエクスペリエンスを改善します。

一般的なベスト プラクティス

開発するすべてのアドオンで、次のベスト プラクティスを使用することをおすすめします。

開始前にアドオンの所有権を判断する

アドオンは Apps Script プロジェクトで定義されます。このプロジェクトは、特定のアカウントが所有するか、共有ドライブに配置する必要があります。アドオンをコーディングする前に、プロジェクトを所有するアカウントと、パブリッシャーとして機能するアカウントを決定します。また、共同編集者として機能するアカウントを決定し、それらのアカウントがスクリプト プロジェクトとそれに関連付けられた Google Cloud プロジェクトにアクセスできることを確認します。

注: アドオンの所有権を計画することが重要です。アドオンのオーナーが組織を退職する場合は、所有権が移行されていることを確認する必要があります。所有権が移行されていないと、アドオンの更新と管理ができなくなる可能性があります。そのため、組織のアドオンを所有して公開するために、組織アカウントを作成することをおすすめします。共有ドライブを使用してスクリプト プロジェクト オーナーとして機能することもできますが、アドオン パブリッシャーとして機能するアカウントが必要です。

Google Workspace を拡張する、複製しない

アドオンは、拡張する Google Workspace アプリケーションに新しい機能を提供したり、複雑なタスクを自動化したりすることを目的としています。アプリ内にすでに存在する機能を単純に複製するアドオンや、ワークフローを大幅に改善しないアドオンは、公開のためのアドオン審査に合格しない可能性があります。

スコープを狭くする

スコープを明示的に定義する場合は、可能な限り制限の少ないスコープ セットを選択してください。たとえば、読み取りアクセス権のみが必要な場合は、https://www.googleapis.com/auth/calendar スコープを使用してユーザーのカレンダーへの完全アクセス権をアドオンがリクエストしないようにします。読み取り専用アクセスの場合は、https://www.googleapis.com/auth/calendar.readonly スコープを使用します。

ライブラリに過度に依存しない

Apps Script のライブラリを使用すると、すべての Apps Script コードが 1 つのスクリプト プロジェクトに含まれている場合よりも、アドオンの実行速度が遅くなる可能性があります。Apps Script ライブラリはアドオンで動作しますが、使用するとパフォーマンスが低下する可能性があります。不要なライブラリをプロジェクトに含めないようにし、アドオンのライブラリへの依存を減らす方法を検討します。

上記のレイテンシは、サーバーサイド ライブラリとして使用される Apps Script プロジェクトにのみ適用されます。jQuery などのクライアントサイド JavaScript ライブラリは、このレイテンシが発生することなく自由に使用できます。

エディタのアドオンに関するベスト プラクティス

次のベスト プラクティスは、エディタ アドオンにのみ適用されます。

インターフェースの HTML とクライアントサイド JavaScript を独自のスクリプト ファイルに配置する

Apps Script プロジェクトで複数のスクリプト ファイルを作成できます。複雑なアドオンを管理する場合は、アドオンのサイドバーとダイアログを定義する HTML と JavaScript を、それ専用のスクリプト ファイルに配置すると管理が容易になります。

さまざまな認可モードで徹底的にテストする

アドオンをテストする際は、異なるファイルと異なる認可状態の構成を試してください。