Class Grid

Cuadrícula

Una cuadrícula organizada para mostrar una colección de elementos de la cuadrícula.

Disponible para complementos de Google Workspace y 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 devuelve	Descripción breve
addEventAction(eventAction)	Widget	Agrega la acción de evento que se puede realizar en el widget.
addItem(gridItem)	Grid	Agrega un elemento nuevo a la cuadrícula.
setAuthorizationAction(action)	Grid	Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
setBorderStyle(borderStyle)	Grid	Establece el estilo de borde aplicado a cada elemento de la cuadrícula.
setComposeAction(action, composedEmailType)	Grid	Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setId(id)	Widget	Establece el ID único asignado que se usa para identificar el widget que se mutará.
setNumColumns(numColumns)	Grid	Es la cantidad de columnas que se mostrarán en la cuadrícula.
setOnClickAction(action)	Grid	Establece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)	Grid	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)	Grid	Establece una URL que se abrirá cuando se haga clic en el objeto.
setTitle(title)	Grid	Establece el texto del título de la cuadrícula.
setVisibility(visibility)	Widget	Establece la visibilidad del widget.

Documentación detallada

addEventAction(eventAction)

Agrega la acción de evento que se puede realizar en el widget.

Parámetros

Nombre	Tipo	Descripción
eventAction	EventAction	El EventAction que se agregará.

Volver

Widget : El objeto, para encadenar.

---

addItem(gridItem)

Agrega un elemento nuevo a la cuadrícula.

Parámetros

Nombre	Tipo	Descripción
gridItem	GridItem	El elemento de la cuadrícula que se agregará.

Volver

Grid : Este objeto, para encadenar.

---

setAuthorizationAction(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 abre la URL en una ventana nueva. Cuando el usuario termina el flujo de autorización y regresa a la aplicación, se vuelve a cargar el complemento.

Un objeto de IU solo puede tener uno de los siguientes valores establecidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parámetros

Nombre	Tipo	Descripción
action	AuthorizationAction	El 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.

---

setBorderStyle(borderStyle)

Establece el estilo de borde aplicado a cada elemento de la cuadrícula. El valor predeterminado es NO_BORDER.

Parámetros

Nombre	Tipo	Descripción
borderStyle	BorderStyle	El estilo de borde que se aplicará.

Volver

Grid : Este objeto, para encadenar.

---

setComposeAction(action, composedEmailType)

Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto. Un objeto de IU solo puede tener uno de los siguientes valores establecidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ComposeActionResponse configurado con ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: Este método no establece una acción de redacción que se use para extender la IU de redacción. En cambio, este método conecta este elemento de la IU a un Action que redacta mensajes de borrador en Apps Script que se abren en Gmail cuando se completa la acción.

// ...

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	El objeto que especifica la acción de redacción que se debe realizar cuando se hace clic en este elemento.
composedEmailType	ComposedEmailType	Un valor de enum que especifica si el borrador redactado es un borrador independiente o de respuesta.

Volver

Grid : Este objeto, para encadenar.

---

setId(id)

Establece el ID único asignado que se usa para identificar el widget que se mutará. La mutación de widgets solo es compatible con complementos.

Parámetros

Nombre	Tipo	Descripción
id	String	El ID del widget, con un límite de 64 caracteres y en formato `[a-zA-Z0-9-]+`.

Volver

Widget : Este objeto, para encadenar.

---

setNumColumns(numColumns)

Es la cantidad de columnas que se mostrarán en la cuadrícula. Si se muestra en el panel lateral derecho, puedes mostrar 1 o 2 columnas, y el valor predeterminado es 1. Si se muestra en un diálogo, puedes mostrar 2 o 3 columnas, y el valor predeterminado es 2.

Parámetros

Nombre	Tipo	Descripción
numColumns	Integer	La cantidad de columnas.

Volver

Grid : Este objeto, para encadenar.

---

setOnClickAction(action)

Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de IU solo puede tener uno de los siguientes valores establecidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ActionResponse.

// ...

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	La acción que se debe realizar cuando se hace clic en este elemento.

Volver

Grid : Este objeto, para encadenar.

---

setOnClickOpenLinkAction(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 OpenLink. Un objeto de IU solo puede tener uno de los siguientes valores establecidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ActionResponse configurado con ActionResponseBuilder.setOpenLink(openLink).

// ...

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	El 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.

---

setOpenLink(openLink)

Establece una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya se conozca y solo deba abrirse. Un objeto de IU solo puede tener uno de los siguientes valores establecidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parámetros

Nombre	Tipo	Descripción
openLink	OpenLink	Un objeto OpenLink que describe la URL que se abrirá.

Volver

Grid : Este objeto, para encadenar.

---

setTitle(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	El texto del título.

Volver

Grid : Este objeto, para encadenar.

---

setVisibility(visibility)

Establece la visibilidad del widget. El valor predeterminado es `VISIBLE`.

Parámetros

Nombre	Tipo	Descripción
visibility	Visibility	La Visibility del widget.

Volver

Widget : El objeto, para encadenar.