Zachęcanie do działania

Obiekty Action umożliwiają tworzenie interaktywnych funkcji w dodatkach do Google Workspace. Określają, co się dzieje, gdy użytkownik wchodzi w interakcję z widżetem (np. przyciskiem) w interfejsie dodatku.

Działanie jest dołączane do danego widżetu za pomocą funkcji obsługi widżetu, która określa też warunek wywołujący działanie. Po wywołaniu działanie wykonuje wyznaczoną funkcję wywołania zwrotnego. Funkcja wywołania zwrotnego otrzymuje obiekt zdarzenia, który zawiera informacje o interakcjach użytkownika po stronie klienta. Musisz zaimplementować funkcję wywołania zwrotnego i sprawić, aby zwracała określony obiekt odpowiedzi.

Załóżmy na przykład, że chcesz utworzyć przycisk, który po kliknięciu tworzy i wyświetla nową kartę. W tym celu musisz utworzyć nowy widżet przycisku i użyć funkcji obsługi widżetu przycisku setOnClickAction(action), aby ustawić Action tworzenia karty. Zdefiniowany przez Ciebie element Action określa funkcję zwrotną Apps Script, która jest wykonywana po kliknięciu przycisku. W takim przypadku implementujesz funkcję zwrotną, aby utworzyć żądaną kartę, i zwracasz obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek, że ma wyświetlić kartę utworzoną przez funkcję wywołania zwrotnego.

Na tej stronie opisujemy działania widżetów związane z Dyskiem, które możesz uwzględnić w dodatku.

Uzyskiwanie interakcji

Dodatki do Google Workspace, które rozszerzają funkcje Dysku, mogą zawierać dodatkowe działanie widżetu specyficzne dla Dysku. Ta czynność wymaga, aby powiązana z nią funkcja wywołania zwrotnego zwróciła specjalny obiekt odpowiedzi:

Podjęte działanie	Funkcja wywołania zwrotnego powinna zwracać
Prośba o dostęp do wybranych plików	DriveItemsSelectedActionResponse

Aby korzystać z tych działań widżetu i obiektów odpowiedzi, muszą być spełnione wszystkie te warunki:

• Działanie jest wywoływane, gdy użytkownik ma zaznaczone co najmniej 1 element na Dysku.
• Dodatek zawiera w pliku manifestu https://www.googleapis.com/auth/drive.file zakres Dysku.

Prośba o dostęp do wybranych plików

Poniższy przykład pokazuje, jak utworzyć interfejs kontekstowy dla Dysku Google, który jest wywoływany, gdy użytkownik wybierze co najmniej 1 element na Dysku. W przykładzie każdy element jest sprawdzany pod kątem tego, czy dodatek ma przyznane uprawnienia dostępu. Jeśli nie, używa obiektu DriveItemsSelectedActionResponse, aby poprosić użytkownika o przyznanie tych uprawnień. Gdy dodatek uzyska uprawnienia do elementu, wyświetli wykorzystanie miejsca na Dysku przez ten element.

/**
 * Build a simple card that checks selected items' quota usage. Checking
 * quota usage requires user-permissions, so this add-on provides a button
 * to request `drive.file` scope for items the add-on doesn't yet have
 * permission to access.
 *
 * @param e The event object passed containing contextual information about
 *    the Drive items selected.
 * @return {Card}
 */
function onDriveItemsSelected(e) {
  var builder =  CardService.newCardBuilder();

  // For each item the user has selected in Drive, display either its
  // quota information or a button that allows the user to provide
  // permission to access that file to retrieve its quota details.
  e['drive']['selectedItems'].forEach(
    function(item){
      var cardSection = CardService.newCardSection()
          .setHeader(item['title']);

      // This add-on uses the recommended, limited-permission `drive.file`
      // scope to get granular per-file access permissions.
      // See: https://developers.google.com/drive/api/v2/about-auth
      if (item['addonHasFileScopePermission']) {
        // If the add-on has access permission, read and display its
        // quota.
        cardSection.addWidget(
          CardService.newTextParagraph().setText(
              "This file takes up: " + getQuotaBytesUsed(item['id'])));
      } else {
        // If the add-on does not have access permission, add a button
        // that allows the user to provide that permission on a per-file
        // basis.
        cardSection.addWidget(
          CardService.newTextParagraph().setText(
              "The add-on needs permission to access this file's quota."));

        var buttonAction = CardService.newAction()
          .setFunctionName("onRequestFileScopeButtonClicked")
          .setParameters({id: item.id});

        var button = CardService.newTextButton()
          .setText("Request permission")
          .setOnClickAction(buttonAction);

        cardSection.addWidget(button);
      }

      builder.addSection(cardSection);
    });

  return builder.build();
}

/**
 * Callback function for a button action. Instructs Drive to display a
 * permissions dialog to the user, requesting `drive.file` scope for a
 * specific item on behalf of this add-on.
 *
 * @param {Object} e The parameters object that contains the item's
 *   Drive ID.
 * @return {DriveItemsSelectedActionResponse}
 */
function onRequestFileScopeButtonClicked (e) {
  var idToRequest = e.parameters.id;
  return CardService.newDriveItemsSelectedActionResponseBuilder()
      .requestFileScope(idToRequest).build();
}

/**
 * Use the Advanced Drive Service
 * (See https://developers.google.com/apps-script/advanced/drive),
 * with `drive.file` scope permissions to request the quota usage of a
 * specific Drive item.
 *
 * @param {string} itemId The ID of the item to check.
 * @return {string} A description of the item's quota usage, in bytes.
 */
function getQuotaBytesUsed(itemId) {
  try {
    return Drive.Files.get(itemId,{fields: "quotaBytesUsed"})
        .quotaBytesUsed + " bytes";
  } catch (e) {
    return "Error fetching how much quota this item uses. Error: " + e;
  }
}