Используйте объекты Action для создания интерактивного поведения в надстройках Google Workspace.
Объекты действий определяют, что происходит, когда пользователь взаимодействует с виджетом (например, кнопкой) в пользовательском интерфейсе надстройки.
Добавить действие в виджет
Чтобы прикрепить действие к виджету, используйте функцию-обработчик виджета , которая также определяет условие, запускающее действие. При срабатывании действие выполняет назначенную функцию обратного вызова . В функцию обратного вызова передается объект события , который содержит информацию о взаимодействиях пользователя на стороне клиента. Вы должны реализовать функцию обратного вызова и заставить ее возвращать определенный объект ответа.
Пример: отображение новой карточки при нажатии кнопки
Если вы хотите добавить в надстройку кнопку, которая создает и отображает новую карточку при нажатии, выполните следующие действия:
- Создайте виджет кнопки.
- Чтобы установить действие по созданию карты, добавьте функцию обработчика виджета кнопки
setOnClickAction(action)
. - Создайте функцию обратного вызова Apps Script для выполнения и укажите ее как
(action)
в функции обработчика виджета. В этом случае функция обратного вызова должна создать нужную вам карту и вернуть объектActionResponse
. Объект ответа сообщает надстройке отобразить карточку, созданную функцией обратного вызова.
В следующем примере показано создание виджета кнопки. Действие запрашивает область drive.file
для текущего файла от имени надстройки.
/** * Adds a section to the Card Builder that displays a "REQUEST PERMISSION" button. * When it's clicked, the callback triggers file scope permission flow. This is used in * the add-on when the home-page displays basic data. */ function addRequestFileScopeButtonToBuilder(cardBuilder) { var buttonSection = CardService.newCardSection(); // 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. var buttonAction = CardService.newAction() .setFunctionName("onRequestFileScopeButtonClickedInEditor"); var button = CardService.newTextButton() .setText("Request permission") .setBackgroundColor("#4285f4") .setTextButtonStyle(CardService.TextButtonStyle.FILLED) .setOnClickAction(buttonAction); buttonSection.addWidget(button); cardBuilder.addSection(buttonSection); } /** * Callback function for a button action. Instructs Docs to display a * permissions dialog to the user, requesting `drive.file` scope for the * current file on behalf of this add-on. * * @param {Object} e The parameters object that contains the document’s ID * @return {editorFileScopeActionResponse} */ function onRequestFileScopeButtonClickedInEditor(e) { return CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build();
Взаимодействие доступа к файлам для REST API
Дополнения Google Workspace, расширяющие возможности редакторов и использующие REST API, могут включать в себя дополнительное действие виджета для запроса доступа к файлу. Это действие требует, чтобы соответствующая функция обратного вызова действия возвращала специализированный объект ответа:
Предпринято действие | Функция обратного вызова должна вернуться |
---|---|
Запросить доступ к файлу для current_document | EditorFileScopeActionResponse |
Чтобы использовать этот объект действия и ответа виджета, должны выполняться все следующие условия:
- Надстройка использует REST API.
- Надстройка представляет диалог области запроса файла с помощью
CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build();
метод. - Надстройка включает в себя область редактора
https://www.googleapis.com/auth/drive.file
и триггерonFileScopeGranted
в своем манифесте.
Запросить доступ к файлу для текущего документа
Чтобы запросить доступ к файлу текущего документа, выполните следующие действия:
- Создайте карточку домашней страницы, которая проверяет, имеет ли надстройка область действия
drive.file
. - В случаях, когда надстройке не предоставлена область
drive.file
, создайте способ запроса пользователей предоставить областьdrive.file
для текущего документа.
Пример. Получите доступ к текущему документу в Документах Google.
В следующем примере создается интерфейс для Документов Google, который отображает размер текущего документа. Если надстройка не имеет авторизации drive.file
, она отображает кнопку для инициации авторизации области файла.
/**
* 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 information about the
* current document.
* @return {Card}
*/
function onDocsHomepage(e) {
return createAddOnView(e);
}
function onFileScopeGranted(e) {
return createAddOnView(e);
}
/**
* For the current document, display either its quota information or
* a button that allows the user to provide permission to access that
* file to retrieve its quota details.
*
* @param e The event containing information about the current document
* @return {Card}
*/
function createAddOnView(e) {
var docsEventObject = e['docs'];
var builder = CardService.newCardBuilder();
var cardSection = CardService.newCardSection();
if (docsEventObject['addonHasFileScopePermission']) {
cardSection.setHeader(docsEventObject['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 the add-on has access permission, read and display its quota.
cardSection.addWidget(
CardService.newTextParagraph().setText(
"This file takes up: " + getQuotaBytesUsed(docsEventObject['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");
var button = CardService.newTextButton()
.setText("Request permission")
.setOnClickAction(buttonAction);
cardSection.addWidget(button);
}
return builder.addSection(cardSection).build();
}
/**
* Callback function for a button action. Instructs Docs to display a
* permissions dialog to the user, requesting `drive.file` scope for the
* current file on behalf of this add-on.
*
* @param {Object} e The parameters object that contains the document’s ID
* @return {editorFileScopeActionResponse}
*/
function onRequestFileScopeButtonClicked(e) {
return CardService.newEditorFileScopeActionResponseBuilder()
.requestFileScopeForActiveDocument().build();
}