Google Workspace 插件的清单

插件使用清单文件来配置有关应用及其操作的特定详细信息。

本文档详细介绍了如何为 Google Workspace 插件配置清单。

Google Workspace 插件的清单结构

Google Workspace 插件使用清单文件来定义插件的外观和行为的几个方面。

Google Workspace 插件的清单属性位于清单对象结构的 addOns 部分下。

• 如需了解 Apps 脚本清单文件，请参阅清单结构。
• 如需了解使用 HTTP 端点构建的插件的清单文件，请参阅 REST 资源：projects.deployments

Google Workspace 插件清单配置示例

以下清单示例显示了清单文件中定义 Google Workspace 插件的部分，其中包括以下几个方面：

• 清单的 addOns.common 部分定义了插件的名称、徽标网址、颜色以及其他独立于主机的常规设置。
• 该清单定义了一个通用首页，但还定义了日历、云端硬盘、文档、表格和幻灯片专用首页。Gmail 使用默认主页。
• 示例清单设置支持以下各项：
  • 日历 eventOpen 和 eventUpdated 触发器。
  • （仅限 Apps 脚本）两种 Google 日历会议解决方案。
  • 两项通用操作。
  • 云端硬盘 onItemsSelectedTrigger。
  • Gmail 撰写操作和上下文触发器。
  • 一个文档 linkPreviewTriggers 对象。如需了解此触发器，请参阅预览包含智能条状标签的链接。
  • 一个文档 createActionTriggers 对象。如需了解此触发器，请参阅通过 @ 菜单创建第三方资源。
  • Google 文档、表格和幻灯片的文件专用界面。
• oauthScopes 字段用于设置项目的授权范围（这通常是插件所必需的）。
• （仅限 Apps 脚本）urlFetchWhitelist 字段是一个字段，用于确保任何提取的端点都与指定的 HTTPS 网址前缀列表匹配。如需了解详情，请参阅将网址列入许可名单。

示例中的链接指向 Apps 脚本和 HTTP Google Workspace 插件的相应清单参考文档中该字段的说明。

注意 ：清单包括其他组件。addOns 字段下的字段与 Google Workspace 插件直接相关。此示例只是完整清单文件的一部分，并非功能齐全的清单。

Apps 脚本

