Class Grid

Siatka

Uporządkowana siatka do wyświetlania kolekcji elementów siatki.

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

Metody

MetodaZwracany typKrótki opis
addItem(gridItem)GridDodaje nowy element do siatki.
setAuthorizationAction(action)GridUstawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL procesu autoryzacji.
setBorderStyle(borderStyle)GridUstawia styl obramowania zastosowany do każdego elementu siatki.
setComposeAction(action, composedEmailType)GridUstawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setNumColumns(numColumns)GridLiczba kolumn, które mają być wyświetlane w siatce.
setOnClickAction(action)GridUstawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)GridUstawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
setOpenLink(openLink)GridUstawia URL otwierany po kliknięciu obiektu.
setTitle(title)GridUstawia tekst tytułu siatki.

Szczegółowa dokumentacja

addItem(gridItem)

Dodaje nowy element do siatki.

Parametry

NazwaTypOpis
gridItemGridItemElement siatki, który chcesz dodać.

Zwróć

Grid – ten obiekt do łańcucha.


setAuthorizationAction(action)

Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL procesu autoryzacji. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, dodatek zostanie ponownie wczytany.

Obiekt interfejsu może mieć ustawiony tylko jeden z tych atrybutów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

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

Parametry

NazwaTypOpis
actionAuthorizationActionObiekt, który określa działanie autoryzacji wykonywane po kliknięciu tego elementu.

Zwróć

Grid – ten obiekt do łańcucha.


setBorderStyle(borderStyle)

Ustawia styl obramowania zastosowany do każdego elementu siatki. Wartość domyślna to NO_BORDER.

Parametry

NazwaTypOpis
borderStyleBorderStyleStyl obramowania, który chcesz zastosować.

Zwróć

Grid – ten obiekt do łańcucha.


setComposeAction(action, composedEmailType)

Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć ustawiony tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ComposeActionResponse skonfigurowany za pomocą 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();
}

Parametry

NazwaTypOpis
actionActionObiekt określający działanie tworzenia wiadomości po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa, która określa, czy stworzona wersja robocza jest wersją samodzielną czy roboczą odpowiedzi.

Zwróć

Grid – ten obiekt do łańcucha.


setNumColumns(numColumns)

Liczba kolumn, które mają być wyświetlane w siatce. W panelu bocznym po prawej stronie możesz wyświetlić od 1 do 3 kolumn, a wartością domyślną jest 1. W oknie dialogowym możesz wyświetlić od 2 do 6 kolumn, a wartość domyślna to 2.

Parametry

NazwaTypOpis
numColumnsIntegerLiczba kolumn.

Zwróć

Grid – ten obiekt do łańcucha.


setOnClickAction(action)

Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawiony tylko setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt 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();
}

Parametry

NazwaTypOpis
actionActionDziałanie, które ma zostać wykonane po kliknięciu tego elementu.

Zwróć

Grid – ten obiekt do łańcucha.


setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie. Używaj tej funkcji, gdy musisz utworzyć adres URL lub wykonać dodatkowe działania, aby utworzyć obiekt OpenLink. Obiekt interfejsu może mieć ustawiony tylko setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ActionResponse skonfigurowany za pomocą 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();
}

Parametry

NazwaTypOpis
actionActionObiekt, który określa działanie linku otwartego po kliknięciu tego elementu.

Zwróć

Grid – ten obiekt do łańcucha.


Ustawia URL otwierany po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i tylko trzeba go otworzyć. Obiekt interfejsu może mieć ustawiony tylko setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

NazwaTypOpis
openLinkOpenLinkObiekt OpenLink opisujący adres URL, który ma zostać otwarty.

Zwróć

Grid – ten obiekt do łańcucha.


setTitle(title)

Ustawia tekst tytułu siatki. Tekst musi być zwykłym ciągiem znaków bez formatowania.

Parametry

NazwaTypOpis
titleStringTekst tytułu.

Zwróć

Grid – ten obiekt do łańcucha.