Class Image

Immagine

Un widget che mostra una singola immagine. Per informazioni sul ritaglio delle immagini, vedi ImageCropStyle.

Disponibile per i componenti aggiuntivi di Google Workspace e le app Google Chat.

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

Metodi

MetodoTipo restituitoBreve descrizione
setAltText(altText)ImageImposta il testo alternativo dell'immagine per l'accessibilità.
setAuthorizationAction(action)ImageImposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando viene fatto clic sull'oggetto.
setComposeAction(action, composedEmailType)ImageImposta un'azione che compone una bozza di email quando si fa clic sull'oggetto.
setImageUrl(url)ImageImposta l'immagine da utilizzare fornendo il relativo URL o la stringa di dati.
setOnClickAction(action)ImageImposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto.
setOnClickOpenLinkAction(action)ImageConsente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)ImageImposta un URL da aprire quando l'utente fa clic sull'oggetto.

Documentazione dettagliata

setAltText(altText)

Imposta il testo alternativo dell'immagine per l'accessibilità. Obbligatorio.

Parametri

NomeTipoDescrizione
altTextStringIl testo alternativo da assegnare a questa immagine.

Invio

Image: questo oggetto, per l'accodamento.


setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL per il flusso di autorizzazione quando si fa clic sull'oggetto. L'URL si apre in una nuova finestra. Quando l'utente termina il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

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

Parametri

NomeTipoDescrizione
actionAuthorizationActionL'oggetto che specifica l'azione di autorizzazione da eseguire quando viene fatto clic su questo elemento.

Invio

Image: questo oggetto, per l'accodamento.


setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto. Per un oggetto UI è possibile impostare un solo elemento tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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();
}

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di composizione da eseguire quando viene fatto clic su questo elemento.
composedEmailTypeComposedEmailTypeUn valore enum che specifica se la bozza composta è indipendente o una bozza di risposta.

Invio

Image: questo oggetto, per l'accodamento.


setImageUrl(url)

Imposta l'immagine da utilizzare fornendo il relativo URL o la stringa di dati. Obbligatorio.

L'URL fornito può essere un URL pubblicamente accessibile o una stringa di immagine codificata Base64. Per ottenere quest'ultimo, puoi utilizzare il seguente codice per creare una stringa di immagine codificata da un'immagine su Google Drive, quindi memorizzarla per utilizzarla in un secondo momento con setImageUrl(url). Questo metodo evita che il tuo componente aggiuntivo debba accedere a un URL immagine disponibile pubblicamente:

// 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).

Parametri

NomeTipoDescrizione
urlStringL'indirizzo URL di un'immagine ospitata da utilizzare o una stringa immagine codificata.

Invio

Image: questo oggetto, per l'accodamento.


setOnClickAction(action)

Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Il parametro Action deve specificare una funzione di callback che restituisce un oggetto 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();
}

Parametri

NomeTipoDescrizione
actionActionL'azione da intraprendere quando viene fatto clic su questo elemento.

Invio

Image: questo oggetto, per l'accodamento.


setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. Utilizza questa funzione quando è necessario creare l'URL o quando devi eseguire altre azioni oltre a creare l'oggetto OpenLink. Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Il parametro Action deve specificare una funzione di callback che restituisce un oggetto ActionResponse configurato utilizzando 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();
}

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di apertura del link da eseguire quando viene fatto clic su questo elemento.

Invio

Image: oggetto per il collegamento.


Imposta un URL da aprire quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già conosciuto e deve solo essere aperto. Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parametri

NomeTipoDescrizione
openLinkOpenLinkUn oggetto OpenLink che descrive l'URL da aprire.

Invio

Image: oggetto per il collegamento.