Объекты Action
позволяют встраивать интерактивное поведение в надстройки Google Workspace. Они определяют, что происходит, когда пользователь взаимодействует с виджетом (например, кнопкой) в пользовательском интерфейсе надстройки.
Действие прикрепляется к данному виджету с помощью функции-обработчика виджета , которая также определяет условие, запускающее действие. При срабатывании действие выполняет назначенную функцию обратного вызова . В функцию обратного вызова передается объект события , который содержит информацию о взаимодействиях пользователя на стороне клиента. Вы должны реализовать функцию обратного вызова и заставить ее возвращать определенный объект ответа.
Например, предположим, что вам нужна кнопка, которая создает и отображает новую карточку при нажатии. Для этого вы должны создать новый виджет кнопки и использовать функцию обработчика виджета кнопки setOnClickAction(action)
чтобы установить Action
для создания карты. Определяемое вами Action
определяет функцию обратного вызова Apps Script, которая выполняется при нажатии кнопки. В этом случае вы реализуете функцию обратного вызова для создания нужной карты и возвращаете объект ActionResponse
. Объект ответа сообщает надстройке отобразить карточку, созданную функцией обратного вызова.
На этой странице описаны действия виджета, специфичные для Диска, которые вы можете включить в свое дополнение.
Управляйте взаимодействием
Дополнения Google Workspace, расширяющие возможности Диска, могут включать в себя дополнительное действие виджета, специфичное для Диска. Это действие требует, чтобы соответствующая функция обратного вызова действия возвращала специализированный объект ответа:
Предпринято действие | Функция обратного вызова должна вернуться |
---|---|
Запросить доступ к выбранным файлам | DriveItemsSelectedActionResponse |
Чтобы использовать эти действия виджета и объекты ответов, должны выполняться все следующие условия:
- Действие срабатывает, когда пользователь выбирает один или несколько объектов на Диске.
- Надстройка включает
https://www.googleapis.com/auth/drive.file
область действия Диска в свой манифест.
Запросить доступ к выбранным файлам
В следующем примере показано, как создать контекстный интерфейс для 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;
}
}