Class Grid

Grille

Grille organisée pour afficher une collection d'éléments de grille.

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

const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem(
    CardService.newGridItem().setTitle('My item'));

Méthodes

MéthodeType renvoyéBrève description
addItem(gridItem)GridAjoute un élément de grille à la grille.
setAuthorizationAction(action)GridDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet.
setBorderStyle(borderStyle)GridDéfinit le style de bordure appliqué à chaque élément de la grille.
setComposeAction(action, composedEmailType)GridDéfinit une action qui compose un e-mail d'envoi lorsque l'utilisateur clique sur l'objet.
setNumColumns(numColumns)GridNombre de colonnes à afficher dans la grille.
setOnClickAction(action)GridDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)GridDéfinit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet.
setOpenLink(openLink)GridDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
setTitle(title)GridDéfinit le texte du titre de la grille.

Documentation détaillée

addItem(gridItem)

Ajoute un élément de grille à la grille.

Paramètres

NomTypeDescription
gridItemGridItemÉlément de grille à ajouter.

Renvois

Grid : 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'interface utilisateur ne peut avoir qu'une seule valeur définie parmi 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

NomTypeDescription
actionAuthorizationActionObjet qui spécifie l'action d'autorisation à effectuer lorsqu'un utilisateur clique sur cet élément.

Renvois

Grid : cet objet, pour le chaînage.


setBorderStyle(borderStyle)

Définit le style de bordure appliqué à chaque élément de la grille. La valeur par défaut est NO_BORDER.

Paramètres

NomTypeDescription
borderStyleBorderStyleStyle de bordure à appliquer.

Renvois

Grid : cet objet, pour le chaînage.


setComposeAction(action, composedEmailType)

Définit une action qui compose un e-mail d'envoi lorsque l'utilisateur clique sur l'objet. Un objet d'UI 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).

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Paramètres

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

Renvois

Grid : cet objet, pour le chaînage.


setNumColumns(numColumns)

Nombre de colonnes à afficher dans la grille. Si elles s'affichent dans le panneau latéral droit, vous pouvez afficher une à deux colonnes, la valeur par défaut étant 1. Si elle s'affiche dans une boîte de dialogue, vous pouvez afficher deux à trois colonnes, et la valeur par défaut est 2.

Paramètres

NomTypeDescription
numColumnsIntegerNombre de colonnes.

Renvois

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

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

Renvois

Grid : cet objet, 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

NomTypeDescription
actionActionObjet qui spécifie l'action d'ouverture du lien à effectuer lorsque cet élément est cliqué.

Renvois

Grid : 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'elle ne doit être ouverte que. 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

NomTypeDescription
openLinkOpenLinkObjet OpenLink décrivant l'URL à ouvrir.

Renvois

Grid : cet objet, pour le chaînage.


setTitle(title)

Définit le texte du titre de la grille. Le texte doit être une chaîne brute sans mise en forme.

Paramètres

NomTypeDescription
titleStringTexte du titre.

Renvois

Grid : cet objet, pour le chaînage.