Class Image

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Image

Widget affichant une seule image.

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

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)ImageDéfinit le texte alternatif de l'image pour l'accessibilité.
setAuthorizationAction(action)ImageDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)ImageDéfinit une action qui compose un brouillon lors d'un clic sur l'objet.
setImageUrl(url)ImageDéfinit l'image à utiliser en indiquant son URL ou sa chaîne de données.
setOnClickAction(action)ImageDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)ImageDéfinit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)ImageDéfinit l'URL à ouvrir en cas de clic sur l'objet.

Documentation détaillée

setAltText(altText)

Définit le texte alternatif de l'image pour l'accessibilité. Obligatoire.

Paramètres

NomTypeDescription
altTextStringTexte alternatif à attribuer à cette image.

Aller-retour

Image : cet objet, pour le chaînage


setAuthorizationAction(action)

Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. L'URL s'ouvre dans une nouvelle fenêtre. Une fois que l'utilisateur a terminé le flux d'autorisation et revient à l'application, le module complémentaire s'actualise.

Vous ne pouvez définir qu'un seul des éléments suivants : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

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

Paramètres

NomTypeDescription
actionAuthorizationActionObjet spécifiant l'action d'autorisation à effectuer lorsque l'utilisateur clique sur cet élément.

Aller-retour

Image : cet objet, pour le chaînage


setComposeAction(action, composedEmailType)

Définit une action qui compose un brouillon lors d'un clic sur l'objet. Vous ne pouvez définir qu'un seul des éléments setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) pour un objet d'interface utilisateur.

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ComposeActionResponse configuré à l'aide de 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();
}

Paramètres

NomTypeDescription
actionActionObjet spécifiant l'action de composition à effectuer lorsque l'utilisateur clique sur cet élément.
composedEmailTypeComposedEmailTypeValeur d'énumération qui indique si le brouillon composé est un brouillon autonome ou de réponse.

Aller-retour

Image : cet objet, pour le chaînage


setImageUrl(url)

Définit l'image à utiliser en indiquant son URL ou sa chaîne de données. Obligatoire.

L'URL fournie peut être une URL accessible au public ou une chaîne d'image encodée en base64. Le second vous permet de créer une chaîne d'image encodée à partir d'une image de votre Google Drive, puis de la stocker pour une utilisation ultérieure avec setImageUrl(url). Cette méthode évite que votre module complémentaire n'ait besoin d'accéder à une URL d'image accessible au public:

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

Paramètres

NomTypeDescription
urlStringAdresse URL d'une image hébergée à utiliser ou chaîne d'image encodée.

Aller-retour

Image : cet objet, pour le chaînage


setOnClickAction(action)

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Vous ne pouvez définir qu'un seul élément setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet 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();
}

Paramètres

NomTypeDescription
actionActionAction à effectuer lorsque l'utilisateur clique sur cet élément.

Aller-retour

Image : cet objet, pour le chaînage


setOnClickOpenLinkAction(action)

Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL doit être créée ou lorsque vous devez effectuer d'autres actions en plus de la création de l'objet OpenLink. Vous ne pouvez définir qu'un seul objet setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ActionResponse configuré à l'aide de 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();
}

Paramètres

NomTypeDescription
actionActionObjet spécifiant l'action d'ouverture du lien à effectuer lorsque l'utilisateur clique sur cet élément.

Aller-retour

Image : cet objet, pour le chaînage


Définit l'URL à ouvrir en cas de clic sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle doit seulement être ouverte. Vous ne pouvez définir qu'un seul objet setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

NomTypeDescription
openLinkOpenLinkUn objet OpenLink décrivant l'URL à ouvrir.

Aller-retour

Image : cet objet, pour le chaînage