网络应用

如果您为脚本构建了用户界面，请将该脚本发布为 Web 应用。例如，如果某个脚本可让用户与支持团队成员预约，最好将其呈现为 Web 应用，以便用户直接通过浏览器访问。

只要满足以下要求，独立脚本和绑定到 Google Workspace 应用的脚本都可以转换为 Web 应用。

Web 应用的要求

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

请求参数

当用户访问应用或程序向应用发送 HTTP GET 请求时，Google Apps 脚本会运行函数 doGet。当程序向应用发送 HTTP POST 请求时，Apps 脚本会运行 doPost。在这两种情况下，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 返回以下输出：

{
  "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 requested does not exist.”。如果可以，请更新脚本以使用其他参数名称。

将脚本部署为 Web 应用

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

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

与您希望使用您的 Web 应用的用户共享该网址，前提是您已向他们授予访问权限。

如果部署在一个网域中的 Web 应用的所有权更改为其他网域中的共享云端硬盘或账号，则这些 Web 应用将停止运行。新所有者或协作者可以在新网域中重新部署 Web 应用，从而更正此问题。或者，如果将 Web 应用移回其原始网域，则该 Web 应用会再次在该网域中正常运行，而无需重新部署。

测试 Web 应用部署

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

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

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

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

如需在 Web 应用上测试精细 OAuth 功能，请确保您的项目尚无任何授权。如需使所有现有授权失效，请使用 ScriptApp.invalidateAuth。对于已部署并以活跃用户的身份运行的任何 Web 应用，请将清单中的 executeAs JSON 字段修改为 USER_DEPLOYING。

在部署以开发者身份运行的 Web 应用时，请务必谨慎处理通过 ScriptApp.getOAuthToken 获取的 OAuth 令牌。这些令牌可授予其他应用对您数据的访问权限，切勿将其传输给客户端。

权限

Web 应用的权限因您选择执行应用的方式而异：

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

为防止滥用，Apps 脚本对新用户授权以用户身份执行的 Web 应用的速率施加了限制。这些限制取决于发布账号是否属于 Google Workspace 网域等因素。

使用共享云端硬盘在 Web 应用中展开协作。 当部署共享云端硬盘中的 Web 应用时，选择“以您的身份执行”会导致 Web 应用在部署它的用户的权限下执行（因为没有脚本所有者）。

在 Google 协作平台中嵌入 Web 应用 {:#embed-web-app}

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

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

如需将 Web 应用嵌入 Google 协作平台页面，请按以下步骤操作：

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

Web 应用会显示在网页预览的框架中。发布网页后，网站浏览者可能需要先授权该 Web 应用，然后该应用才能正常执行。未经授权的 Web 应用会向用户显示授权提示。

Web 应用和浏览器历史记录

如需模拟多页应用或使用网址参数控制的动态界面，请定义一个状态对象来表示应用的界面或网页，并在用户浏览应用时将该状态推送到浏览器历史记录中。监听历史记录事件，以便在用户使用浏览器按钮来回浏览时，您的 Web 应用显示正确的界面。通过在加载时间查询网址参数，让您的应用根据这些参数动态构建其界面，从而允许用户以特定状态启动应用。

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

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

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

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