本指南提供了 Workspace Flows 事件对象的示例。
Flows 会在整个 Google Workspace 加载项中使用的通用 Google Workspace 加载项事件对象中发送事件参数。如需详细了解通用事件对象,请参阅 Google Workspace 加购项事件对象。
流程事件对象包含以下对象:
workflow:详细说明了在以下情况下会发生什么情况的事件:流程运行、创建、更新、删除或请求自定义资源。根据发生的情况,它具有以下对象:actionInvocation:运行某个步骤。resourceRetrieval:从 flow 请求自定义资源。
下表概述了系统会根据流程中发生的情况填充哪个事件对象:
| 事件对象 | WorkflowAction | WorkflowResource |
|---|---|---|
actionInvocation |
OnExecuteFunction() 当对操作调用 OnExecuteFunction 时,系统会调用此方法。 |
无 |
resourceRetrieval |
无 | providerFunction() 当从工作流请求资源时调用。 |
actionInvocation
以下是一个展示 actionInvocation 的流程事件示例,供您参考:
JSON
{
"workflow": {
"triggerEventSource": "TRIGGER_EVENT_SOURCE_AUTOMATED",
"actionInvocation": {
"inputs": {
"operation": {
"stringValues": [
"+"
]
},
"value2": {
"integerValues": [
2
]
},
"value1": {
"integerValues": [
2
]
}
}
}
},
"userLocale": "en",
"hostApp": "flows",
"clientPlatform": "web",
"commonEventObject": {
"timeZone": {
"offset": -14400000,
"id": "America/New_York"
},
"userLocale": "en-US",
"hostApp": "WORKFLOW",
"platform": "WEB"
},
"userCountry": "US",
"userTimezone": {
"id": "America/New_York",
"offSet": "-14400000"
}
}
resourceRetrieval
以下是一个展示 resourceRetrieval 的流程事件示例:
JSON
{
"workflow": {
"resourceRetrieval": {
"resourceReference": {
"resourceType": {
"workflowBundleId": "workflow_bundle_id",
"workflowResourceDefinitionId": "workflow_resource_definition_id"
},
"resourceId": "resource_id"
}
}
},
"userLocale": "en",
"hostApp": "flows",
"clientPlatform": "web",
"commonEventObject": {
"timeZone": {
"offset": -14400000,
"id": "America/New_York"
},
"userLocale": "en-US",
"hostApp": "WORKFLOW",
"platform": "WEB"
},
"userCountry": "US",
"userTimezone": {
"id": "America/New_York",
"offSet": "-14400000"
}
}