Objets d'événement Workspace Studio

Ce guide fournit des exemples d'objets d'événement Workspace Studio.

Flows envoie des paramètres d'événement dans l'objet d'événement commun des modules complémentaires Google Workspace, utilisé dans tous les modules complémentaires Google Workspace. Pour en savoir plus sur l'objet d'événement commun, consultez Objets d'événement des modules complémentaires Google Workspace.

L'objet d'événement de flux inclut les objets suivants :

  • workflow: événement décrivant ce qui se passe lorsqu'un flux est exécuté, créé, mis à jour ou supprimé, ou lorsqu'une ressource personnalisée est demandée. Selon ce qui se passe, il comporte les objets suivants :

    • actionInvocation: une étape est exécutée.
    • resourceRetrieval: une ressource personnalisée est demandée à partir d'un flux.

Le tableau suivant indique l'objet d'événement qui est renseigné en fonction de ce qu'un flux fait :

Objet d'événement Action de workflow Ressource de workflow
actionInvocation onExecuteFunction

Appelé lorsque onExecuteFunction est appelé sur une action.		 Non applicable
resourceRetrieval Non applicable providerFunction

Appelé lorsque la ressource est demandée à partir du workflow.

actionInvocation

L'exemple suivant montre un événement 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

L'exemple suivant montre un événement 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"
    }
}