Google Workspace アドオンを使用すると、ユーザーが Google ドライブを使用しているときにカスタマイズされたインターフェースを提供できます。これにより、ユーザーに関連する追加情報を提供したり、タスクを自動化したり、サードパーティ システムを Google ドライブに接続したりできます。
アドオン UI へのアクセス
Google Workspace アドオンは Google ドライブのアイコンが ドライブのユーザー インターフェースの右側のアイコン列に表示されます。 Google Workspace アドオンは ホームページ インターフェース、アイテム選択インターフェース、またはその両方を定義します。
- ユーザーが Google ドライブでアドオン アイコンをクリックすると、アドオンは対応する
drive.homepageTrigger関数を実行します（存在する場合）。この関数 ホームページ カードを作成して返します。 表示されます。drive.homepageTrigger関数が定義されていない場合は、代わりに一般的なホームページ カードが表示されます。 - ユーザーが Google ドライブで 1 つ以上のアイテムを選択し、アドオン アイコンをクリックするか、アドオンが開いているときにアイテムを選択すると、アドオンは対応する
drive.onItemsSelectedTriggerコンテキスト関数（存在する場合）を実行します。この関数は、アドオンの Google ドライブを構築します。 コンテキストに基づく「商品アイテムが選択済み」インターフェース Google ドライブに戻して表示します。
アドオンの Google ドライブ インターフェースを構築する
次の一般的な手順に沿うことで、Google ドライブを拡張するインターフェースを構築できます。 手順:
- アドオンにドライブ固有のものを含めるかどうかを決定する homepage。 また、ユーザーが会話を始めたときの状況を示すコンテキスト ドライブのアイテムを選択します。
- 必要な ドライブ スコープなど、適切な
addOns.commonフィールドとaddOns.driveフィールドをアドオン スクリプト プロジェクトのマニフェストに追加します。 - ドライブ固有のホームページを提供する場合は、
drive.homepageTrigger関数を実装してこのインターフェースを構築します。複数の Google Workspace ホストにcommon.homepageTriggerインターフェースを使用することもできます。 - ドライブのコンテキスト アイテム選択インターフェースを提供する場合は、
drive.onItemsSelectedTriggerを実装する このインターフェースを構築します。 詳しくは、選択したアイテムのドライビング コンテキスト インターフェースをご覧ください。 - ユーザーのリクエストへの応答に必要な関連コールバック関数を実装します。 UI 操作（ボタンのクリックなど）。
ドライブのホームページ
Google ドライブは Google Workspace アドオンの表示をサポート
ホームページ。
Google ドライブにアドオンの共通ホームページを表示するには、アドオンのマニフェストに addOns.drive フィールドがあることを確認します。
または、アドオン マニフェストに drive.homepageTrigger を追加して、ドライブ固有のホームページを指定します。
いずれの場合も、アドオンのスクリプト プロジェクトでホームページ トリガー関数の名前を指定する必要があります。この関数は自動的に呼び出され、
必要に応じてホームページを表示する。この関数を実装して、ホームページを構成する単一の Card オブジェクトまたは Card オブジェクトの配列を構築して返す必要があります。ホームページ トリガー関数は、
イベント オブジェクト
パラメータとして渡すことにより、クライアントの
できます。イベント オブジェクト データを使用して、
できます。
選択したアイテムの Google ドライブのコンテキスト インターフェース
Google ドライブは、コンテキスト トリガーを使用して、ユーザーが 1 つ以上の Google ドライブ アイテムを選択したときに表示するインターフェース（存在する場合）を決定します。リリースを
トリガーが発生すると、
drive.onItemsSelectedTrigger.runFunction
フィールド（アドオンのマニフェスト内）に追加します。
ドライブのコンテキスト アイテム選択インターフェースを作成するには、次の操作を行う必要があります。 次のとおりです。
アドオンのマニフェストに
https://www.googleapis.com/auth/drive.addons.metadata.readonlyスコープが含まれていることを確認します。マニフェストに
drive.onItemsSelectedTriggerできます。という名前の関数を実装します。
drive.onItemsSelectedTrigger表示されます。 この関数は、引数としてイベント オブジェクトを受け取ります。 単一のリクエストまたはCardオブジェクトまたはCardオブジェクト。他のカードと同様に、コンテンツ キャプチャに使用するコールバック関数を インターフェースのウィジェットのインタラクティビティを提供します。たとえば、広告呼び出しにボタンを配置し、 インターフェースでは、 アクション ボタンがクリックされたときに実行される、実装済みのコールバック関数。
イベント オブジェクト
イベント オブジェクトが作成されて渡されます。
drive.homepageTrigger 行き
または drive.onItemsSelectedTrigger
それらの関数が呼び出されたときに関数をトリガーします。トリガー関数では、
このイベント オブジェクトの情報。アドオンカードの作成方法を決定します。
アドオンの動作を制御します。
イベント オブジェクトの完全な構造については、イベント オブジェクトをご覧ください。アドオンのホストアプリとしてドライブが機能している場合、コンテキスト イベント オブジェクトには、ドライブ固有のクライアント情報を格納する ドライブ イベント オブジェクト フィールドが含まれます。
アイテム選択トリガーのコンテキスト ドライブ イベント オブジェクトには、トリガーが起動されたときにユーザーが選択したアイテムに関する情報が含まれます。ユーザーがドライブで複数のアイテムを選択すると、そのうちの 1 つが主な関心の対象と見なされます。このアイテムはアクティブなカーソル アイテムと呼ばれます。
次の例は、drive.onItemsSelectedTrigger 関数に渡される ドライブ イベント オブジェクトを示しています。
{
"commonEventObject": { ... },
"drive": {
"activeCursorItem":{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl": "https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
"selectedItems": [
{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl":"https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
...
]
},
...
}