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

How can I pass a parameter to a time-based Google App Script trigger?

本文关键字:时间 Google App 触发器 Script 参数传递 于时间      更新时间:2023-09-26

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

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

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

有人知道我如何传递makePostRequest参数,以便函数将执行所需的数据吗?

这是可能的,但需要多个步骤。这里最重要的是事件对象(由@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);
}

如果您还使用其他值的脚本属性,则可能需要嵌套触发器值。

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

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

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

Stephane

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

您仍然必须在脚本中设置值,但至少您可以保持逻辑分离,以便您可以使用具有不同值的基本函数。

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();

这个怎么样?

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();
}

triggerDay是一个唯一的触发器。makePostRequest的第一个参数是时间驱动事件,它有未记录的属性"triggerUid"。,所以就像刚才说的@St3ph你需要存储一对你的"uniqueid"answers"parameters"并通过"triggerUid"从存储中获取