Los objetos Action te permiten crear un comportamiento interactivo en los complementos de Google Workspace. Definen lo que sucede cuando un usuario interactúa con un widget (por ejemplo, un botón) en la IU del complemento.
Una acción se adjunta a un widget determinado a través de un Función de controlador del widget, que también define la condición que activa la acción. Cuando se activa, ejecuta una acción designada función de devolución de llamada. A la función de devolución de llamada se le pasa un objeto de evento que contiene información sobre las interacciones del usuario del cliente. Debes implementar el función de devolución de llamada y que devuelva un objeto de respuesta específico.
Por ejemplo, supongamos que quieres que un botón cree y muestre una tarjeta nueva cuando se hace clic en él. Para ello, debes crear un nuevo widget de botón y usar la función de controlador de widget de botón setOnClickAction(action) para configurar un Action de creación de tarjetas. El Action que defines especifica una función de devolución de llamada de Apps Script que se ejecuta cuando se hace clic en el botón. En este caso, debes implementar la función de devolución de llamada para compilar la tarjeta que deseas y mostrar un objeto ActionResponse. El objeto de respuesta le indica al complemento que muestre la tarjeta que compiló la función de devolución de llamada.
En esta página, se describen las acciones de widgets específicas de Drive que puedes incluir en tu complemento.
Generar interacciones
Los complementos de Google Workspace que amplían Drive pueden incluir lo siguiente: una acción adicional de widget específico de Drive. Esta acción requiere que la función de devolución de llamada de la acción asociada muestre un objeto de respuesta especializado:
| Acción realizada | La función de devolución de llamada debería mostrar |
|---|---|
| Cómo solicitar acceso a archivos seleccionados | DriveItemsSelectedActionResponse |
Para usar estas acciones del widget y los objetos de respuesta, todo lo siguiente debe ser verdadero:
- La acción se activa mientras el usuario tiene uno o más elementos de Drive seleccionados.
- El complemento incluye el alcance de Drive
https://www.googleapis.com/auth/drive.fileen su manifiesto.
Cómo solicitar acceso a archivos seleccionados
En el siguiente ejemplo, se muestra cómo compilar una interfaz contextual para Google
Drive que se activa cuando el usuario selecciona uno o más elementos de Drive. El
En este ejemplo, se prueba cada elemento para ver si se le otorgó permiso de acceso al complemento.
De lo contrario, usa un DriveItemsSelectedActionResponse.
para solicitar el permiso al usuario. Una vez que se otorga permiso por
un elemento, el complemento muestra el uso de la cuota de Drive de ese elemento.
/**
* 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;
}
}