Class Image

Immagine

Un widget che mostra una singola immagine.

var 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 nel flusso di autorizzazione quando viene fatto clic sull'oggetto.
setComposeAction(action, composedEmailType)ImageImposta un'azione che scrive una bozza dell'email quando un utente fa clic sull'oggetto.
setImageUrl(url)ImageConsente di impostare l'immagine da utilizzare fornendo il relativo URL o la stringa di dati.
setOnClickAction(action)ImageImposta un'azione da eseguire quando viene fatto clic sull'oggetto.
setOnClickOpenLinkAction(action)ImageImposta un'azione che apre un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)ImageImposta un URL da aprire quando viene fatto 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.

Andata e ritorno

Image: questo oggetto, per il concatenamento.


setAuthorizationAction(action)

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

Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

// ...

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

Parametri

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

Andata e ritorno

Image: questo oggetto, per il concatenamento.


setComposeAction(action, composedEmailType)

Imposta un'azione che scrive una bozza dell'email quando un utente fa clic sull'oggetto. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

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

Parametri

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

Andata e ritorno

Image: questo oggetto, per il concatenamento.


setImageUrl(url)

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

L'URL fornito può essere un URL accessibile pubblicamente o una stringa immagine codificata in Base64. Per ottenere questi ultimi valori, puoi utilizzare il seguente codice per creare una stringa immagine codificata da un'immagine nel tuo Google Drive, quindi memorizzare la stringa per un utilizzo successivo con setImageUrl(url). Questo metodo evita che il componente aggiuntivo possa accedere a un URL immagine disponibile pubblicamente:

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

Parametri

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

Andata e ritorno

Image: questo oggetto, per il concatenamento.


setOnClickAction(action)

Imposta un'azione da eseguire quando viene fatto clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti valori: 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.

// ...

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

Parametri

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

Andata e ritorno

Image: questo oggetto, per il concatenamento.


setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando devi creare l'URL o devi eseguire altre azioni aggiuntive per creare l'oggetto OpenLink. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

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

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di link aperto da intraprendere quando viene fatto clic su questo elemento.

Andata e ritorno

Image: questo oggetto, per il concatenamento.


Imposta un URL da aprire quando viene fatto clic sull'oggetto. Utilizza questa funzione quando l'URL è già noto e deve essere aperto. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Parametri

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

Andata e ritorno

Image: questo oggetto, per il concatenamento.