Class Grid

Grille

Grille organisée permettant d'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
addEventAction(eventAction)WidgetAjoute l'action d'événement qui peut être effectuée sur le widget.
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 lorsque l'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 brouillon d'e-mail lorsque l'objet est cliqué.
setId(id)WidgetDéfinit l'ID unique attribué qui est utilisé pour identifier le widget à modifier.
setNumColumns(numColumns)GridNombre de colonnes à afficher dans la grille.
setOnClickAction(action)GridDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)GridDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)GridDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setTitle(title)GridDéfinit le texte du titre de la grille.
setVisibility(visibility)WidgetDéfinit la visibilité du widget.

Documentation détaillée

addEventAction(eventAction)

Ajoute l'action d'événement qui peut être effectuée sur le widget.

Paramètres

NomTypeDescription
eventActionEventActionEventAction à ajouter.

Renvois

Widget : objet pour le chaînage.


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 lorsque l'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 avoir qu'une seule des valeurs 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 lorsque l'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 brouillon d'e-mail lorsque l'objet est cliqué. Un objet d'interface utilisateur ne peut avoir qu'un seul des attributs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) défini.

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 enum qui indique si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

Grid : cet objet, pour le chaînage.


setId(id)

Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier. La mutation de widget n'est disponible que dans les modules complémentaires.

Paramètres

NomTypeDescription
idStringID du widget, limité à 64 caractères et au format `[a-zA-Z0-9-]+`.

Renvois

Widget : cet objet, pour le chaînage.


setNumColumns(numColumns)

Nombre de colonnes à afficher dans la grille. Si elle s'affiche dans le panneau de droite, vous pouvez afficher une ou deux colonnes (la valeur par défaut est 1). Si elle est affichée dans une boîte de dialogue, vous pouvez afficher deux ou trois colonnes. La valeur par défaut est de deux colonnes.

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'objet est cliqué. Un objet d'UI ne peut avoir qu'une seule des valeurs 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 lorsque l'objet est cliqué. 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 des valeurs 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 l'utilisateur clique sur cet élément.

Renvois

Grid : cet objet, pour le chaînage.


Définit une URL à ouvrir lorsque l'objet est cliqué. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle doit uniquement être ouverte. Un objet d'interface utilisateur ne peut avoir qu'une seule des valeurs 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.


setVisibility(visibility)

Définit la visibilité du widget. La valeur par défaut est "VISIBLE".

Paramètres

NomTypeDescription
visibilityVisibilityLe Visibility du widget.

Renvois

Widget : objet pour le chaînage.