Zachęcanie do działania

Obiekty Action pozwalają tworzyć interaktywne zachowanie w dodatkach do Google Workspace. Określają one, co się stanie, gdy użytkownik wejdzie 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. Wywołane działanie powoduje wykonanie określonej funkcji wywołania zwrotnego. Funkcja wywołania zwrotnego przekazuje obiekt zdarzenia zawierający informacje o interakcjach użytkownika po stronie klienta. Musisz wdrożyć funkcję wywołania zwrotnego, która będzie zwracać określony obiekt odpowiedzi.

Załóżmy, że chcesz, aby 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 skonfigurować tworzenie kart Action. Zdefiniowany przez Ciebie element Action określa funkcję wywołania zwrotnego Apps Script wykonywaną po kliknięciu przycisku. W takim przypadku zaimplementujesz funkcję wywołania zwrotnego, aby utworzyć odpowiednią kartę i zwrócić obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek, że ma wyświetlić kartę utworzoną przez funkcję wywołania zwrotnego.

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

Zachęcanie do interakcji

Dodatki do Google Workspace, które rozszerzają Dysk, mogą zawierać dodatkowe działanie widżetu specyficzne dla Dysku. To działanie wymaga powiązanej funkcji wywołania zwrotnego, która zwraca wyspecjalizowany obiekt odpowiedzi:

Podjęto próbę wykonania działania	Funkcja wywołania zwrotnego powinna zwrócić
Poproś o dostęp do wybranych plików	DriveItemsSelectedActionResponse

Aby można było używać tych działań widżetów i obiektów odpowiedzi, muszą być spełnione wszystkie te warunki:

• Czynność jest wyzwalana, gdy użytkownik wybierze co najmniej 1 element na Dysku.
• Dodatek zawiera w swoim pliku manifestu https://www.googleapis.com/auth/drive.file zakres Dysku.

Poproś o dostęp do wybranych plików

Z przykładu poniżej dowiesz się, jak utworzyć interfejs kontekstowy Dysku Google, który jest wyzwalany po wybraniu przez użytkownika co najmniej jednego elementu na Dysku. W tym przykładzie sprawdzany jest każdy element, by sprawdzić, czy dodatek ma uprawnienia dostępu. W przeciwnym razie używa obiektu DriveItemsSelectedActionResponse, aby poprosić użytkownika o to uprawnienie. Po przyznaniu uprawnień do elementu dodatek wyświetla informacje o wykorzystaniu miejsca na Dysku tego elementu.

/**
 * 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;
  }
}