ベスト プラクティス

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

一般的なおすすめの方法

開発するすべてのアドオンについて、以下のベスト プラクティスに従うことをおすすめします。

開始する前にアドオンの所有権を確認する

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

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 を、それら専用のスクリプト ファイルに配置すると、複雑なアドオンの管理が容易になります。

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

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