Google Workspace ऐड-ऑन का एंडपॉइंट इंटरफ़ेस


सेवा की खास जानकारी

जब कोई उपयोगकर्ता, होस्ट किए गए किसी ऐप्लिकेशन (Gmail, Google Calendar, Google Drive, Google Chat, Google Docs, Google Sheets, Google Slides या Workspace Studio) में इंटरैक्शन ट्रिगर करता है, तो होस्ट आपके कॉन्फ़िगर किए गए ऐड-ऑन कॉलबैक यूआरएल (/*) पर एचटीटीपी POST इवेंट पेलोड भेजता है.

आपके ऐड-ऑन एंडपॉइंट को EventObject अनुरोध पेलोड मिलना चाहिए. साथ ही, उसे Response: HandleEventResponse में बताए गए पांच मान्य JSON रिस्पॉन्स टाइप में से कोई एक दिखाना चाहिए.


वेबहुक एंडपॉइंट कॉन्ट्रैक्ट

तरीका एंडपॉइंट पाथ अनुरोध का मुख्य भाग जवाब का मुख्य भाग
POST /* (या कॉन्फ़िगर किया गया कॉलबैक पाथ) EventObject जवाब के पांच टाइप में से एक

अनुरोध: EventObject

EventObject में टॉप-लेवल मेटाडेटा, सामान्य इवेंट फ़ील्ड, और होस्ट-ऐप्लिकेशन के संदर्भ की जानकारी शामिल होती है:

सामान्य और अनुमति से जुड़ा कॉन्टेक्स्ट

  • commonEventObject: उपयोगकर्ता की स्थान-भाषा, होस्ट किए गए ऐप्लिकेशन का enum (GMAIL, CALENDAR, DRIVE, CHAT, DOCS, SHEETS, SLIDES, WORKFLOW), उपयोगकर्ता का प्लैटफ़ॉर्म, टाइमज़ोन, विजेट फ़ॉर्म के इनपुट की वैल्यू (formInputs), और कस्टम पैरामीटर. CommonEventObject देखें.
  • authorizationEventObject: उपयोगकर्ता के OAuth ऐक्सेस टोकन, यूज़र आईडी टोकन, और सिस्टम से अनुमति वाले स्कोप. AuthorizationEventObject देखें.

होस्ट किए गए ऐप्लिकेशन के इवेंट ऑब्जेक्ट

कॉलबैक को शुरू करने वाले ऐप्लिकेशन के आधार पर, इनमें से कोई एक होस्ट ऑब्जेक्ट मौजूद होता है:

  • Gmail: मैसेज आईडी, थ्रेड आईडी, कुछ समय के लिए ऐक्सेस टोकन, और मैसेज पाने वाले लोगों की सूची (toRecipients, ccRecipients, bccRecipients). GmailEventObject देखें.
  • Calendar: इवेंट आईडी, बार-बार होने वाले इवेंट का आईडी, कैलेंडर आईडी, आयोजक की जानकारी, मेहमान, कॉन्फ़्रेंस का डेटा, और एंट्री पॉइंट. CalendarEventObject देखें.
  • Drive: चुनी गई फ़ाइलें या फ़ोल्डर (selectedItems) और कर्सर के मौजूदा आइटम का मेटाडेटा (activeCursorItem). DriveEventObject देखें.
  • Chat: इवेंट टाइप (ADDED_TO_SPACE, REMOVED_FROM_SPACE, MESSAGE, CARD_CLICKED), स्पेस का मेटाडेटा, उपयोगकर्ता की जानकारी, और पेलोड डेटा. ChatEventObject देखें.
  • Workspace Studio: ऐक्शन को शुरू करना, लाइफ़साइकल इवेंट को ट्रिगर करना, एलिमेंट कॉन्फ़िगरेशन, संसाधन वापस पाना, और वैरिएबल डेटा मैप. WorkflowEventObject देखें.
  • Docs: दस्तावेज़ का आईडी, टाइटल, फ़ाइल के स्कोप की अनुमति का फ़्लैग, और मैच होने वाला यूआरएल पैटर्न. DocsEventObject देखें.
  • Sheets: स्प्रेडशीट का आईडी, टाइटल, फ़ाइल-स्कोप की अनुमति का फ़्लैग, और मैच होने वाला यूआरएल पैटर्न. SheetsEventObject देखें.
  • Slides: प्रज़ेंटेशन आईडी, टाइटल, फ़ाइल-स्कोप की अनुमति वाला फ़्लैग, और मैच होने वाला यूआरएल पैटर्न. SlidesEventObject देखें.

जवाब: HandleEventResponse

आपके वेबहुक एंडपॉइंट से मिला एचटीटीपी रिस्पॉन्स, बिना टैग वाला रूट JSON ऑब्जेक्ट होता है. यह इन पांच रिस्पॉन्स टाइप में से किसी एक का इंस्टेंस होना चाहिए:

  1. RenderActions: यह नए कार्ड रेंडर करता है, कार्ड स्टैक पर नेविगेट करता है या यूज़र इंटरफ़ेस (यूआई) से जुड़ी कार्रवाइयां करता है. उदाहरण के लिए, {"action": {"navigations": [...]}} या {"renderActions": ...}.
  2. SubmitFormResponse: यह कार्ड रेंडर करने के निर्देशों और स्थिति अपडेट करने के वैकल्पिक इंडिकेटर (उदाहरण के लिए, {"renderActions": {...}, "stateChanged": true}) के साथ, उपयोगकर्ता के फ़ॉर्म सबमिट करने की कार्रवाई का जवाब देता है.
  3. GetAutocompletionResponse: यह विजेट के ऑटोकंप्लीट फ़ील्ड के लिए, डाइनैमिक टेक्स्ट के सुझाव देता है. उदाहरण के लिए, {"autoComplete": {"items": [...]}}.
  4. DataActions: यह कॉलबैक से ट्रिगर होने वाले दस्तावेज़ में बदलाव या Chat स्पेस की कार्रवाइयां करता है. उदाहरण के लिए, {"hostAppDataAction": {...}}.
  5. AuthorizationError: यह उपयोगकर्ता को तीसरे पक्ष के बाहरी क्रेडेंशियल को अनुमति देने के लिए कहता है या Google OAuth के अतिरिक्त दायरों (उदाहरण के लिए, {"basicAuthorizationPrompt": {"authorizationUrl": "..."}}) का अनुरोध करता है.

स्टैंडअलोन OpenAPI 3.0 स्पेसिफ़िकेशन और JSON स्कीमा

अपने कॉलबैक एंडपॉइंट के लिए, सर्वर स्टब, एसडीके क्लाइंट लाइब्रेरी या पेलोड की पुष्टि करने वाले स्कीमा अपने-आप जनरेट करने के लिए, यहां दी गई खास जानकारी वाली फ़ाइलें देखें:

  • OpenAPI 3.0.3 specification: addon_callback_openapi.json
  • JSON स्कीमा की परिभाषाएं: endpoint_interface.schema.json
    • स्कीमा फ़्रैगमेंट का अनुरोध करें: endpoint_interface.schema.json#/definitions/GoogleAppsAddonsV1EventObject
    • जवाब स्कीमा फ़्रैगमेंट: endpoint_interface.schema.json#/definitions/GoogleAppsAddonsV1HandleEventResponse