Class Image

Un widget que muestra una sola imagen. Para obtener información sobre cómo recortar imágenes, consulta ImageCropStyle.

Disponible para complementos de Google Workspace y apps de Google Chat.

const image = CardService.newImage()
                  .setAltText('A nice image')
                  .setImageUrl('https://image.png');

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.
`setAltText(altText)`	`Image`	Establece el texto alternativo de la imagen para la accesibilidad.
`setAuthorizationAction(action)`	`Image`	Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
`setComposeAction(action, composedEmailType)`	`Image`	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á.
`setImageUrl(url)`	`Image`	Establece la imagen que se usará proporcionando su URL o cadena de datos.
`setOnClickAction(action)`	`Image`	Establece una acción que se ejecuta cuando se hace clic en el objeto.
`setOnClickOpenLinkAction(action)`	`Image`	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
`setOpenLink(openLink)`	`Image`	Establece una URL que se abrirá cuando se haga clic en el objeto.
`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.

`setAltText(altText)`

Establece el texto alternativo de la imagen para la accesibilidad. Obligatorio.

Parámetros

Nombre	Tipo	Descripción
`altText`	`String`	El texto alternativo que se asignará a esta imagen.

Volver

Image: 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

Image: 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 usa 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

Image: 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.

`setImageUrl(url)`

Establece la imagen que se usará proporcionando su URL o cadena de datos. Obligatorio.

La URL proporcionada puede ser una URL accesible públicamente o una cadena de imagen codificada en base64. Para obtener esta última, puedes usar el siguiente código para crear una cadena de imagen codificada a partir de una imagen en tu Google Drive y, luego, almacenar esa cadena para usarla más adelante con setImageUrl(url). Este método evita que tu complemento necesite acceder a una URL de imagen disponible públicamente:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	La dirección URL de una imagen alojada que se usará o una cadena de imagen codificada.

Volver

Image: 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

Image: 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

Image: 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

Image: 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.

Class Image Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Métodos

Documentación detallada

addEventAction(eventAction)

Parámetros

Volver

setAltText(altText)

Parámetros

Volver

setAuthorizationAction(action)

Parámetros

Volver

setComposeAction(action, composedEmailType)

Parámetros

Volver

setId(id)

Parámetros

Volver

setImageUrl(url)

Parámetros

Volver

setOnClickAction(action)

Parámetros

Volver

setOnClickOpenLinkAction(action)

Parámetros

Volver

setOpenLink(openLink)

Parámetros

Volver

setVisibility(visibility)

Parámetros

Volver

Class Image

`addEventAction(eventAction)`

`setAltText(altText)`

`setAuthorizationAction(action)`

`setComposeAction(action, composedEmailType)`

`setId(id)`

`setImageUrl(url)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setVisibility(visibility)`