Workspace Flows のイベント オブジェクト

このガイドでは、Workspace Flows のイベント オブジェクトの例を示します。

フローは、Google Workspace アドオン全体で使用される共通の Google Workspace アドオン イベント オブジェクトでイベント パラメータを送信します。共通イベント オブジェクトについて詳しくは、Google Workspace アドオンのイベント オブジェクトをご覧ください。

フロー イベント オブジェクトには、次のオブジェクトが含まれます。

  • workflow: フローの実行、作成、更新、削除、またはカスタム リソースのリクエスト時に発生する内容を詳しく説明するイベント。発生した内容に応じて、次のオブジェクトがあります。

    • actionInvocation: ステップが実行されます。
    • resourceRetrieval: フローからカスタム リソースがリクエストされます。

次の表に、フローで発生した内容に基づいてどのイベント オブジェクトが入力されるかを示します。

イベント オブジェクト WorkflowAction WorkflowResource
actionInvocation OnExecuteFunction()

Action で 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"
    }
}