كائن حدث Workspace Studio

يقدّم هذا الدليل أمثلة على عناصر أحداث Workspace Studio.

ترسل البرامج الوكيلة مَعلمات الأحداث في عنصر حدث الإضافات الشائعة في 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"
    }
}