Una cuadrícula organizada para mostrar una colección de elementos de cuadrícula.
Está disponible para los complementos de Google Workspace y las apps de Google Chat.
const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem( CardService.newGridItem().setTitle('My item'));
Métodos
| Método | Tipo de datos que se muestra | Descripción breve |
|---|---|---|
add | Widget | Agrega la acción del evento que se puede realizar en el widget. |
add | Grid | Agrega un nuevo elemento de cuadrícula a la cuadrícula. |
set | Grid | Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto. |
set | Grid | Establece el estilo de borde que se aplica a cada elemento de la cuadrícula. |
set | Grid | Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto. |
set | Widget | Establece el ID único asignado que se usa para identificar el widget que se modificará. |
set | Grid | Cantidad de columnas que se mostrarán en la cuadrícula. |
set | Grid | Establece una acción que se ejecuta cuando se hace clic en el objeto. |
set | Grid | Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto. |
set | Grid | Establece una URL que se abrirá cuando se haga clic en el objeto. |
set | Grid | Establece el texto del título de la cuadrícula. |
set | Widget | Establece la visibilidad del widget. |
Documentación detallada
add Event Action(eventAction)
Agrega la acción del evento que se puede realizar en el widget.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
event | Event | Es el Event que se agregará. |
Volver
Widget: El objeto, para encadenar.
add Item(gridItem)
set Authorization Action(action)
Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto. Esto abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y regresa a la aplicación, se vuelve a cargar el complemento.
Un objeto de IU solo puede tener establecido uno de los valores set, set, set, set o set.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
action | Authorization | Objeto que especifica la acción de autorización que se debe realizar cuando se hace clic en este elemento. |
Volver
Grid: Este objeto, para encadenar.
set Border Style(borderStyle)
Establece el estilo de borde que se aplica a cada elemento de la cuadrícula. El valor predeterminado es NO_BORDER.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
border | Border | Es el estilo de borde que se aplicará. |
Volver
Grid: Este objeto, para encadenar.
set Compose Action(action, composedEmailType)
Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto. Un objeto de la IU solo puede tener establecido uno de los valores set, set, set, set o set.
El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto Compose configurado con Compose.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback(e) { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
action | Action | Objeto que especifica la acción de redacción que se debe realizar cuando se hace clic en este elemento. |
composed | Composed | Es un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta. |
Volver
Grid: Este objeto, para encadenar.
set Id(id)
Establece el ID único asignado que se usa para identificar el widget que se modificará. La mutación de widgets solo se admite en complementos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | String | Es el ID del widget, con un límite de 64 caracteres y en formato de `[a-zA-Z0-9-]+`. |
Volver
Widget: Este objeto, para encadenar.
set Num Columns(numColumns)
Cantidad de columnas que se mostrarán en la cuadrícula. Si se muestra en el panel lateral derecho, puedes mostrar de 1 a 2 columnas, y el valor predeterminado es 1. Si se muestra en un diálogo, puedes mostrar de 2 a 3 columnas, y el valor predeterminado es 2.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
num | Integer | Es la cantidad de columnas. |
Volver
Grid: Este objeto, para encadenar.
set On Click Action(action)
Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de IU solo puede tener establecido uno de los siguientes valores: set, set, set, set o set.
El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto Action.
// ... const action = CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton() .setText('Create notification') .setOnClickAction(action); // ... function notificationCallback() { return CardService.newActionResponseBuilder() .setNotification( CardService.newNotification().setText('Some info to display to user'), ) .build(); }
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
action | Action | Es la acción que se debe realizar cuando se hace clic en este elemento. |
Volver
Grid: Este objeto, para encadenar.
set On Click Open Link Action(action)
Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto. Usa esta función cuando se deba compilar la URL o cuando necesites realizar otras acciones además de crear el objeto Open. Un objeto de IU solo puede tener establecido uno de los siguientes valores: set, set, set, set o set.
El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto Action configurado con Action.
// ... const action = CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton() .setText('Open Link') .setOnClickOpenLinkAction(action); // ... function openLinkCallback() { return CardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com')) .build(); }
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
action | Action | Objeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento. |
Volver
Grid: Este objeto, para encadenar.
set Open Link(openLink)
Establece una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya se conoce y solo se necesita abrir. Un objeto de IU solo puede tener establecido uno de los siguientes atributos: set, set, set, set o set.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
open | Open | Es un objeto Open que describe la URL que se abrirá. |
Volver
Grid: Este objeto, para encadenar.
set Title(title)
Establece el texto del título de la cuadrícula. El texto debe ser una cadena simple sin formato.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
title | String | Es el texto del título. |
Volver
Grid: Este objeto, para encadenar.
set Visibility(visibility)
Establece la visibilidad del widget. El valor predeterminado es "VISIBLE".
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
visibility | Visibility | Es el Visibility del widget. |
Volver
Widget: El objeto, para encadenar.