在 Google Apps 脚本中获取边框的最有效方法是什么

What is the most efficient way to get borders in Google Apps Script

在 Google Apps 脚本中获取边框详细信息的最佳方法是什么？

我在 GAS 的文档中看不到任何带边框的内容，所以我不得不求助于通过电子表格获取边框 API。

这工作正常，除了当边框数量变大时需要很长时间才能 return，或者根本不会 return。

有更好的方法吗？

var fieldsBorders = 'sheets(data(rowData/values/userEnteredFormat/borders))';

var currSsId = SpreadsheetApp.getActiveSpreadsheet().getId();
var activeSheet = SpreadsheetApp.getActiveSheet();
var name = activeSheet.getName();

var data = Sheets.Spreadsheets.get(currSsId, {
    ranges: name,
    fields: fieldsBorders
});
  • 您想减少从 Spreadsheet 中的 sheet 检索边框的过程成本。
  • 当我为 26 x 1000 单元格和 运行 您的脚本设置边框时，在我的环境中处理时间约为 50 秒。
    • 对于这种情况，你更希望降低成本。
    • 您的回复评论是perhaps it was a bigger sheet it was on, either way 50s is a long time to get the borders. The other calls to GAS take a very small amount of time to complete. Can you confirm this is the only way to get borders?

如果我的理解是正确的，这个解决方法怎么样？在此解决方法中，我直接请求 Sheets API 的端点以检索边框。

解决方法：

示例情况

在此示例脚本中，作为示例情况，我假设默认值 sheet 具有 26 列 x 1000 行，并且边框设置为所有单元格。

示例脚本 1：

在此示例脚本中，通过一次 API 调用检索边框。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var fileId = ss.getId();
var sheetName = ss.getActiveSheet().getName();
var token = ScriptApp.getOAuthToken();
var fields = "sheets/data/rowData/values/userEnteredFormat/borders";
var params = {
    method: "get",
    headers: {Authorization: "Bearer " +  token},
    muteHttpExceptions: true,
};
var range = sheetName + "!A1:Z1000";
var url = "https://sheets.googleapis.com/v4/spreadsheets/" + fileId + "?ranges=" + encodeURIComponent(range) + "&fields=" + encodeURIComponent(fields); 
var res = UrlFetchApp.fetch(url, params);
var result = JSON.parse(res.getContentText());
结果：
  • 使用示例脚本 1 时，平均处理时间为 2.2 秒。
    • 虽然我不清楚Advanced Google Service的Sheets API的内部流程，但发现直接向端点请求时，可以减少流程成本。

示例脚本 2：

在此示例脚本中，边框是通过多个 API 调用通过异步过程检索的。

var sep = 500; // Rows retrieving by 1 request.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var fileId = ss.getId();
var sheetName = ss.getActiveSheet().getName();
var token = ScriptApp.getOAuthToken();
var fields = "sheets/data/rowData/values/userEnteredFormat/borders";
var requests = [];
var maxRows = 1000;
var row = 1;
for (var i = 0; i < maxRows / sep; i++) {
  var range = sheetName + "!A" + row + ":Z" + (row + sep - 1);
  requests.push({
    method: "get",
    url: "https://sheets.googleapis.com/v4/spreadsheets/" + fileId + "?ranges=" + encodeURIComponent(range) + "&fields=" + encodeURIComponent(fields),
    headers: {Authorization: "Bearer " +  token},
  });
  row += sep;
}
var response = UrlFetchApp.fetchAll(requests);
var result = response.reduce(function(ar, e) {
  var obj = JSON.parse(e.getContentText());
  Array.prototype.push.apply(ar.sheets[0].data[0].rowData, obj.sheets[0].data[0].rowData);
  return ar;
}, {sheets: [{data: [{rowData: []}]}]});
结果：

使用示例脚本2时，得到如下结果。

  • 当 sep 为 500 时（在本例中，2 API 次调用为 运行），平均处理时间为 1.9 秒。
  • 当sep为200时（在本例中，5次API调用为运行），平均处理时间为1.3秒。

但是如果增加一个运行中的请求数，就会出现与超出配额相关的错误。请注意这一点。

注：

  • 这是一个用于测试上述情况的简单示例。所以我认为上面的脚本不能用于所有情况。如果您使用上述示例脚本，请根据您的情况进行修改。

参考文献：