Eylem hedefleme

Action nesneleri, etkileşimli derlemeler yapmanıza olanak tanır. Google Workspace eklentilerine aktarmanızı sağlar. Bu özellikler Kullanıcı bir widget'la (örneğin, düğme) etkileşimde bulunduğunda ne olur? kullanıcı arayüzünü görürsünüz.

Bir eylem, belirli bir widget'a widget işleyici işlevinden yararlanın. Bu değer, işlemi tetikleyen koşulu da tanımlar. Tetiklendiğinde, belirlenen bir hedefe yönelik geri çağırma işlevinden yararlanın. Geri çağırma işlevi, etkinlik nesnesi Kullanıcının istemci tarafı etkileşimleriyle ilgili bilgiler. Geri çağırma işlevini uygulamanız ve belirli bir yanıt nesnesi döndürmesini sağlamanız gerekir.

Örneğin, tıklandığında yeni bir kart oluşturan ve görüntüleyen bir düğme istediğinizi varsayalım. Bunun için yeni bir düğme widget'ı oluşturmanız ve kart oluşturma Action işlemini ayarlamak için düğme widget'ı işleyici işlevini setOnClickAction(action) kullanmanız gerekir. Tanımladığınız Action, düğme tıklandığında yürütülecek bir Apps Script geri çağırma işlevi belirtir. Böyle durumlarda istediğiniz kartı oluşturmak için geri çağırma işlevini uygulayın ve ActionResponse nesnesini tanımlayın. Yanıt nesnesi, eklentiye geri çağırma için kartı görüntülemesini söyler fonksiyonunu geliştiriyoruz.

Bu sayfada, ekleyebilirsiniz.

Etkileşimleri artırın

Drive'ı genişleten Google Workspace Eklentileri şunları içerebilir: Drive'a özel ek bir widget işlemi. Bu işlem, ilişkili işlem geri çağırma işlevi işlevini kullanın:

Yapılmak istenen işlem Geri çağırma işlevi şunu döndürmelidir:
Seçili dosyalar için dosya erişimi isteyin DriveItemsSelectedActionResponse

Bu widget işlemleri ve yanıt nesnelerinden yararlanmak için aşağıdakilerin tümü doğru olmalıdır:

  • Kullanıcının bir veya daha fazla Drive öğesi seçiliyken işlem tetiklenir.
  • Eklenti, manifest dosyasında https://www.googleapis.com/auth/drive.file Drive kapsamını içerir.

Seçilen dosyalar için dosya erişimi isteğinde bulunma

Aşağıdaki örnekte, kullanıcı bir veya daha fazla Drive öğesi seçtiğinde tetiklenen Google Drive için bağlama duyarlı bir arayüzün nasıl oluşturulacağı gösterilmektedir. İlgili içeriği oluşturmak için kullanılan örnek, eklentiye erişim izni verilip verilmediğini görmek için her öğeyi test eder; değilse bir DriveItemsSelectedActionResponse başka bir nesne olarak kullanabilirsiniz. Bir öğe için izin verildikten sonra eklenti, söz konusu öğenin Drive kotası kullanımını gösterir.

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