Google Workspace アドオンは、Google Workspace の ユーザーが Google ドライブを使用する際のインターフェースです。これにより、ユーザーは 追加情報の提供、タスクの自動化、サードパーティとの接続 Google ドライブにアップロードできます。
アドオン UI へのアクセス
Google Workspace アドオンは Google ドライブのアイコンが ドライブのユーザー インターフェースの右側のアイコン列に表示されます。 Google Workspace アドオンは ホームページ インターフェース、アイテム選択インターフェース、またはその両方を定義します。
- ユーザーが Google ドライブでアドオン アイコンをクリックすると、
実行されると、
対応する
drive.homepageTrigger使用します（存在する場合）。この関数 ホームページ カードを作成して返します。 表示されます。「いいえ」の場合drive.homepageTrigger関数が定義されていない場合は、代わりに汎用のホームページ カードが表示されます。 - ユーザーが Google ドライブで 1 つ以上のアイテムを選択し、アドオンをクリックした場合
アイコンをクリックしたり、項目を開いたりすると、アドオンは対応する
drive.onItemsSelectedTriggerコンテキスト関数（存在する場合）この関数は、アドオンの Google ドライブを構築します。 コンテキストに基づく「商品アイテムが選択されている」インターフェース Google ドライブに戻して表示します。
ドライブのアドオン インターフェースの構築
次の一般的な手順に沿うことで、Google ドライブを拡張するインターフェースを構築できます。 手順:
- アドオンにドライブ固有のものを含めるかどうかを決定する homepage。 また、ユーザーが会話を始めたときの状況に合わせて、 ドライブのアイテムを選択します。
- 適切な
addOns.common、addOns.drive個のフィールドを アドオン スクリプト プロジェクト マニフェストの 2 つのモジュールを 必要なドライブのスコープ。 - ドライブ専用のホームページを用意している場合は、
実装する
drive.homepageTrigger関数を使用してこのインターフェースを構築します。また、common.homepageTriggerインターフェースを複数の Google Workspace ホストにホストできます。 - ドライブのコンテキスト アイテム選択インターフェースを提供する場合は、
drive.onItemsSelectedTriggerを実装する このインターフェースを構築します。 選択したアイテムのドライブのコンテキスト インターフェースをご覧ください） をご覧ください。 - ユーザーのリクエストへの応答に必要な、関連するコールバック関数を実装します。 UI 操作（ボタンのクリックなど）。
ドライブのホームページ
Google ドライブは Google Workspace アドオンの表示をサポート
ホームページ。
Google ドライブにアドオンの一般的なホームページを表示するには、
addOns.drive フィールドである
を使用します。
または、
drive.homepageTrigger
をアドオン マニフェストに追加して、ドライブ固有のホームページを提供します。
いずれの場合も、ホームページのトリガー関数の名前を
スクリプト プロジェクト。この関数は自動的に呼び出され、
必要に応じてホームページを表示する。この関数を実装して、Google Cloud 内で
単一の
Card または次の配列
Card
オブジェクトを定義します。ホームページ トリガー関数は、
イベント オブジェクト
パラメータとして渡すことにより、クライアントの
できます。イベント オブジェクト データを使用して、
できます。
選択したアイテムのドライブのコンテキスト インターフェース
Google ドライブはコンテキスト トリガーを使用して、
ユーザーが 1 つ以上の Google ドライブのアイテムを選択したときに表示します。Google
トリガーが発生すると、
drive.onItemsSelectedTrigger.runFunction
フィールド（アドオンのマニフェスト内）に追加します。
ドライブのコンテキスト アイテム選択インターフェースを作成するには、次の操作を行う必要があります。 次のとおりです。
アドオンのマニフェストに
https://www.googleapis.com/auth/drive.addons.metadata.readonlyスコープマニフェストに
drive.onItemsSelectedTrigger。という名前の関数を実装します。
drive.onItemsSelectedTrigger表示されます。 この関数は、引数としてイベント オブジェクトを受け取ります。 単一のリクエストまたはCardオブジェクトまたはCardオブジェクト。他のカードと同様に、コンテンツ キャプチャに使用するコールバック関数を インターフェースのウィジェットのインタラクティビティを提供します。たとえば、広告呼び出しにボタンを配置し、 インターフェースでは、 アクション ボタンがクリックされたときに実行される、実装済みのコールバック関数。
イベント オブジェクト
イベント オブジェクトが作成されて渡されます。
drive.homepageTrigger 行き
または drive.onItemsSelectedTrigger
それらの関数が呼び出されたときに関数をトリガーします。トリガー関数では、
このイベント オブジェクトの情報。アドオンカードの作成方法を決定します。
アドオンの動作を制御します。
イベント オブジェクトの詳細な構造については、 イベント オブジェクト。 ドライブがアドオンの代理ホストアプリである場合、コンテキスト イベント オブジェクト 次を含める: ドライブのイベント オブジェクト フィールドは、ドライブ固有のクライアント情報を持ちます。
アイテム選択トリガーの Contextual Drive イベント オブジェクトに情報が含まれる トリガーの配信時にユーザーが選択したアイテムに関する情報です。ユーザーが ドライブ内の複数のアイテムを選択した場合、そのアイテムのうちの 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"
},
...
]
},
...
}