{
  "addOns": {
    "calendar": {
      "createSettingsUrlFunction": "getConferenceSettingsPageUrl",
      "conferenceSolution": [{
        "id": "my-video-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Video Conference",
        "onCreateFunction": "onCreateMyVideoConference"
      }, {
        "id": "my-streamed-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Streamed Conference",
        "onCreateFunction": "onCreateMyStreamedConference"
      }],
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "onDefaultHomePageOpen",
        "enabled": true
      },
      "layoutProperties": {
        "primaryColor": "#ff392b",
        "secondaryColor": "#d68617"
      },
      "logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
      "name": "Demo Google Workspace Add-on",
      "openLinkUrlPrefixes": [
        "https://mail.google.com/",
        "https://script.google.com/a/google.com/d/",
        "https://drive.google.com/a/google.com/file/d/",
        "https://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "selectActions": [
          {
            "text": "Add images to email",
            "runFunction": "getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
        "runFunction": "onLinkPreview",
        "patterns": [
            {
              "hostPattern": "example.com",
              "pathPrefix": "example-path"
            }
        ],
        "labelText": "Link preview",
        "localizedLabelText": {
          "es": "Link preview localized in Spanish"
        },
        "logoUrl": "https://www.example.com/images/smart-chip-icon.png"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "exampleFunction",
          "logoUrl": "https://www.example.com/images/case.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/calendar.addons.execute",
    "https://www.googleapis.com/auth/calendar.addons.current.event.read",
    "https://www.googleapis.com/auth/calendar.addons.current.event.write",
    "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
    "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.locale",
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/documents.currentonly",
    "https://www.googleapis.com/auth/spreadsheets.currentonly",
    "https://www.googleapis.com/auth/presentations.currentonly",
    "https://www.googleapis.com/auth/workspace.linkpreview"
  ],
  "urlFetchWhitelist": [
    "https://www.example.com/myendpoint/"
  ]
}

HTTP

{
  "addOns": {
    "calendar": {
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDefaultHomePageOpen",
        "enabled": true
      },
      "layoutProperties": {
        "primaryColor": "#ff392b",
        "secondaryColor": "#d68617"
      },
      "logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
      "name": "Demo Google Workspace Add-on",
      "openLinkUrlPrefixes": [
        "https://mail.google.com/",
        "https://script.google.com/a/google.com/d/",
        "https://drive.google.com/a/google.com/file/d/",
        "https://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "actions": [
          {
            "label": "Add images to email",
            "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "https://myownpersonaldomain.com/mypage?trigger=onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onLinkPreview",
          "patterns": [
              {
                "hostPattern": "example.com",
                "pathPrefix": "example-path"
              }
          ],
          "labelText": "Link preview",
          "localizedLabelText": {
            "es": "Link preview localized in Spanish"
          },
          "logoUrl": "https://www.example.com/images/smart-chip-icon.png"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCreateAction",
          "logoUrl": "https://www.example.com/images/case.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      }
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/calendar.addons.execute",
    "https://www.googleapis.com/auth/calendar.addons.current.event.read",
    "https://www.googleapis.com/auth/calendar.addons.current.event.write",
    "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
    "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.locale",
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/documents.currentonly",
    "https://www.googleapis.com/auth/spreadsheets.currentonly",
    "https://www.googleapis.com/auth/presentations.currentonly",
    "https://www.googleapis.com/auth/workspace.linkpreview"
  ]
}

将网址列入许可名单

您可以使用许可名单来指定预先批准了您的脚本或插件访问的特定网址。许可名单有助于保护用户数据；定义许可名单后，脚本项目将无法访问未列入许可名单的网址。

安装测试部署时，此字段为可选项，但创建版本化部署时为必填字段。

当您的脚本或插件执行以下操作时，可以使用许可名单：

• 使用 Apps 脚本 UrlFetch 服务从外部位置（例如 HTTPS 端点）检索或提取信息。如需将用于提取的网址列入许可名单，请在清单文件中添加 urlFetchWhitelist 字段。
• 在用户操作时打开或显示网址（对于打开或显示 Google 外部网址的 Google Workspace 插件是必需的）。如需将网址列入许可名单以供打开，请在清单文件中添加 addOns.common.openLinkUrlPrefixes 字段。

注意 ：urlFetchWhitelist 中使用的“白名单”是一个已弃用的术语，与“许可名单”同义并由许可名单取而代之。如需了解详情，请参阅撰写包容性文档。

将前缀添加到许可名单

在清单文件中指定许可名单时（通过添加 addOns.common.openLinkUrlPrefixes 或 urlFetchWhitelist 字段），必须包含网址前缀列表。您添加到清单中的前缀必须满足以下要求：

• 每个前缀都必须是有效网址。
• 每个前缀都必须使用 https://（而不是 http://）。
• 每个前缀都必须包含完整的域名。
• 每个前缀都必须具有非空路径。例如，https://www.google.com/ 是有效的，但 https://www.google.com 是无效的。
• 您可以使用通配符来匹配网址子网域前缀。
• 您可以在 addOns.common.openLinkUrlPrefixes 字段中使用单个 * 通配符来匹配所有链接，但不建议这样做，因为它可能会使用户数据面临风险，并且可能会延长插件审核过程。请仅在附加功能需要使用通配符时才使用通配符。

在确定网址是否与许可名单中的前缀匹配时，系统会应用以下规则：

• 路径匹配区分大小写。
• 如果前缀与网址相同，则表示匹配。
• 如果网址相同或是该前缀的子网址，则匹配。

例如，前缀 https://example.com/foo 与以下网址匹配：

• https://example.com/foo
• https://example.com/foo/
• https://example.com/foo/bar
• https://example.com/foo?bar
• https://example.com/foo#bar

使用通配符

您可以使用单个通配符 (*) 来同时匹配 urlFetchWhitelist 和 addOns.common.openLinkUrlPrefixes 字段的一个子网域。您不能使用多个通配符来匹配多个子网域，并且通配符必须表示网址的前导前缀。

例如，前缀 https://*.example.com/foo 与以下网址匹配：

• https://subdomain.example.com/foo
• https://any.number.of.subdomains.example.com/foo

前缀 https://*.example.com/foo 与以下网址不匹配：

• https://subdomain.example.com/bar（后缀不匹配）
• https://example.com/foo（必须至少包含一个子域名）

当您尝试保存清单时，系统会强制执行一些前缀规则。例如，如果您尝试保存时清单中包含以下前缀，则会导致错误：

• https://*.*.example.com/foo（禁止使用多个通配符）
• https://subdomain.*.example.com/foo（通配符必须用作前导前缀）