在更改任何 Google 表格文件时调用 API 端点

Question

我希望达到的目标：

每当我的共享驱动器上的任何谷歌工作表中的单元格（由域中的任何用户）更改时，我都想调用 API 端点并包含有关编辑了哪个单元格的信息。

我的方法：我相信 Google App Scripts Add-on 是我所需要的。为域上的所有用户安装。

我看到有“绑定”脚本和独立脚本。对于独立脚本，除了基​​于计时器和日历的触发器之外，我无法创建任何其他触发器。绑定脚本似乎永久绑定到单个工作表，不会以任何方式影响其他工作表。

我错过了什么？

我在博客上找到了一些用于制作绑定脚本的端到端教程，但没有关于通用跨域内容的教程。

Answer 1

您可以通过一个独立的脚本来实现这一切。创建一个独立的脚本并按照以下步骤操作：

第 1 步：获取电子表格 ID

首先，您必须id在共享驱动器中获取不同电子表格的 。如果您使用 ，则可以在 Google Apps Script 本身中执行此操作Advanced Drive Service（请参阅下面的参考）。要激活此服务，请转到Resources > Advanced Google services...脚本编辑器并启用Drive API.

然后，编写一个函数，该函数将返回ids共享驱动器中电子表格的数组。你将不得不呼吁Drive.Files.list。它可能是以下几行（请driveId在相应的行中写下您的共享）：

function getFileIds() {
  var params = {
    corpora: "drive",
    driveId: "your-shared-drive-id", // Please change this accordingly
    includeItemsFromAllDrives: true,
    q: "mimeType = 'application/vnd.google-apps.spreadsheet'",
    supportsAllDrives: true
  }
  var files = Drive.Files.list(params)["items"];
  var ids = files.map(function(file) {
    return file["id"];
  })
  return ids;
}

第 2 步：为每个电子表格创建触发器

以onEdit编程方式为每个电子表格安装一个触发器（每次编辑相应的电子表格时，编辑触发器都会触发一个函数，所以我假设这是您想要的触发器）。为此，ids将使用在步骤 1 中检索到的。它可能与此类似：

function createTriggers(ids) {
  ids.forEach(function(id) {
    var ss = SpreadsheetApp.openById(id);
    createTrigger(ss);
  })
}

function createTrigger(ss) {
  ScriptApp.newTrigger('sendDataOnEdit')
    .forSpreadsheet(ss)
    .onEdit()
    .create();
}

该函数createTriggers获取一个数组ids作为参数，并为每个id，创建一个onEdit触发器：每次编辑这些电子表格中的任何一个时，该函数sendDataOnEdit都会运行，这就是您想要使用有关已编辑单元格的信息调用 API 端点的地方。

第 3 步：调用 API 端点

该函数sendDataOnEdit必须从编辑过的单元格中获取数据并将其发送到某个地方。

function sendDataOnEdit(e) {
  // Please fill this up accordingly
  var range = e.range;
  var value = range.getValue();
  UrlFetchApp.fetch(url, params) // Please fill this up accordingly
}

首先，它可以获取有关通过事件对象编辑的单元格的信息，作为参数传递给函数e（您可以获取它的列、行、值、工作表和它所在的电子表格等） . 例如，要检索单元格的值，您可以执行e.range.getValue(). 检查我提供的链接以获取有关此的更多详细信息。

其次，当您正确检索到要发送的数据后，您可以使用UrlFetchApp.fetch(url, params)向您的 URL 发出请求。在我下面提供的链接中，您可以看到可以在此处指定的参数（例如，HTTP 方法、有效负载等）。

请记住，如果这不是公开的，您可能需要授予一些访问 API 端点的授权。检查我在下面附加的 OAuth 参考。

（你必须相应地编辑这个函数来检索和发送你想要的东西。我写的是一个例子）。

总结一下：

为了创建触发器，您应该运行createTriggers一次（如果您多次运行它，它将开始创建重复项）。例如，运行这个函数，它首先ids通过 Drive API获取文件，然后创建相应的触发器：

function sendDataOnEdit(e) {
  // Please fill this up accordingly
  var range = e.range;
  var value = range.getValue();
  UrlFetchApp.fetch(url, params) // Please fill this up accordingly
}

此外，拥有一个删除所有触发器的函数会很有用。如果您想从新开始并确保没有重复项，请运行此命令：

function main() {
  var ids = getFileIds();
  createTriggers(ids);
}

参考：

• 高级驱动服务
• 驱动器.文件.列表
• onEdit 触发器
• 以编程方式安装触发器
• onEdit 事件对象
• UrlFetchApp.fetch(url, params)
• 连接到外部 API
• 适用于 Apps 脚本的 OAuth2
• ScriptApp.deleteTrigger(触发器)

我希望这有任何帮助。