Cette page a été traduite par l'API Cloud Translation.

Class Image

Widget qui affiche une seule image. Pour en savoir plus sur le recadrage des images, consultez ImageCropStyle.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

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

Méthodes

Méthode	Type renvoyé	Brève description
`setAltText(altText)`	`Image`	Définit le texte alternatif de l'image à des fins d'accessibilité.
`setAuthorizationAction(action)`	`Image`	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet.
`setComposeAction(action, composedEmailType)`	`Image`	Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet.
`setImageUrl(url)`	`Image`	Définit l'image à utiliser en fournissant son URL ou sa chaîne de données.
`setOnClickAction(action)`	`Image`	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
`setOnClickOpenLinkAction(action)`	`Image`	Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet.
`setOpenLink(openLink)`	`Image`	Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.

Documentation détaillée

`setAltText(altText)`

Définit le texte alternatif de l'image à des fins d'accessibilité. Obligatoire.

Paramètres

Nom	Type	Description
`altText`	`String`	Texte alternatif à attribuer à cette image.

Renvois

Image : cet objet, pour le chaînage.

`setAuthorizationAction(action)`

Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet. L'URL s'ouvre dans une nouvelle fenêtre. Lorsque l'utilisateur termine le flux d'autorisation et revient à l'application, le module complémentaire se recharge.

Un objet d'UI ne peut être défini que sur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

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

Paramètres

Nom	Type	Description
`action`	`AuthorizationAction`	Objet qui spécifie l'action d'autorisation à effectuer lorsqu'un utilisateur clique sur cet élément.

Renvois

Image : objet utilisé pour le chaînage.

`setComposeAction(action, composedEmailType)`

Définit une action qui compose un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi 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).

Remarque: Cette méthode ne définit pas d'action Compose utilisée pour étendre l'UI Compose. Cette méthode connecte plutôt cet élément d'interface utilisateur à un Action qui compose des brouillons de messages dans Apps Script qui sont ouverts dans Gmail une fois l'action terminée.

// ...

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

Paramètres

Nom	Type	Description
`action`	`Action`	Objet qui spécifie l'action de composition à effectuer lorsque cet élément est cliqué.
`composedEmailType`	`ComposedEmailType`	Valeur d'énumération qui spécifie si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

Image : cet objet, pour le chaînage.

`setImageUrl(url)`

Définit l'image à utiliser en fournissant 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, vous pouvez utiliser le code suivant pour créer une chaîne d'image encodée à partir d'une image de votre Google Drive, puis stocker cette chaîne pour une utilisation ultérieure avec setImageUrl(url). Cette méthode évite à votre module complémentaire d'accéder à une URL d'image disponible publiquement:

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

Paramètres

Nom	Type	Description
`url`	`String`	Adresse URL d'une image hébergée à utiliser, ou chaîne d'image encodée.

Renvois

Image : objet utilisé pour le chaînage.

`setOnClickAction(action)`

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi 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.

// ...

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

Paramètres

Nom	Type	Description
`action`	`Action`	Action à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

Image : objet utilisé pour le chaînage.

`setOnClickOpenLinkAction(action)`

Définit une action qui ouvre une URL dans un onglet lorsqu'un 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 créer l'objet OpenLink. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi 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).

// ...

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

Paramètres

Nom	Type	Description
`action`	`Action`	Objet spécifiant l'action de lien ouvert à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

Image : cet objet, pour le chaînage.

`setOpenLink(openLink)`

Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et doit seulement être ouverte. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

Nom	Type	Description
`openLink`	`OpenLink`	Un objet `OpenLink` décrivant l'URL à ouvrir.

Renvois

Image : objet utilisé pour le chaînage.