कुछ करने के लिए प्रेरित करें

Action ऑब्जेक्ट की मदद से, Google Workspace ऐड-ऑन में इंटरैक्टिव व्यवहार बनाया जा सकता है. इनसे यह तय होता है कि जब कोई उपयोगकर्ता ऐड-ऑन के यूज़र इंटरफ़ेस (यूआई) में किसी विजेट (उदाहरण के लिए, बटन) से इंटरैक्ट करता है, तो क्या होता है.

किसी विजेट में कार्रवाई जोड़ने के लिए, विजेट हैंडलर फ़ंक्शन का इस्तेमाल किया जाता है. यह फ़ंक्शन, कार्रवाई को ट्रिगर करने वाली शर्त के बारे में भी बताता है. ट्रिगर होने पर, कार्रवाई किसी तय किए गए कॉलबैक फ़ंक्शन को लागू करती है. कॉलबैक फ़ंक्शन को एक इवेंट ऑब्जेक्ट पास किया जाता है. इसमें उपयोगकर्ता के क्लाइंट-साइड इंटरैक्शन की जानकारी होती है. आपको कॉलबैक फ़ंक्शन लागू करना होगा और उसे कोई खास रिस्पॉन्स ऑब्जेक्ट दिखाना होगा.

उदाहरण के लिए, मान लें कि आपको एक ऐसा बटन चाहिए जिस पर क्लिक करने पर, नया कार्ड बन जाए और दिख जाए. इसके लिए, आपको एक नया बटन विजेट बनाना होगा. साथ ही, कार्ड बनाने की सुविधा Action सेट करने के लिए, बटन विजेट हैंडलर फ़ंक्शन setOnClickAction(action) का इस्तेमाल करना होगा. आपने जो Action तय किया है वह Apps Script के कॉलबैक फ़ंक्शन के बारे में बताता है. यह फ़ंक्शन, बटन पर क्लिक करने पर काम करता है. इस मामले में, आपको अपनी पसंद का कार्ड बनाने के लिए कॉलबैक फ़ंक्शन लागू करना होगा और ActionResponse ऑब्जेक्ट दिखाना होगा. रिस्पॉन्स ऑब्जेक्ट, ऐड-ऑन को वह कार्ड दिखाने के लिए कहता है जिसे कॉलबैक फ़ंक्शन ने बनाया है.

इस पेज पर, Drive के लिए उपलब्ध विजेट की उन कार्रवाइयों के बारे में बताया गया है जिन्हें ऐड-ऑन में शामिल किया जा सकता है.

ड्राइव इंटरैक्शन

Drive की सुविधाओं को बेहतर बनाने वाले Google Workspace ऐड-ऑन में, 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;
  }
}