Zachęcanie do działania

Action obiektów umożliwia tworzenie interaktywnych w dodatkach do Google Workspace. Definiują co się dzieje, gdy użytkownik wchodzi w interakcję z widżetem (np. przyciskiem) w w interfejsie dodatku.

Działanie jest dołączane do danego widżetu za pomocą funkcji obsługi widżetu, która definiuje też warunek wywołujący działanie. Po wywołaniu działanie wykonuje określone wywołanie zwrotne. Do funkcji wywołania zwrotnego przekazywany jest obiekt zdarzenia zawierający informacje o interakcjach użytkownika po stronie klienta. Musisz zaimplementować funkcję wywołania zwrotnego i zwracającą określony obiekt odpowiedzi.

Na przykład załóżmy, że chcesz mieć przycisk, który pozwala utworzyć i wyświetlić nową kartę kliknięto. W tym celu musisz utworzyć nowy widżet przycisku i użyć widżetu przycisku funkcja obsługi setOnClickAction(action) aby ustawić tworzenie kart Action. Zdefiniowany przez Ciebie parametr Action wskazuje funkcję wywołania zwrotnego Apps Script, która jest wykonywana po kliknięciu przycisku. W tym przypadku możesz zaimplementować funkcję zwrotną, aby utworzyć odpowiednią kartę i zwrócić obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek o konieczności wyświetlenia karty wywołania zwrotnego funkcji.

Na tej stronie opisano działania dotyczące widżetów w Drive, które możesz uwzględnić w swoim dodatku.

Interakcje z Dyskiem

Dodatki do Google Workspace, które rozszerzają funkcje Dysku, mogą obejmować oraz dodatkowe działanie widżetu specyficzne dla Dysku. To działanie wymaga powiązanych action callback function zwróci wyspecjalizowany obiekt odpowiedzi:

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

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

• Działanie jest wyzwalane, gdy użytkownik wybiera co najmniej 1 element na Dysku.
• Dodatek obejmuje https://www.googleapis.com/auth/drive.file Zakres Dysku w pliku manifestu.

Poproś o dostęp do wybranych plików

Ten przykład pokazuje, jak utworzyć kontekstowy interfejs Dysku Google, który jest uruchamiany, gdy użytkownik wybierze co najmniej 1 element Dysku. Przykład testuje każdy element, by sprawdzić, czy dodatek otrzymał uprawnienia dostępu. w przeciwnym razie używa funkcji DriveItemsSelectedActionResponse. aby poprosić użytkownika o te uprawnienia. Gdy użytkownik przyzna uprawnienia do elementu, dodatek wyświetli jego wykorzystanie limitu miejsca na Dysku.

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