Class Image

Imagen

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

Está disponible para los complementos de Google Workspace y las apps de Google Chat.

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
setAltText(altText)ImageEstablece el texto alternativo de la imagen para mejorar la accesibilidad.
setAuthorizationAction(action)ImageEstablece una acción de autorización que abre una URL al flujo de autorización cuando el objeto se hizo clic.
setComposeAction(action, composedEmailType)ImageEstablece una acción para redactar un borrador de correo electrónico cuando se hace clic en el objeto.
setImageUrl(url)ImageConfigura la imagen que se usará proporcionando su URL o cadena de datos.
setOnClickAction(action)ImageEstablece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)ImageEstablece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)ImageConfigura una URL que se abrirá cuando se haga clic en el objeto.

Documentación detallada

setAltText(altText)

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

Parámetros

NombreTipoDescripción
altTextStringEl texto alternativo para asignar a esta imagen.

Volver

Image: Este objeto para el encadenamiento.


setAuthorizationAction(action)

Establece una acción de autorización que abre una URL al flujo de autorización cuando el objeto se hizo clic. Se abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y vuelve a la aplicación, el complemento se vuelve a cargar.

Un objeto de IU solo puede tener establecido 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 este elemento se se hizo clic.

Volver

Image: Este objeto para el encadenamiento.


setComposeAction(action, composedEmailType)

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

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 composición que se debe realizar cuando este elemento se se hizo clic.
composedEmailTypeComposedEmailTypeUn valor enum que especifica si el borrador compuesto es una independiente o como borrador de respuesta.

Volver

Image: Este objeto para el encadenamiento.


setImageUrl(url)

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

La URL proporcionada puede ser una URL de acceso público o una cadena de imagen codificada en base64. Para obtener los últimos, puedes usar el siguiente código para crear una cadena de imagen codificada a partir de un en tu unidad de Google Drive y, luego, almacena esa cadena para usarla más tarde con setImageUrl(url). Con este método, no es necesario que tu complemento acceda a una cuenta URL de imagen disponible:

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes);

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

Parámetros

NombreTipoDescripción
urlStringLa dirección URL de una imagen alojada que se usará o una cadena de imagen codificada.

Volver

Image: Este objeto para el encadenamiento.


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 Se establecieron 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

Image: Este objeto para el encadenamiento.


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 Es necesario crear la URL o cuando debes realizar otras acciones adicionales para crear el objeto OpenLink. Un objeto de IU solo puede tener setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o Se estableció 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 debe realizar cuando este elemento se se hizo clic.

Volver

Image: Este objeto para el encadenamiento.


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

Parámetros

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

Volver

Image: Este objeto para el encadenamiento.