如何将参数传递给基于时间的 Google App 脚本触发器？

Question

在我的脚本中，我从电子表格中读取数据并创建一个基于时间的触发器，以在特定时间使用其中一些数据发出 POST 请求。

问题是，我找不到任何方法将数据传递给触发器调用的函数。 Google App Script 文档提供的只是命名要调用的函数的能力，但无法传递参数。

 var triggerDay = new Date(2012, 11, 1);
 ScriptApp.newTrigger("makePostRequest")
   .timeBased()
   .at(triggerDay)
   .create();

有谁知道我如何传递

makePostRequest

参数，以便函数将使用所需的数据执行？

Answer 1

这是可能的，但需要多个步骤。这里最重要的是事件对象（由@St3ph提到）。

var RECURRING_KEY = "recurring";
var ARGUMENTS_KEY = "arguments";

/**
 * Sets up the arguments for the given trigger.
 *
 * @param {Trigger} trigger - The trigger for which the arguments are set up
 * @param {*} functionArguments - The arguments which should be stored for the function call
 * @param {boolean} recurring - Whether the trigger is recurring; if not the 
 *   arguments and the trigger are removed once it called the function
 */
function setupTriggerArguments(trigger, functionArguments, recurring) {
  var triggerUid = trigger.getUniqueId();
  var triggerData = {};
  triggerData[RECURRING_KEY] = recurring;
  triggerData[ARGUMENTS_KEY] = functionArguments;

  PropertiesService.getScriptProperties().setProperty(triggerUid, JSON.stringify(triggerData));
}

/**
 * Function which should be called when a trigger runs a function. Returns the stored arguments 
 * and deletes the properties entry and trigger if it is not recurring.
 *
 * @param {string} triggerUid - The trigger id
 * @return {*} - The arguments stored for this trigger
 */
function handleTriggered(triggerUid) {
  var scriptProperties = PropertiesService.getScriptProperties();
  var triggerData = JSON.parse(scriptProperties.getProperty(triggerUid));

  if (!triggerData[RECURRING_KEY]) {
    deleteTriggerByUid(triggerUid);
  }

  return triggerData[ARGUMENTS_KEY];
}

/**
 * Deletes trigger arguments of the trigger with the given id.
 *
 * @param {string} triggerUid - The trigger id
 */
function deleteTriggerArguments(triggerUid) {
  PropertiesService.getScriptProperties().deleteProperty(triggerUid);
}

/**
 * Deletes a trigger with the given id and its arguments.
 * When no project trigger with the id was found only an error is 
 * logged and the function continues trying to delete the arguments.
 * 
 * @param {string} triggerUid - The trigger id
 */
function deleteTriggerByUid(triggerUid) {
  if (!ScriptApp.getProjectTriggers().some(function (trigger) {
    if (trigger.getUniqueId() === triggerUid) {
      ScriptApp.deleteTrigger(trigger);
      return true;
    }

    return false;
  })) {
    console.error("Could not find trigger with id '%s'", triggerUid);
  }

  deleteTriggerArguments(triggerUid);
}

/**
 * Deletes a trigger and its arguments.
 * 
 * @param {Trigger} trigger - The trigger
 */
function deleteTrigger(trigger) {
  ScriptApp.deleteTrigger(trigger);
  deleteTriggerArguments(trigger.getUniqueId());
}

function example() {
  var trigger = ScriptApp.newTrigger("exampleTriggerFunction").timeBased()
    .after(5 * 1000)
    .create();

  setupTriggerArguments(trigger, ["a", "b", "c"], false);
}

function exampleTriggerFunction(event) {
  var functionArguments = handleTriggered(event.triggerUid);
  console.info("Function arguments: %s", functionArguments);
}

如果您还将脚本属性用于其他值，您可能必须嵌套触发器值。

此外，您可能必须使用脚本锁来防止并发修改脚本属性。

Answer 2

从触发器启动函数时无法传递参数。

您必须将此信息存储在某处以允许脚本找到它。例如，您说我知道您的电子表格中有一些数据，您可以将这些信息放入电子表格中。该函数将根据其触发时间来管理查找适当信息的方式。

史蒂芬

Answer 3

这个怎么样？

function test(a,b) {
  GmailApp.sendEmail('your_mail_address',a,b);
}
// Created a new function in global scope.
var test1 = test.bind(null,'aaaaa','bbbb');

function setTrigger(){ 
  ScriptApp.newTrigger('test1').timeBased().after(1 * 60 * 1000).create();
}

Answer 4

我不确定它是否能解决您的具体问题，但我发现的最方便的解决方法是将一个带参数的函数包装在一个不带参数的函数中，然后从您设置的静态变量中获取参数在脚本的顶层。

您仍然需要在脚本中设置值，但至少可以将逻辑分开，以便可以使用具有不同值的基本函数。

function functionAToTrigger(){
  functionToTriggerWithParams(myAParams);
}
var myAParams = {
  url: 'https://aurl.com',
  date: new Date(2012, 11, 1)
};
function functionBToTrigger(){
  functionToTriggerWithParams(myBParams);
}
var myBParams = {
  url: 'https://burl.com',
  date: new Date(2017, 11, 1)
};
function functionToTriggerWithParams(myParams){
   // Add some code to run some checks
   // Add some code here to log the results
}
ScriptApp.newTrigger(functionAToTrigger).timeBased().everyMinutes(10).create();
ScriptApp.newTrigger(functionBToTrigger).timeBased().everyMinutes(10).create();

Answer 5

triggerDay

是一个 Trigger，具有 uniqueid 。

makePostRequest

的第一个参数是时间驱动事件，它具有未记录的属性“triggerUid” , 因此，正如@St3ph所说，您需要以某种方式存储一对“uniqueid”和“parameters”，并通过“triggerUid”从存储中获取它

Answer 6

Osteria 的解决方案比其他解决方案优雅得多，但我无法仅通过创建绑定的变量来使其工作。仅当我的触发器调用创建绑定的函数时它才有效，如下所示：

function scheduler(){
  ScriptApp.newTrigger('run').timeBased().everyMinutes(1).create()
}

function run(){
  myFunction.bind(null, SOME_VALUE)()
}

在实际调用函数绑定之后添加

()

很重要。

Answer 7

我已经解决了这个问题。这只是一个例子。

function run(){
  const f = 'triggerHandlerFunc(1,7)';

  const triggers = ScriptApp.getProjectTriggers();

  if(triggers.length == 0){
    ScriptApp.newTrigger('tmpFunc').timeBased().after(500).create();
  }
  return f;
};

function triggerHandlerFunc(n,m){
  console.log(n,m);
}


const tmpFunc  = Function(`${run()}`);