网络应用

如果您为脚本构建界面，可以将脚本发布为 Web 应用。例如，允许用户安排与支持团队成员预约的脚本最好以 Web 应用的形式呈现，以便用户直接从浏览器访问此脚本。

独立脚本和绑定到 Google Workspace 应用的脚本均可转换为 Web 应用，前提是它们满足以下要求。

针对 Web 应用的要求

如果脚本满足以下要求，则可以作为 Web 应用发布：

• 它包含 doGet(e) 或 doPost(e) 函数。
• 该函数会返回一个 HTML 服务 HtmlOutput 对象或内容服务 TextOutput 对象。

请求参数

当用户访问某个应用，或者某个程序向该应用发送 HTTP GET 请求时，Apps 脚本会运行 doGet(e) 函数。当某个程序向应用发送 HTTP POST 请求时，Apps 脚本会改为运行 doPost(e)。在这两种情况下，e 参数都表示事件参数，可以包含有关任何请求参数的信息。事件对象的结构如下表所示：

字段
e.queryString	网址中查询字符串部分的值，如果未指定查询字符串，则为 null name=alice&n=1&n=2
e.parameter	与请求参数相对应的键值对对象。 对于具有多个值的参数，仅返回第一个值。 {"name": "alice", "n": "1"}
e.parameters	一个类似于 e.parameter 的对象，但每个键都有一个值数组 {"name": ["alice"], "n": ["1", "2"]}
e.pathInfo	/exec 或 /dev 之后的网址路径。 例如，如果网址路径以 /exec/hello 结尾，则路径信息为 hello。
e.contextPath	不使用，始终为空字符串。
e.contentLength	对于 POST 请求，请求正文的长度；对于 GET 请求，则为 -1 332
e.postData.length	与 e.contentLength 相同 332
e.postData.type	POST 正文的 MIME 类型 text/csv
e.postData.contents	POST 正文的内容文本 Alice,21
e.postData.name	始终为“postData”值 postData

例如，您可以将 username 和 age 等参数传递给网址，如下所示：

https://script.google.com/.../exec?username=jsmith&age=21

然后，您可以按如下方式显示参数：

function doGet(e) {
  var params = JSON.stringify(e);
  return ContentService.createTextOutput(params).setMimeType(ContentService.MimeType.JSON);
}

在上面的示例中，doGet(e) 返回以下输出：

{
  "queryString": "username=jsmith&age=21",
  "parameter": {
    "username": "jsmith",
    "age": "21"
  },
  "contextPath": "",
  "parameters": {
    "username": [
      "jsmith"
    ],
    "age": [
      "21"
    ]
  },
  "contentLength": -1
}

警告 ：以下参数名称是系统预留的，不应在网址参数或 POST 正文中使用：

• c
• sid

使用这些参数可能会导致 HTTP 405 响应，以及错误消息“Sorry, the file you have request does not relevant”（抱歉，您请求的文件不存在）。如果可能，请更新您的脚本以使用不同的参数名称。

将脚本部署为 Web 应用

如需将脚本部署为 Web 应用，请按以下步骤操作：

1. 在脚本项目的右上角，点击部署 > 新建部署。
2. 在“选择类型”旁边，依次点击“启用部署类型”图标 > Web 应用。
3. 在“部署配置”下的字段中输入有关您的 Web 应用的信息。
4. 点击部署。

您可以与要使用您应用的用户分享 Web 应用网址，前提是您已授予他们访问权限。

注意 ：如果在一个网域中部署的 Web 应用的所有权更改为其他网域中的共享云端硬盘或帐号，这些应用将停止运行。可以通过让新的所有者或协作者在新网域中重新部署 Web 应用来纠正此问题。或者，如果将 Web 应用移回其原始网域，该 Web 应用将重新开始在该网域上运行，而无需重新部署。

测试 Web 应用部署

如需将脚本作为 Web 应用进行测试，请按以下步骤操作：

1. 在脚本项目的右上角，点击部署 > 测试部署。
2. 在“选择类型”旁边，依次点击“启用部署类型”图标 > Web 应用。
3. 在 Web 应用网址下方，点击复制。

4. 将该网址粘贴到浏览器中并测试您的 Web 应用。

   此网址以 /dev 结尾，只有拥有脚本修改权限的用户才能访问。此应用实例始终运行最新保存的代码，并且仅用于开发期间的测试。

警告 ：部署要以开发者身份运行的 Web 应用时，在处理通过 ScriptApp.getOAuthToken() 获取的 OAuth 令牌时，应格外小心。这些令牌可授予其他应用访问您的数据的权限，但绝不能将其传输给客户端。

权限

Web 应用的权限取决于您选择的应用执行方式：

• Execute the app as me - 在这种情况下，无论谁访问 Web 应用，脚本始终以您（脚本的所有者）的身份执行。
• 以访问 Web 应用的用户的身份执行应用 - 在这种情况下，脚本以 Web 应用的活跃用户的身份运行。此权限方法会使 Web 应用在用户授予访问权限时显示脚本所有者的电子邮件地址。

警告 ：为了防止滥用，Apps 脚本会限制新用户向以其用户身份执行的 Web 应用授权的速率限制。这些限制还取决于多个因素，其中之一是发布帐号是否属于 Google Workspace 网域。

注意 ：您可以使用共享云端硬盘协作处理 Web 应用。在部署共享模式下的 Web 应用时，选择“按您的方式执行”会导致 Web 应用在部署该应用的用户的权限下执行（因为没有脚本所有者）。

在 Google 协作平台中嵌入您的 Web 应用

警告 ：嵌入式 Web 应用仍应具备访问权限，以防止恶意使用。如果您的嵌入式 Web 应用似乎无法正常运行，请检查该应用所有者和网域管理员设置的权限是否允许使用该应用。

如需将 Web 应用嵌入到 Google 协作平台中，必须先部署该应用。您还需要 Deploy 对话框中的已部署网址。

如需将 Web 应用嵌入到网站页面中，请按以下步骤操作：

1. 打开您要在其中添加 Web 应用的“网站”页面。
2. 依次选择插入 > 嵌入网址。
3. 粘贴 Web 应用网址，然后点击添加。

Web 应用显示在页面预览的框架中。当您发布页面时，网站查看者可能需要授权 Web 应用才能正常执行。未经授权的 Web 应用会向用户显示授权提示。

Web 应用和浏览器历史记录

最好让 Apps 脚本 Web 应用模拟多页应用，或具有通过网址参数控制的动态界面的应用。为了做到这一点，您可以定义一个状态对象来表示应用的界面或页面，并在用户浏览应用时将该状态推送到浏览器历史记录中。您还可以监听历史记录事件，以便当用户使用浏览器按钮来回导航时，您的 Web 应用会显示正确的界面。通过在加载时查询网址参数，您可以让应用基于这些参数动态构建界面，从而允许用户在特定状态下启动应用。

Apps 脚本提供了两个异步客户端 JavaScript API，用于协助创建与浏览器历史记录相关联的 Web 应用：

• google.script.history 提供了允许对浏览器历史记录更改进行动态响应的方法。其中包括：将状态（您可以定义的简单对象）推送到浏览器历史记录中、替换历史记录堆栈中的顶部状态，以及设置监听器回调函数来响应历史记录更改。

• google.script.url 提供了检索当前页面的网址参数和网址片段（如果存在）的方法。

这些历史记录 API 仅适用于 Web 应用。边栏、对话框或插件不支持显示对话框。此外，不建议在嵌入 Google 协作平台的 Web 应用中使用此功能。