تشجيع العملاء على اتخاذ إجراءات

تتيح لك كائنات Action إنشاء سلوك تفاعلي في إضافات Google Workspace. وهي تحدد ما يحدث عندما يتفاعل المستخدم مع أداة (على سبيل المثال، زر) في واجهة مستخدم الإضافة.

يتم إرفاق إجراء بأداة معيّنة باستخدام دالة معالج الأدوات التي تحدّد أيضًا الشرط الذي يؤدي إلى تنفيذ الإجراء. عند تشغيل الإجراء، ينفذ الإجراء دالة استدعاء معيّنة. يتم تمرير دالة معاودة الاتصال لكائن حدث يحمل معلومات عن تفاعلات المستخدم من جهة العميل. يجب عليك تنفيذ دالة رد الاتصال وأن تعرض كائن استجابة محددًا.

على سبيل المثال، لنفترض أنك تريد زرًا ينشئ بطاقة جديدة ويعرضها عند النقر فوقه. لإجراء ذلك، يجب إنشاء تطبيق مصغّر جديد للأزرار واستخدام دالة معالج الأزرار setOnClickAction(action) لضبط عنصر إنشاء بطاقة Action. تُحدِّد Action التي تحدّدها وظيفة استدعاء "برمجة تطبيقات Google" التي يتم تنفيذها عند النقر على الزر. في هذه الحالة، نفِّذ دالة معاودة الاتصال لإنشاء البطاقة التي تريدها وعرض عنصر ActionResponse. يطلب كائن الاستجابة من الإضافة عرض البطاقة التي أنشأتها دالة رد الاتصال.

توضّح هذه الصفحة الإجراءات الخاصة بأداة Drive التي يمكنك تضمينها في الإضافة.

زيادة التفاعلات

يمكن أن تتضمّن إضافات Google Workspace التي تعمل على توسيع نطاق Drive إجراء أداة إضافية خاصة بخدمة Drive. يتطلب هذا الإجراء دالة رد الاتصال المرتبطة لعرض كائن استجابة متخصص:

تمت محاولة تنفيذ الإجراء.	يجب أن تُرجع دالة رد الاتصال
طلب الوصول إلى الملفات المحددة	DriveItemsSelectedActionResponse

للاستفادة من إجراءات الأدوات وكائنات الاستجابة هذه، يجب استيفاء جميع الشروط التالية:

• يتم تشغيل الإجراء أثناء اختيار المستخدم عنصرًا واحدًا أو أكثر في Drive.
• تتضمّن الإضافة https://www.googleapis.com/auth/drive.file نطاق Drive في مظهرها.

طلب الوصول إلى الملفات المحددة

يوضّح المثال التالي كيفية إنشاء واجهة سياقية لخدمة Google Drive يتم تشغيلها عندما يختار المستخدم عنصرًا واحدًا أو أكثر في Drive. يختبر المثال كل عنصر لمعرفة ما إذا تم منح الإضافة إذن الوصول. وإذا لم يتم منح الإضافة إذن الوصول، فإنّها تستخدم كائن DriveItemsSelectedActionResponse لطلب هذا الإذن من المستخدم. بعد منح الإذن لعنصر، تعرض الإضافة استخدام حصة Drive لذلك العنصر.

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