O objeto de evento do Workspace Flows

Este guia oferece exemplos dos objetos de evento do Workspace Flows.

O Flows envia parâmetros de evento no objeto de evento comum dos complementos do Google Workspace usado em todos os complementos do Google Workspace. Para saber mais sobre o objeto de evento comum, consulte Objetos de evento dos complementos do Google Workspace.

O objeto de evento de fluxo inclui os seguintes objetos:

  • workflow: um evento que detalha o que acontece quando um fluxo é executado, criado, atualizado, excluído ou quando um recurso personalizado é solicitado. Dependendo do que acontece, ele tem os seguintes objetos:

    • actionInvocation: uma etapa é executada.
    • resourceRetrieval: um recurso personalizado é solicitado de um fluxo.

A tabela a seguir descreve qual objeto de evento é preenchido com base no que acontece em um fluxo:

Objeto de evento WorkflowAction WorkflowResource
actionInvocation OnExecuteFunction()

: chamado quando o OnExecuteFunction é invocado em uma ação.		 N/A
resourceRetrieval N/A providerFunction()

Chamado quando o recurso é solicitado do fluxo de trabalho.

actionInvocation

Como referência, veja um exemplo de evento de fluxo mostrando 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

Confira um exemplo de evento de fluxo mostrando 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"
    }
}