Zachęcanie do działania

Obiekty Action pozwalają tworzyć interaktywne zachowania w dodatkach do Google Workspace. Określają one, co się dzieje, gdy użytkownik wchodzi w interakcję z widżetem (np. przyciskiem) w interfejsie dodatku.

Czynność jest dołączona do danego widżetu przy użyciu funkcji obsługi widżetów, która określa warunek uruchamiający działanie. Po wywołaniu działanie wykonuje określoną funkcję wywołania zwrotnego. Funkcja wywołania zwrotnego jest przekazywana obiektu zdarzenia, który zawiera informacje o interakcjach po stronie klienta. Musisz zaimplementować funkcję wywołania zwrotnego i zwrócić jej określony obiekt odpowiedzi.

Załóżmy na przykład, że chcesz mieć do dyspozycji przycisk, który po kliknięciu powoduje utworzenie nowej karty. Aby to zrobić, musisz utworzyć nowy widżet przycisku i użyć funkcji obsługi widżetu setOnClickAction(action), aby ustawić tworzenie kart Action. Zdefiniowana przez Ciebie właściwość Action określa funkcję wywołania zwrotnego Apps Script, która jest wykonywana po kliknięciu przycisku. W tym przypadku implementujesz funkcję wywołania zwrotnego, aby utworzyć odpowiednią kartę i zwrócić obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek, aby wyświetlić kartę utworzoną przez funkcję wywołania zwrotnego.

Na tej stronie opisujemy czynności związane z widżetami na Dysku, które można uwzględnić w dodatku.

Zachęcaj do interakcji

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

Podjęto działanie	Funkcja wywołania zwrotnego powinna być zwrócona
Poproś o dostęp do wybranych plików	DriveItemsSelectedActionResponse

Aby móc używać tych działań i obiektów odpowiedzi, muszą być spełnione wszystkie te warunki:

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

Poproś o dostęp do wybranych plików

Poniższy przykład pokazuje, jak utworzyć interfejs kontekstowy dla Dysku Google, który jest aktywowany, gdy użytkownik wybierze co najmniej 1 element z Dysku. Ten przykład testuje każdy element, aby sprawdzić, czy dodatek otrzymał uprawnienia dostępu. Jeśli tak nie jest, używa obiektu DriveItemsSelectedActionResponse, aby zażądać tego uprawnienia od użytkownika. Po przyznaniu uprawnień do elementu dodatek wyświetli informacje o wykorzystaniu miejsca na Dysku dla 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 contexual 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;
  }
}