このページは Cloud Translation API によって翻訳されました。

Google Workspace アドオンを作成する

このページでは、Google Workspace アドオンの設計、構築、公開方法の概要について説明します。この概要では、次の手順について説明します。

アドオンをユーザーが利用できるようにする Google Workspace アプリケーションを決定します。
アドオンのプロジェクトを設定し、オーナーと共同編集者を選択します。
アドオンの外観と動作を設計して構成します。
アドオンをビルドします。
アドオンの OAuth スコープを確認します。
1 つ以上の Google Workspace アプリケーション内でアドオンをテストします。
アドオンを公開します。

Apps Script または HTTP を使用してアドオンを構築できます。比較については、動画「Apps Script vs. HTTP endpoints: Which should you choose? 🤔」と表示されます。

Google Workspace ホストアプリケーションを選択する

Google Workspace アドオンは、次の Google Workspace ホストアプリケーションに表示されるように構成できます。

Gmail
Google カレンダー
Google Chat
Google ドキュメント
Google ドライブ
Google Meet
Google スプレッドシート
Google スライド

Google Workspace アプリケーションのビルド方法については、Google Workspace UI を拡張するをご覧ください。

アドオンのプロジェクトを設定し、オーナーと共同編集者を選択する

Apps Script でアドオンを構築する場合は、Apps Script プロジェクトと Google Cloud プロジェクトの両方を作成します。Apps Script 以外の言語でアドオンを構築する場合は、Google Cloud プロジェクトを作成するだけで済みます。

アドオンの開発を開始する前に、プロジェクトを所有するユーザーアカウントを 1 つ選択し、他のアカウントを共同編集者にするかどうかを決定します。プロジェクトのオーナーは、プロジェクトファイルと関連する設定を作成して管理します。共同編集者は、コーディングとテストを支援できます。

Apps Script プロジェクト

アドオンを構築する前に、Apps Script の割り当てと制限事項を確認し、プロジェクトの設計がこれらのガイドラインに沿っていることを確認してください。Apps Script は、ユーザー数が少ない個人用または社内用のアドオンの軽量な開発に最適です。多数のユーザーを処理する必要がある大規模なアドオンを構築する場合、低レイテンシが必要な場合、インフラストラクチャを完全に制御する必要がある場合は、別のランタイム環境での開発を検討してください。

アドオンの Apps Script プロジェクトファイルを共有ドライブに作成すると、単一のアカウントが所有権を独占することがなくなります。アドオンスクリプトファイルを共有ドライブに配置すると、複数の共同編集者がスクリプトプロジェクトにアクセスできるようになります。

アドオンを公開すると、1 つのユーザーアカウントがパブリッシャーとして機能します。公開アカウントはスクリプトプロジェクトに対する編集権限を持っている必要がありますが、オーナーである必要はありません。

Apps Script プロジェクトを作成するには、スクリプトプロジェクトをご覧ください。

Google Cloud プロジェクト

アドオンの Cloud プロジェクトに共同編集者を追加することをおすすめします。これにより、チームのメンバーが常にアドオンのクラウド設定にアクセスできるようになります。

Google Cloud プロジェクトを作成するには、Google Cloud プロジェクトを作成するをご覧ください。

アドオンの外観と動作を設計して構成する

アドオンの作成を開始する前に、アドオンの見た目と動作を決定します。アドオンで解決しようとするユースケースを検討します。まずシンプルなデザインで作業を開始し、後で調整を加えます。

アドオンのユーザーエクスペリエンスを設計する際のガイドラインについては、Google Workspace アドオンのスタイルガイドをご覧ください。

アドオンマニフェストを構成する

アドオンを設計したら、アドオンマニフェストで設計の実装を開始できます。マニフェストでは、アドオンが拡張する Google Workspace ホストアプリケーションなど、アドオンの外観と動作のほとんどを構成します。

詳しくは、Google Workspace アドオンのマニフェストをご覧ください。

アドオンにコードや機能を追加する際は、必要に応じてマニフェストを編集し、アドオンの必要な外観と動作を実現します。

Google Chat アプリの外観と動作を構成する

