Workspace Flows 事件物件

本指南提供 Workspace Flows 事件物件的範例。

Flows 會在整個 Google Workspace 外掛程式中使用的常見 Google Workspace 外掛程式事件物件中傳送事件參數。如要進一步瞭解常見的事件物件,請參閱「Google Workspace 外掛程式事件物件」。

流程事件物件包含下列物件:

  • workflow:詳細說明流程執行、建立、更新、刪除或要求自訂資源時發生情況的事件。視情況而定,這項事件會包含下列物件:

    • actionInvocation:步驟執行。
    • resourceRetrieval:從流程要求自訂資源。

下表根據流程中發生的情況,列出填入的事件物件:

事件物件 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"
    }
}