Class Grid

Cuadrícula

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

var grid = CardService.newGrid()
    .setTitle("My Grid")
    .setNumColumns(2)
    .addItem(CardService.newGridItem()
        .setTitle("My item"));

Métodos

MétodoTipo de datos que se muestraDescripción breve
addItem(gridItem)GridAgrega un nuevo elemento de cuadrícula.
setAuthorizationAction(action)GridEstablece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
setBorderStyle(borderStyle)GridEstablece el estilo del borde aplicado a cada elemento de la cuadrícula.
setComposeAction(action, composedEmailType)GridEstablece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setNumColumns(numColumns)GridNúmero de columnas que se muestran en la cuadrícula
setOnClickAction(action)GridEstablece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)GridEstablece una acción para abrir una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)GridConfigura una URL que se abrirá cuando se haga clic en el objeto.
setTitle(title)GridEstablece el texto del título de la cuadrícula.

Documentación detallada

addItem(gridItem)

Agrega un nuevo elemento de cuadrícula.

Parámetros

NombreTipoDescripción
gridItemGridItemEl elemento de la cuadrícula que se agregará.

Volver

Grid: Es 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. Se abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y regresa a la aplicación, el complemento se vuelve a cargar.

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

// ...

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

Parámetros

NombreTipoDescripción
actionAuthorizationActionEl objeto que especifica la acción de autorización que se debe realizar cuando se hace clic en este elemento.

Volver

Grid: Es este objeto para encadenar.


setBorderStyle(borderStyle)

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

Parámetros

NombreTipoDescripción
borderStyleBorderStyleEl estilo de borde que se aplica.

Volver

Grid: Es 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: 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).

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parámetros

NombreTipoDescripción
actionActionEl objeto que especifica la acción de redacción que se debe realizar cuando se hace clic en este elemento.
composedEmailTypeComposedEmailTypeEs un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Volver

Grid: Es este objeto para encadenar.


setNumColumns(numColumns)

Número de columnas que se muestran en la cuadrícula Si se muestra en el panel lateral derecho, puedes mostrar 1-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

NombreTipoDescripción
numColumnsIntegerNúmero de columnas.

Volver

Grid: Es 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: 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.

// ...

var 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

NombreTipoDescripción
actionActionLa acción que se debe realizar cuando se hace clic en este elemento.

Volver

Grid: Es este objeto para encadenar.


setOnClickOpenLinkAction(action)

Establece una acción para abrir 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: 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).

// ...

var 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

NombreTipoDescripción
actionActionEl objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento.

Volver

Grid: Es este objeto para encadenar.


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

Parámetros

NombreTipoDescripción
openLinkOpenLinkUn objeto OpenLink que describe la URL que se abrirá.

Volver

Grid: Es este objeto para encadenar.


setTitle(title)

Establece el texto del título de la cuadrícula. El texto debe ser una string sin formato y sin formato.

Parámetros

NombreTipoDescripción
titleStringEl texto del título

Volver

Grid: Es este objeto para encadenar.