阻止自定义函数在 Google 电子表格 Google Apps 脚本中执行

Question

在编写要在电子表格单元格中使用的自定义函数时，工作表的默认行为是在编辑时重新计算，即添加列或行将导致自定义函数更新。

这是一个问题，如果自定义函数调用付费 API 并使用积分，用户将自动消耗 API 积分。

我想不出办法来防止这种情况发生，所以我决定使用UserCache 将结果缓存任意 25 分钟，并在用户碰巧重复相同的函数调用时将其返回给用户.它绝对不是防弹的，但我想它总比没有好。显然是cache can hold 10mb，但这是正确的方法吗？我可以做一些更聪明的事情吗？

  var _ROOT = {

  cache : CacheService.getUserCache(),
  cacheDefaultTime: 1500,

  // Step 1 -- Construct a unique name for function call storage using the 
  // function name and arguments passed to the function
  // example: function getPaidApi(1,2,3) becomes "getPaidApi123"

  stringifyFunctionArguments : function(functionName,argumentsPassed) {
    var argstring = ''
    for (var i = 0; i < argumentsPassed.length; i++) {
      argstring += argumentsPassed[i]
    }

    return functionName+argstring

  },

  //Step 2 -- when a user calls a function that uses a paid api, we want to 
  //cache the results for 25 minutes

  addToCache : function (encoded, returnedValues) { 

    var values = {
      returnValues : returnedValues
    }
    Logger.log(encoded)
    this.cache.put(encoded, JSON.stringify(values), this.cacheDefaultTime)

  }

  //Step 3 -- if the user repeats the exact same function call with the same 
  //arguments, we give them the cached result
  //this way, we don't consume API credits as easily. 

  checkCache : function(encoded) {

    var cached = this.cache.get(encoded);

    try {
      cached = JSON.parse(cached)
      return cached.returnValues
    } catch (e) {
      return false;
    }
  }

}

Answer 1

Google 表格已经缓存了自定义函数的值，并且只有在 a) 函数的输入发生更改或 b) 电子表格在长时间关闭后被打开时才会再次运行它们。我无法复制您在添加和删除列时提到的重新计算。这是我用来测试的一个简单示例函数：

function rng() {
  return Math.random();
}

一般来说，您为昂贵的查询使用额外缓存的方法看起来不错。我建议使用DocumentCache 而不是UserCache，因为文档的所有用户都可以并且应该看到相同的单元格值。

我还建议对函数签名进行更健壮的编码，因为您当前的实现能够区分参数[1, 2] 和[12]。您可以对输入进行字符串化，然后对其进行 base64 编码以实现紧凑性：

function encode(functionName, argumentsPassed) {
  var data = [functionName].concat(argumentsPassed);
  var json = JSON.stringify(data);
  return Utilities.base64Encode(json);
}