Google Chat を拡張するアドオンを設計した場合は、Google Chat API を使用して Chat 用アプリの外観と動作を構成する必要があります。手順については、Google Chat 用アプリを構成するをご覧ください。

アドオンをビルドする

アドオンのカードベースのインターフェースを実装する必要があります。Apps Script のカードサービスを使用するか、別のコード言語で記述している場合は、インターフェースがカードとしてレンダリングされるように、適切な形式の JSON を返します。

アドオンマニフェストで指定されたトリガー関数も実装する必要があります。アドオンが OAuth を使用して Google 以外のサードパーティサービスに接続する場合は、そのサービスの OAuth も構成する必要があります。

構築カード

アドオンのユーザーインターフェースは、Card オブジェクトを作成し、ウィジェットで埋めることで定義します。マニフェストで指定されたトリガー関数は、単一の Card オブジェクトか、アドオンインターフェースのさまざまな「ページ」を表す Card オブジェクトの配列のいずれかを返す必要があります。アドオンは、ユーザーのアクションに応じて新しいカードを作成して表示することもできます。

Apps Script では、CardBuilder クラスを使用してカードを作成します。各カードには、CardHeader と 1 つ以上の CardSections が必要です。各カードセクションには、アドオンインターフェースを構成する個々のウィジェットを設定する必要があります。インタラクションウィジェットは通常、アクションにリンクして、インタラクションの動作を定義します。

CardBuilder を介してカードにすべてのセクションとウィジェットを追加したら、CardBuilder.build() を呼び出して対応する Card オブジェクトを作成する必要があります。

CalendarApp などの他の組み込み Apps Script サービスを使用して、作成したアドオンカードに表示する情報を取得できます。Google 以外のサービスから取得したデータを使用できます。

アドオンで OAuth を必要とする Google 以外の API へのアクセスが必要な場合は、そのサービスを設定して接続する必要があります。詳しくは、Google 以外のサービスへの接続ガイドをご覧ください。

建設オーダー

カードを構築するときは、上から下に向かって構築する必要があります。つまり、次の構築順序を使用する必要があります。

ウィジェットをビルドします。
ウィジェットをカードセクションに追加します。
カードセクションにすべてのウィジェットが表示されるまで繰り返します。
カードにカードセクションを追加します。

これは、ウィジェットをカードまたはカードセクションに追加するときに、実際にはそのウィジェットのコピーを追加するためです。ウィジェットオブジェクトを追加した後に加えた変更は、最終的なカードに反映されません。

ユニバーサルアクション

ユニバーサルアクションを使用すると、コンテキストに依存しない機能を提供できます。ユニバーサルアクションは、表示されているカードに関係なく、アドオン UI で使用できるメニュー項目です。定義されたユニバーサルアクションはすべて、アドオンのカードメニューに常に表示されます。

詳しくは、ユニバーサルアクションをご覧ください。

アドオンの OAuth スコープを確認する

スコープは、アドオンがユーザーの代わりに行うことができるアクションを定義します。アドオンは、機能するために必要なアクションのスコープのみを持ち、それ以外のスコープを持たないようにすることがベストプラクティスです。

アドオンプロジェクトでは、アドオンスコープを明示的に設定して、アドオンが可能な限り最も制限の少ないスコープのセットを使用するようにします。アドオンが使用するスコープは、アドオンのマニフェストで定義します。

詳しくは、スコープをご覧ください。

アドオンをテストする

公開されていないアドオンをテストするには、まず公開されていないアドオンをインストールします。インストールして承認すると、アカウントでアドオンを使用し、拡張するホストアプリケーションでの外観と動作をテストできます。コンテキストとユーザーアクションに対してアドオンが想定どおりに動作することを確認する必要があります。

アドオンのテストを開始するには、次のガイドをご覧ください。

アドオンを公開する

アドオンを公開すると、一般公開するか、ドメイン内のユーザーのみに公開するかを選択できます。公開プロセスを開始する前に、パブリケーションの概要をご確認ください。公開は複雑なプロセスであり、完了するには準備と時間が必要です。

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

詳しくは、Google Workspace アドオンを公開するをご覧ください。