اقدامات را هدایت کنید
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
اشیاء Action
به شما امکان می دهند رفتار تعاملی را در افزونه های Google Workspace ایجاد کنید. آنها تعریف می کنند که چه اتفاقی می افتد زمانی که کاربر با یک ویجت (به عنوان مثال، یک دکمه) در رابط کاربری افزونه تعامل می کند.
یک عملکرد با استفاده از یک تابع کنترل کننده ویجت به یک ویجت معین متصل میشود، که همچنین شرایطی را که اقدام را آغاز میکند، تعریف میکند. وقتی فعال میشود، عملکرد یک تابع بازخوانی تعیینشده را اجرا میکند. تابع callback به یک شی رویداد ارسال می شود که اطلاعات مربوط به تعاملات سمت مشتری کاربر را حمل می کند. شما باید تابع callback را پیاده سازی کنید و از آن بخواهید یک شی پاسخ خاص را برگرداند.
به عنوان مثال، میخواهید دکمهای را میخواهید که با کلیک کردن، یک کارت جدید بسازد و نمایش دهد. برای این کار، باید یک ویجت دکمه جدید ایجاد کنید و از تابع کنترل کننده ابزارک دکمه setOnClickAction(action)
برای تنظیم یک Action
ساخت کارت استفاده کنید. Action
که شما تعریف میکنید، یک تابع فراخوانی Apps Script را مشخص میکند که با کلیک روی دکمه اجرا میشود. در این حالت، تابع callback را برای ساخت کارت مورد نظر و برگرداندن یک شی ActionResponse
پیاده سازی می کنید. شیء پاسخ به افزونه میگوید که کارتی را که تابع پاسخ به تماس ساخته شده است نمایش دهد.
این صفحه اقدامات ویجت خاص Drive را که میتوانید در برافزای خود قرار دهید، توضیح میدهد.
تعاملات را تحریک کنید
افزونههای Google Workspace که Drive را گسترش میدهند، میتوانند یک اقدام ویجت خاص Drive را شامل شوند. این عمل به تابع مربوط به تماس پاسخ نیاز دارد تا یک شی پاسخ تخصصی را برگرداند:
برای استفاده از این اقدامات ویجت و اشیاء پاسخ، همه موارد زیر باید درست باشد:
- زمانی که کاربر یک یا چند مورد Drive را انتخاب کرده باشد، این کنش فعال میشود.
- این افزونه شامل
https://www.googleapis.com/auth/drive.file
محدوده Drive در مانیفست خود است.
درخواست دسترسی به فایل برای فایل های انتخابی
مثال زیر نشان می دهد که چگونه می توان یک رابط متنی برای Google Drive ایجاد کرد که وقتی کاربر یک یا چند مورد Drive را انتخاب می کند، فعال می شود. مثال هر مورد را آزمایش می کند تا ببیند آیا به افزونه مجوز دسترسی داده شده است یا خیر. اگر نه، از یک شی DriveItemsSelectedActionResponse
برای درخواست مجوز از کاربر استفاده می کند. هنگامی که مجوز برای یک مورد اعطا شد، افزونه میزان استفاده از سهمیه Drive از آن مورد را نشان می دهد.
/**
* 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;
}
}
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-30 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-30 بهوقت ساعت هماهنگ جهانی."],[[["\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 }"]]