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

Question

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

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

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

有谁知道我如何传递makePostRequest 参数以便函数使用所需的数据执行？

Answer 1

从触发器启动函数时，不能传递参数。

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

史蒂芬

Answer 2

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

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

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 3

triggerDay 是一个Trigger，它有uniqueid。 makePostRequest 的第一个参数是 Time-driven event，它具有未记录的属性“triggerUid” , 因此，正如@St3ph 所说，您需要以某种方式存储“uniqueid”和“parameters”，并通过“triggerUid”从存储中获取它

Answer 4

这是可能的，但需要多个步骤。这里最重要的是event objects（@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);
}

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

此外，您可能必须使用script lock 来防止同时修改脚本属性。