Class Grid

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Grille

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

var 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 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 lors d'un clic 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 lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)GridDéfinit l'URL à ouvrir en cas de clic 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.

Aller-retour

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. Une fois que l'utilisateur a terminé le flux d'autorisation et revient à l'application, le module complémentaire s'actualise.

Vous ne pouvez définir qu'un seul des éléments suivants : 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

NomTypeDescription
actionAuthorizationActionObjet spécifiant l'action d'autorisation à effectuer lorsque l'utilisateur clique sur cet élément.

Aller-retour

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.

Aller-retour

Grid : cet objet, pour le chaînage


setComposeAction(action, composedEmailType)

Définit une action qui compose un brouillon lors d'un clic sur l'objet. Vous ne pouvez définir qu'un seul des éléments setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) pour un objet d'interface utilisateur.

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

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

Aller-retour

Grid : cet objet, pour le chaînage


setNumColumns(numColumns)

Nombre de colonnes à afficher dans la grille. S'il est affiché dans le panneau latéral droit, vous pouvez afficher 1 à 3 colonnes et la valeur par défaut est 1. Si une boîte de dialogue s'affiche, vous pouvez afficher deux à six colonnes, et la valeur par défaut est 2.

Paramètres

NomTypeDescription
numColumnsIntegerNombre de colonnes.

Aller-retour

Grid : cet objet, pour le chaînage


setOnClickAction(action)

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Vous ne pouvez définir qu'un seul élément 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

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

Aller-retour

Grid : cet objet, pour le chaînage


setOnClickOpenLinkAction(action)

Définit une action qui ouvre une URL dans un onglet lorsque l'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 la création de l'objet OpenLink. Vous ne pouvez définir qu'un seul objet 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

NomTypeDescription
actionActionObjet spécifiant l'action d'ouverture du lien à effectuer lorsque l'utilisateur clique sur cet élément.

Aller-retour

Grid : cet objet, pour le chaînage


Définit l'URL à ouvrir en cas de clic sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle doit seulement être ouverte. Vous ne pouvez définir qu'un seul objet setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

NomTypeDescription
openLinkOpenLinkUn objet OpenLink décrivant l'URL à ouvrir.

Aller-retour

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 de texte brut sans mise en forme.

Paramètres

NomTypeDescription
titleStringTexte du titre.

Aller-retour

Grid : cet objet, pour le chaînage