Esta página foi traduzida pela API Cloud Translation.

Class Image

Um widget que mostra uma única imagem. Para saber mais sobre como cortar imagens, consulte ImageCropStyle.

Disponível para os apps do Google Workspace Add-ons e do Google Chat.

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

Métodos

Método	Tipo de retorno	Breve descrição
`setAltText(altText)`	`Image`	Define o texto alternativo da imagem para acessibilidade.
`setAuthorizationAction(action)`	`Image`	Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
`setComposeAction(action, composedEmailType)`	`Image`	Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
`setImageUrl(url)`	`Image`	Define a imagem a ser usada fornecendo o URL ou a string de dados.
`setOnClickAction(action)`	`Image`	Define uma ação que é executada quando o objeto é clicado.
`setOnClickOpenLinkAction(action)`	`Image`	Define uma ação que abre um URL em uma guia quando o objeto é clicado.
`setOpenLink(openLink)`	`Image`	Define um URL para ser aberto quando o objeto é clicado.

Documentação detalhada

`setAltText(altText)`

Define o texto alternativo da imagem para acessibilidade. Obrigatório.

Parâmetros

Nome	Tipo	Descrição
`altText`	`String`	O texto alternativo a ser atribuído a essa imagem.

Retornar

Image: este objeto, para encadeamento.

`setAuthorizationAction(action)`

Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. O URL vai ser aberto em uma nova janela. Quando o usuário termina o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.

Um objeto de interface só pode ter um dos seguintes valores definidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

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

Parâmetros

Nome	Tipo	Descrição
`action`	`AuthorizationAction`	O objeto que especifica a ação de autorização a ser realizada quando este elemento é clicado.

Retornar

Image: este objeto, para encadeamento.

`setComposeAction(action, composedEmailType)`

Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. Um objeto de interface só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

O parâmetro Action precisa especificar uma função de callback que retorne um objeto ComposeActionResponse configurado usando ComposeActionResponseBuilder.setGmailDraft(draft).

Observação: esse método não define uma ação de composição que é usada para ampliar a interface do Compose. Em vez disso, ele conecta esse elemento da interface a um Action que compõe mensagens de rascunho no Apps Script e que são abertas no Gmail quando a ação é concluída.

// ...

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

// ...

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

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de composição a ser realizada quando este elemento é clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de tipo enumerado que especifica se o rascunho composto é independente ou de resposta.

Retornar

Image: este objeto, para encadeamento.

`setImageUrl(url)`

Define a imagem a ser usada fornecendo o URL ou a string de dados. Obrigatório.

O URL fornecido pode ser um URL acessível publicamente ou uma string de imagem codificada em base64. Para conseguir o último, use o código abaixo para criar uma string de imagem codificada de uma imagem no Google Drive e armazene essa string para uso posterior com setImageUrl(url). Esse método evita que o complemento precise acessar um URL de imagem disponível publicamente:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById(imageID).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

Nome	Tipo	Descrição
`url`	`String`	O endereço do URL de uma imagem hospedada a ser usada ou uma string de imagem codificada.

Retornar

Image: este objeto, para encadeamento.

`setOnClickAction(action)`

Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

O parâmetro Action precisa especificar uma função de callback que retorne um 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

Nome	Tipo	Descrição
`action`	`Action`	A ação a ser realizada quando esse elemento for clicado.

Retornar

Image: este objeto, para encadeamento.

`setOnClickOpenLinkAction(action)`

Define uma ação que abre um URL em uma guia quando o objeto é clicado. Use essa função quando o URL precisar ser criado ou quando você precisar realizar outras ações além de criar o objeto OpenLink. Um objeto de interface só pode ter um dos seguintes valores definidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

O parâmetro Action precisa especificar uma função de callback que retorne um objeto ActionResponse configurado usando 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

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de abrir link a ser realizada quando este elemento for clicado.

Retornar

Image: este objeto, para encadeamento.

`setOpenLink(openLink)`

Define um URL para ser aberto quando o objeto é clicado. Use essa função quando o URL já é conhecido e só precisa ser aberto. Um objeto de interface só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

Parâmetros

Nome	Tipo	Descrição
`openLink`	`OpenLink`	Um objeto `OpenLink` que descreve o URL a ser aberto.

Retornar

Image: este objeto, para encadeamento.