Class Image

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

Paramètres

Aller-retour

Image : cet objet, pour le chaînage.

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 alors dans une nouvelle fenêtre. Lorsque l'utilisateur termine le flux d'autorisation et revient à l'application, le module complémentaire s'actualise.

Vous ne pouvez définir qu'un seul de ces objets 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

Aller-retour

Image : cet objet, pour le chaînage.

Définit une action qui constitue un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut être défini que sur 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 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

Aller-retour

Image : cet objet, pour le chaînage.

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. Pour obtenir cette dernière option, vous pouvez utiliser le code suivant afin de créer une chaîne d'image encodée à partir d'une image de votre Google Drive, puis la stocker pour une utilisation ultérieure avec setImageUrl(url). Cette méthode évite que votre module complémentaire ait besoin d'accéder à une URL d'image publique:

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

Aller-retour

Image : cet objet, pour le chaînage.

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut être défini que sur 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

Aller-retour

Image : cet objet, pour le chaînage.

Définit une action qui ouvre une URL dans un onglet en cas de clic 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. Un objet UI ne peut être associé qu'à l'un des éléments suivants : 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

Aller-retour

Image : cet objet, pour le chaînage.

Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'il vous suffit de l'ouvrir. Un objet UI ne peut être associé qu'à l'un des éléments suivants : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

Aller-retour

Image : cet objet, pour le chaînage.