ユーザー行動を促進する

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Action オブジェクトを使用すると、Google Workspace アドオンにインタラクティブな動作を組み込むことができます。ユーザーがアドオン UI でウィジェット(ボタンなど)を操作したときの動作を定義します。

アクションは、ウィジェット ハンドラ関数を使用して特定のウィジェットに関連付けられます。これにより、アクションをトリガーする条件も定義されます。トリガーされると、アクションは指定されたコールバック関数を実行します。コールバック関数には、ユーザーのクライアントサイドのインタラクションに関する情報を保持するイベント オブジェクトが渡されます。コールバック関数を実装し、特定のレスポンス オブジェクトを返すようにする必要があります。

たとえば、ボタンをクリックすると新しいカードが作成されて表示されるボタンがあるとします。そのためには、新しいボタン ウィジェットを作成し、ボタン ウィジェット ハンドラ関数 setOnClickAction(action) を使用してカード作成 Action を設定する必要があります。定義した Action は、ボタンがクリックされたときに実行される Apps Script コールバック関数を指定します。この場合、必要なカードをビルドしてコールバック関数を実装し、ActionResponse オブジェクトを返します。レスポンス オブジェクトは、コールバック関数がビルドしたカードを表示するようアドオンに指示します。

このページでは、アドオンに含めることができるドライブ固有のウィジェットの操作について説明します。

インタラクションを増やす

ドライブを拡張する Google Workspace アドオンには、ドライブ固有のウィジェット アクションを追加できます。このアクションでは、関連するアクションのコールバック関数が特別なレスポンス オブジェクトを返す必要があります。

試行された操作 コールバック関数が返される
選択したファイルのアクセス権をリクエストする DriveItemsSelectedActionResponse

これらのウィジェット アクションとレスポンス オブジェクトを使用するには、以下のすべての条件を満たす必要があります。

  • ユーザーがドライブのアイテムを 1 つ以上選択したときにアクションがトリガーされます。
  • このアドオンは、そのマニフェストに https://www.googleapis.com/auth/drive.file ドライブ スコープを追加します。

選択したファイルのファイル アクセス権をリクエストする

次の例は、ユーザーがドライブのアイテムを 1 つ以上選択するとトリガーされる Google ドライブのコンテキスト インターフェースを作成する方法を示しています。この例では、各アイテムにアドオンのアクセス権が付与されているかどうかをテストしています。付与されていない場合は、DriveItemsSelectedActionResponse オブジェクトを使用してユーザーにその権限をリクエストします。アイテムに権限が付与されると、アドオンはそのアイテムに対するドライブの割り当て使用量を表示します。

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