おすすめの方法

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

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

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

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

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

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

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