编辑器操作

使用 Action 对象将互动行为构建到 Google Workspace 插件中。

操作对象定义了用户与插件界面中的微件(例如按钮)互动时发生的情况。

向微件添加操作

如需将操作附加到微件,请使用微件处理程序函数,该函数还会定义触发操作的条件。触发后,操作会执行指定的回调函数。系统会向回调函数传递一个对象对象,该对象包含关于用户的客户端互动的信息。您必须实现该回调函数,并使其返回特定的响应对象。

示例:在用户点击按钮时显示新卡片

如果您想为插件添加一个按钮,点击该按钮会构建并显示一张新卡片,请按以下步骤操作:

  1. 创建一个新按钮 widget
  2. 如需设置卡片构建操作,请添加按钮微件处理程序函数 setOnClickAction(action)
  3. 创建一个要执行的 Apps 脚本回调函数,并将其指定为 widget 处理程序函数中的 (action)。在这种情况下,回调函数应构建您想要的卡并返回 ActionResponse 对象。响应对象会告知插件显示回调函数构建的卡片。

以下示例展示了如何创建按钮微件。该操作会代表插件请求当前文件的 drive.file 范围。

/**
 * Adds a section to the Card Builder that displays a "REQUEST PERMISSION" button.
 * When it's clicked, the callback triggers file scope permission flow. This isused in
 * the add-on when the home-page displays basic data.
 */
function addRequestFileScopeButtonToBuilder(cardBuilder) {
    var buttonSection = CardService.newCardSection();
    // 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.
    var buttonAction = CardService.newAction()
      .setFunctionName("onRequestFileScopeButtonClickedInEditor");

    var button = CardService.newTextButton()
      .setText("Request permission")
      .setBackgroundColor("#4285f4")
      .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
      .setOnClickAction(buttonAction);

    buttonSection.addWidget(button);
    cardBuilder.addSection(buttonSection);
}

/**
 * Callback function for a button action. Instructs Docs to display a
 * permissions dialog to the user, requesting `drive.file` scope for the 
 * current file on behalf of this add-on.
 *
 * @param {Object} e The parameters object that contains the document’s ID
 * @return {editorFileScopeActionResponse}
 */
function onRequestFileScopeButtonClickedInEditor(e) {
  return CardService.newEditorFileScopeActionResponseBuilder()
      .requestFileScopeForActiveDocument().build();

REST API 的文件访问权限交互

Google Workspace 扩展编辑器并使用 REST API 的插件可以包含额外的微件操作以请求文件访问权限。此操作需要关联的操作回调函数来返回专用响应对象:

已尝试操作 回调函数应返回
请求 current_document 的文件访问权限 EditorFileScopeActionResponse

如需使用此 widget 操作和响应对象,必须满足以下所有条件:

  • 该插件使用 REST API。
  • 该插件使用 CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build(); 显示请求文件范围对话框。
  • 该插件的清单中包含 https://www.googleapis.com/auth/drive.file 编辑器范围。

请求当前文档的文件访问权限

如需请求访问当前文档的文件,请按以下步骤操作:

  1. 构建一张首页卡片,用于检查插件是否有 drive.file 范围。
  2. 对于未向插件授予 drive.file 范围的情况,请构建一个请求用户为当前文档授予 drive.file 范围的方法。

示例:在 Google 文档中获取当前文档的访问权限

以下示例构建了一个 Google 文档界面,其中显示了当前文档的大小。如果插件没有 drive.file 授权,它会显示一个按钮,以启动文件范围授权。

/**
 * 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 information about the
 *   current document.
 * @return {Card}
 */
function onDocsHomepage(e) {
  return createAddOnView(docsEventObject);
}

function onFileScopeGranted(e) {
  return createAddOnView(e);
}

/**
 * For the current document, display either its quota information or
 * a button that allows the user to provide permission to access that
 * file to retrieve its quota details.
 *
 * @param e The event containing information about the current document
 * @return {Card}
 */
function createAddOnView(e) {
  var docsEventObject = e['docs'];
  var builder =  CardService.newCardBuilder();

  var cardSection = CardService.newCardSection();
  if (docsEventObject['addonHasFileScopePermission']) {
    cardSection.setHeader(docsEventObject['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 the add-on has access permission, read and display its quota.
    cardSection.addWidget(
      CardService.newTextParagraph().setText(
          "This file takes up: " + getQuotaBytesUsed(docsEventObject['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");

    var button = CardService.newTextButton()
      .setText("Request permission")
      .setOnClickAction(buttonAction);

    cardSection.addWidget(button);
  }
  return builder.addSection(cardSection).build();
}

/**
 * Callback function for a button action. Instructs Docs to display a
 * permissions dialog to the user, requesting `drive.file` scope for the
 * current file on behalf of this add-on.
 *
 * @param {Object} e The parameters object that contains the document’s ID
 * @return {editorFileScopeActionResponse}
 */
function onRequestFileScopeButtonClicked(e) {
  return CardService.newEditorFileScopeActionResponseBuilder()
      .requestFileScopeForActiveDocument().build();
}