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.

var 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 pour l'accessibilité.
`setAuthorizationAction(action)`	`Image`	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
`setComposeAction(action, composedEmailType)`	`Image`	Définit une action qui constitue un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
`setImageUrl(url)`	`Image`	Définit l'image à utiliser en indiquant 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 en cas de clic 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 pour l'accessibilité. Obligatoire.

Paramètres

Nom	Type	Description
`altText`	`String`	Texte 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 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

Nom	Type	Description
`action`	`AuthorizationAction`	Objet qui spécifie 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 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).

Remarque: Cette méthode ne définit pas d'action de composition qui permet d'étendre l'interface utilisateur de Compose. Cette méthode connecte plutôt cet élément d'UI à un Action qui compose les brouillons dans Apps Script qui sont ouverts dans Gmail à la fin de l'action.

// ...

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

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

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

Nom	Type	Description
`url`	`String`	Adresse 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. 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

Nom	Type	Description
`action`	`Action`	Action à 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 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

Nom	Type	Description
`action`	`Action`	Objet qui spécifie l'action d'ouverture du lien à effectuer lorsque l'utilisateur clique sur cet élément.

Aller-retour

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

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

Aller-retour

Image : cet objet, pour le chaînage.