ユーザーがアドオンを開いて使用するには、その前にインストールして承認する必要があります。これらの手順は、アドオンのユーザー エクスペリエンスの最初の部分であるため、独自のアドオンの作成を開始する前に、理解しておく必要があります。
このドキュメントでは、ユーザーがアドオンをインストール、承認し、使用を開始する方法について説明します。
アドオンをインストールする
アドオンを使用するには、その前にアドオンをインストールする必要があります。インストールが完了すると、拡張された Google Workspace のホストアプリケーションでアドオンを利用できるようになります。
公開アドオンは、Google Workspace ホストアプリケーションまたは Google Workspace Marketplace からインストールできます。ドメイン管理者は、ユーザーに代わって Google Workspace Marketplace からアドオンをインストールすることもできます。また、開発中の未公開のアドオンをインストールして、テストすることもできます。インストールしたアドオンを初めて使用するには、そのアドオンを承認する必要があります。
詳細については、アドオンを公開するをご覧ください。
アドオンを承認する
アドオンをインストールすると、拡張された Google Workspace のホストアプリケーションで使用できるようになります。ユーザーが初めてアドオンを使用しようとすると、ホスト アプリケーションが承認カードまたはダイアログを表示します。このカードでは、現在の Google スプレッドシートのコンテンツにアクセスするなど、アドオンがユーザーに対して行う必要がある操作について説明します。ユーザーはこれらの権限を付与して、アドオンの続行を許可できます。ユーザーがアドオンの承認を拒否した場合、アドオンは使用できません。
エディタ アドオンは、Google Workspace アドオンとは異なる認可モデルを使用します。エディタのアドオンは Google ドライブのファイルで動作するため、編集者の承認モデルでは、個々のファイルでアドオンを使用する際のさまざまな承認モードを定義します。エディタ アドオンを開発する場合、さまざまなモードと、アドオンがモード間をどのように移動するかを理解することが重要です。
公開済みのアドオンを承認する
公開済みのアドオンをインストールすると、すぐに承認フローが開始されます。
- アドオンをインストールするアカウントを選択するよう求められます。
- アドオンの動作に必要な承認のリストが表示されるので、どのような処理を行うかを理解できます。このリストをよく確認し、承認が必要な場合は [許可] をクリックします。これにより、アドオンが使用可能になります。
- これで、拡張したホストアプリケーションから実行できるようになりました。アプリケーションがすでにブラウザタブで開いている場合は、アドオンが利用可能になる前にタブの更新が必要になることがあります。
インストールしたアドオンが後で更新され、まだ付与していない追加の承認が必要な場合は、次回アドオンを使用するときにそれらの権限を指定するように求められます。
非公開の Google Workspace アドオンを承認する
非公開のアドオンは Google Workspace Marketplace にまだ掲載されていないため、公開済みのアドオンと同じ承認フローはありません。非公開のアドオンをインストールした後、すぐに承認を求められるわけではありません。代わりに、アドオンを最初に使用しようとしたときに承認フローが開始されます。
アドオンの実行時に、ユーザー承認が必要かどうかが判断されます。承認が必要な場合は、アドオンによって承認カードが表示されます。承認は、アドオンの初回実行時に常に必要です。また、アドオンの新しいバージョンで以前に承認されていないサービスを使用する場合にも必要になることがあります。[Authorize Access] ボタンは、ユーザーがアドオンの承認を許可または拒否するためのダイアログ ウィンドウを提供します。
Google Workspace アドオンで Google 以外のサービスを承認する
Google Workspace アドオンは、それ自体が認証を必要とするサードパーティ サービスに接続できます。このようなサービスに接続する Google Workspace アドオンでは、ユーザーが次の 2 つのアクションを行う必要があります。
- アドオンのインストール時または初回起動時のアドオン自体の承認。
- Google 以外のサービスへの初回アクセス時の承認。
開発中の Google Workspace アドオンが OAuth を使用して Google 以外のサービスにアクセスする必要がある場合は、アドオンの作成時にそのサービスの接続を構成する必要があります。
詳細については、Google Workspace アドオンをサードパーティ サービスに接続するをご覧ください。
サードパーティの会議システム
Google カレンダーを拡張する Google Workspace アドオンには、ユーザーが Google カレンダーの予定の編集時にサードパーティの会議システムを選択できる会議ソリューションも追加できます。アドオンが提供する会議オプションでは、ユーザーによるログインが必要となる場合は、アドオンでユーザーがログインできるようにする必要があります。
ユーザーが必要なログインなしでアドオンで会議を作成しようとした場合、会議ソリューションの onCreateFunction メソッドは、認証 URL を含む ConferenceError を含む ConferenceData オブジェクトを返します。
Google カレンダーは、このオブジェクトを受け取ると、イベント編集 UI に [ログイン] ボタンを作成します。このボタンは、アドオンが提供する認証 URL にリンクします。これにより、ユーザーはこのボタンを使用してサードパーティ システムにログインした後、アドオンをさらに使用できます。
ConferenceError を使用した認可の処理の詳細については、サードパーティの会議の作成をご覧ください。
非公開のエディタ アドオンを承認する
エディタ アドオンは、開発時にテストすることをおすすめします。承認フローは、公開されているエディタ アドオンの場合と同じですが、最初にアドオンをテストしようとしたときにフローが開始される点が異なります。後で同じアドオンを再テストしても、承認を求められることはありません。
アドオンの承認を取り消す
アドオンを開発する場合は、アドオンの承認を解除して、承認フローを再テストできるようにすると便利です。
アドオンの承認を解除する手順は次のとおりです。
- アカウント セキュリティ コンソールを開きます。
- 許可を取り消すアドオンを見つけてクリックします。
- [アクセス権を削除] をクリックします。
アドオンの承認の解除後に再度実行すると、承認フローが再び表示されます。