行動を促す
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
Action
オブジェクトを使用すると、Google Workspace アドオンにインタラクティブな動作を組み込むことができます。アドオン UI のウィジェット(ボタンなど)をユーザーが操作したときに何が起こるかを定義します。
アクションは、ウィジェット ハンドラ関数を使用して特定のウィジェットに関連付けられます。この関数は、アクションをトリガーする条件も定義します。トリガーされると、アクションは指定されたコールバック関数を実行します。コールバック関数には、ユーザーのクライアントサイドの操作に関する情報を含むイベント オブジェクトが渡されます。コールバック関数を実装し、特定のレスポンス オブジェクトを返すようにする必要があります。
たとえば、クリックすると新しいカードを作成して表示するボタンが必要だとします。これを行うには、新しいボタン ウィジェットを作成し、ボタン ウィジェット ハンドラ関数 setOnClickAction(action)
を使用してカード構築 Action
を設定する必要があります。定義する Action
は、ボタンがクリックされたときに実行される Apps Script コールバック関数を指定します。この場合、コールバック関数を実装して必要なカードを作成し、ActionResponse
オブジェクトを返します。レスポンス オブジェクトは、コールバック関数が作成したカードを表示するようアドオンに指示します。
このページでは、アドオンに含めることができるドライブ固有のウィジェット アクションについて説明します。
インタラクションを促進する
ドライブを拡張する Google Workspace アドオンには、ドライブ固有のウィジェット アクションを追加できます。このアクションでは、関連付けられたアクションのコールバック関数が、特殊なレスポンス オブジェクトを返す必要があります。
これらのウィジェット アクションとレスポンス オブジェクトを利用するには、次の条件をすべて満たしている必要があります。
- このアクションは、ユーザーが 1 つ以上のドライブ アイテムを選択しているときにトリガーされます。
- アドオンのマニフェストに
https://www.googleapis.com/auth/drive.file
Drive スコープが含まれている。
選択したファイルのアクセス権をリクエストする
次の例は、ユーザーが 1 つ以上のドライブ アイテムを選択したときにトリガーされる Google ドライブのコンテキスト インターフェースを構築する方法を示しています。この例では、各アイテムをテストして、アドオンにアクセス権限が付与されているかどうかを確認します。付与されていない場合は、DriveItemsSelectedActionResponse
オブジェクトを使用して、ユーザーに権限をリクエストします。アイテムの権限が付与されると、アドオンはそのアイテムのドライブの割り当て使用量を表示します。
/**
* Build a simple card that checks selected items' quota usage. Checking
* quota usage requires user-permissions, so this add-on provides a button
* to request `drive.file` scope for items the add-on doesn't yet have
* permission to access.
*
* @param e The event object passed containing contextual information about
* the Drive items selected.
* @return {Card}
*/
function onDriveItemsSelected(e) {
var builder = CardService.newCardBuilder();
// For each item the user has selected in Drive, display either its
// quota information or a button that allows the user to provide
// permission to access that file to retrieve its quota details.
e['drive']['selectedItems'].forEach(
function(item){
var cardSection = CardService.newCardSection()
.setHeader(item['title']);
// This add-on uses the recommended, limited-permission `drive.file`
// scope to get granular per-file access permissions.
// See: https://developers.google.com/drive/api/v2/about-auth
if (item['addonHasFileScopePermission']) {
// If the add-on has access permission, read and display its
// quota.
cardSection.addWidget(
CardService.newTextParagraph().setText(
"This file takes up: " + getQuotaBytesUsed(item['id'])));
} else {
// If the add-on does not have access permission, add a button
// that allows the user to provide that permission on a per-file
// basis.
cardSection.addWidget(
CardService.newTextParagraph().setText(
"The add-on needs permission to access this file's quota."));
var buttonAction = CardService.newAction()
.setFunctionName("onRequestFileScopeButtonClicked")
.setParameters({id: item.id});
var button = CardService.newTextButton()
.setText("Request permission")
.setOnClickAction(buttonAction);
cardSection.addWidget(button);
}
builder.addSection(cardSection);
});
return builder.build();
}
/**
* Callback function for a button action. Instructs Drive to display a
* permissions dialog to the user, requesting `drive.file` scope for a
* specific item on behalf of this add-on.
*
* @param {Object} e The parameters object that contains the item's
* Drive ID.
* @return {DriveItemsSelectedActionResponse}
*/
function onRequestFileScopeButtonClicked (e) {
var idToRequest = e.parameters.id;
return CardService.newDriveItemsSelectedActionResponseBuilder()
.requestFileScope(idToRequest).build();
}
/**
* Use the Advanced Drive Service
* (See https://developers.google.com/apps-script/advanced/drive),
* with `drive.file` scope permissions to request the quota usage of a
* specific Drive item.
*
* @param {string} itemId The ID of the item to check.
* @return {string} A description of the item's quota usage, in bytes.
*/
function getQuotaBytesUsed(itemId) {
try {
return Drive.Files.get(itemId,{fields: "quotaBytesUsed"})
.quotaBytesUsed + " bytes";
} catch (e) {
return "Error fetching how much quota this item uses. Error: " + e;
}
}
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-08-01 UTC。
[null,null,["最終更新日 2025-08-01 UTC。"],[[["\u003cp\u003eActions enable interactive behavior in Google Workspace add-ons, defining responses to user interactions with widgets.\u003c/p\u003e\n"],["\u003cp\u003eDrive add-ons use a specialized DriveItemsSelectedActionResponse to manage file access permissions.\u003c/p\u003e\n"],["\u003cp\u003eAdd-ons need the \u003ccode\u003ehttps://www.googleapis.com/auth/drive.file\u003c/code\u003e scope to request and utilize Drive file access.\u003c/p\u003e\n"],["\u003cp\u003eThe provided example demonstrates building a contextual Drive interface, requesting file access, and displaying quota usage upon permission grant.\u003c/p\u003e\n"]]],["Actions in Google Workspace add-ons define interactive behaviors triggered by widget interactions. Widgets use handler functions to attach actions, executing callback functions upon user interaction. These callbacks receive an event object containing interaction details and must return a specific response. Drive-specific actions allow requesting file access for selected files. The callback, triggered when a user selects a file in drive, checks if access is granted, and, if not, prompts the user for permission using `DriveItemsSelectedActionResponse`. The add-on then displays file quota information if access is granted.\n"],null,["# Drive actions\n\n[`Action`](/workspace/add-ons/concepts/actions) objects let you build interactive\nbehavior into Google Workspace add-ons. They define\nwhat happens when a user interacts with a widget (for example, a button) in\nthe add-on UI.\n\nAn action is attached to a given widget using a\n[widget handler function](/workspace/add-ons/concepts/actions#widget_handler_functions),\nwhich also defines the condition that triggers the action. When triggered, the\naction executes a designated\n[callback function](/workspace/add-ons/concepts/actions#callback_functions).\nThe callback function is passed an\n[event object](/workspace/add-ons/concepts/event-objects) that carries\ninformation about the user's client-side interactions. You must implement the\ncallback function and have it return a specific response object.\n\nFor example, say you want a button that builds and displays a new card when\nclicked. For this, you must create a new button widget and use the button widget\nhandler function\n[`setOnClickAction(action)`](/apps-script/reference/card-service/text-button#setOnClickAction(Action))\nto set a card-building [`Action`](/workspace/add-ons/concepts/actions). The\n[`Action`](/workspace/add-ons/concepts/actions) you define specifies an Apps Script\ncallback function that executes when the button is clicked. In this case, you\nimplement the callback function to build the card you want and return an\n[`ActionResponse`](/apps-script/reference/card-service/action-response)\nobject. The response object tells the add-on to display the card the callback\nfunction built.\n\nThis page describes Drive-specific widget actions you can include in your\nadd-on.\n\nDrive interactions\n------------------\n\nGoogle Workspace add-ons that extend Drive can include\nan additional Drive-specific widget action. This action requires the associated\naction [callback function](/workspace/add-ons/concepts/actions#callback_functions)\nto return a specialized response object:\n\n| Action attempted | Callback function should return |\n|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| [Request file access for selected files](#request_file_access_for_selected_files) | [`DriveItemsSelectedActionResponse`](/apps-script/reference/card-service/drive-items-selected-action-response) |\n\nTo make use of these widget actions and response objects, all of the following\nmust be true:\n\n- The action is triggered while the user has one or more Drive items selected.\n- The add-on includes the `https://www.googleapis.com/auth/drive.file` [Drive scope](/workspace/add-ons/concepts/workspace-scopes#drive_scopes) in its manifest.\n\n### Request file access for selected files\n\nThe following example shows how to build a contextual interface for Google\nDrive that is triggered when the user selects one or more Drive items. The\nexample tests each item to see if the add-on has been granted access permission;\nif not, it uses a [`DriveItemsSelectedActionResponse`](/apps-script/reference/card-service/drive-items-selected-action-response)\nobject to request that permission from the user. Once permission is granted for\nan item, the add-on displays the Drive quota usage of that item. \n\n /**\n * Build a simple card that checks selected items' quota usage. Checking\n * quota usage requires user-permissions, so this add-on provides a button\n * to request `drive.file` scope for items the add-on doesn't yet have\n * permission to access.\n *\n * @param e The event object passed containing contextual information about\n * the Drive items selected.\n * @return {Card}\n */\n function onDriveItemsSelected(e) {\n var builder = CardService.newCardBuilder();\n\n // For each item the user has selected in Drive, display either its\n // quota information or a button that allows the user to provide\n // permission to access that file to retrieve its quota details.\n e['drive']['selectedItems'].forEach(\n function(item){\n var cardSection = CardService.newCardSection()\n .setHeader(item['title']);\n\n // This add-on uses the recommended, limited-permission `drive.file`\n // scope to get granular per-file access permissions.\n // See: https://developers.google.com/drive/api/v2/about-auth\n if (item['addonHasFileScopePermission']) {\n // If the add-on has access permission, read and display its\n // quota.\n cardSection.addWidget(\n CardService.newTextParagraph().setText(\n \"This file takes up: \" + getQuotaBytesUsed(item['id'])));\n } else {\n // If the add-on does not have access permission, add a button\n // that allows the user to provide that permission on a per-file\n // basis.\n cardSection.addWidget(\n CardService.newTextParagraph().setText(\n \"The add-on needs permission to access this file's quota.\"));\n\n var buttonAction = CardService.newAction()\n .setFunctionName(\"onRequestFileScopeButtonClicked\")\n .setParameters({id: item.id});\n\n var button = CardService.newTextButton()\n .setText(\"Request permission\")\n .setOnClickAction(buttonAction);\n\n cardSection.addWidget(button);\n }\n\n builder.addSection(cardSection);\n });\n\n return builder.build();\n }\n\n /**\n * Callback function for a button action. Instructs Drive to display a\n * permissions dialog to the user, requesting `drive.file` scope for a\n * specific item on behalf of this add-on.\n *\n * @param {Object} e The parameters object that contains the item's\n * Drive ID.\n * @return {DriveItemsSelectedActionResponse}\n */\n function onRequestFileScopeButtonClicked (e) {\n var idToRequest = e.parameters.id;\n return CardService.newDriveItemsSelectedActionResponseBuilder()\n .requestFileScope(idToRequest).build();\n }\n\n /**\n * Use the Advanced Drive Service\n * (See https://developers.google.com/apps-script/advanced/drive),\n * with `drive.file` scope permissions to request the quota usage of a\n * specific Drive item.\n *\n * @param {string} itemId The ID of the item to check.\n * @return {string} A description of the item's quota usage, in bytes.\n */\n function getQuotaBytesUsed(itemId) {\n try {\n return Drive.Files.get(itemId,{fields: \"quotaBytesUsed\"})\n .quotaBytesUsed + \" bytes\";\n } catch (e) {\n return \"Error fetching how much quota this item uses. Error: \" + e;\n }\n }"]]