Google Workspace Events API का इस्तेमाल करके इवेंट की सदस्यता लेना

इस पेज पर, Google Workspace Events API के बारे में खास जानकारी दी गई है. साथ ही, यह बताया गया है कि Google Workspace के सभी ऐप्लिकेशन में होने वाले इवेंट की सूचना पाने के लिए, इस एपीआई का इस्तेमाल कैसे किया जा सकता है.

Google Workspace इवेंट, Google Workspace के संसाधनों में हुए बदलावों को दिखाते हैं. जैसे, संसाधन कब बनाए गए, अपडेट किए गए या मिटाए गए. आपका ऐप्लिकेशन, Google Workspace के किसी संसाधन की सदस्यता ले सकता है. इससे आपको काम के ऐसे इवेंट मिलेंगे जिनमें आपकी दिलचस्पी है.

आपका ऐप्लिकेशन इवेंट कैसे पाता है

अपने ऐप्लिकेशन को Google Workspace इवेंट पाने की अनुमति देने के लिए, Google Workspace Events API का इस्तेमाल करके, Google Workspace संसाधनों की सदस्यताएं बनाएं.

Google Workspace Events API के इवेंट डिलीवर करने के तरीके का उदाहरण.
पहली इमेज. इस उदाहरण में बताया गया है कि Google Workspace Events API, Chat ऐप्लिकेशन को इवेंट कैसे डिलीवर करता है.

इस उदाहरण में बताया गया है कि Google Workspace Events API, सदस्यता के ज़रिए Google Chat ऐप्लिकेशन को इवेंट कैसे डिलीवर करता है:

  1. Chat ऐप्लिकेशन, किसी Chat स्पेस की सदस्यता लेता है.
  2. चैट स्पेस बदल जाता है. उदाहरण के लिए, स्पेस में कोई नया मैसेज पोस्ट किया गया है.
  3. Chat, Google Cloud Pub/Sub में किसी विषय को इवेंट डिलीवर करता है. यह विषय, सदस्यता के लिए सूचना एंडपॉइंट के तौर पर काम करता है. इवेंट में, बदलावों के बारे में डेटा होता है. उदाहरण के लिए, नए मैसेज से जुड़े किसी इवेंट के लिए, इवेंट में बनाए गए Message संसाधन के बारे में जानकारी होती है.
  4. Chat ऐप्लिकेशन, Google Cloud Pub/Sub के उस मैसेज को प्रोसेस करता है जिसमें इवेंट की जानकारी होती है. साथ ही, ज़रूरत पड़ने पर कार्रवाई करता है.

अहम शब्दावली

Google Workspace Events API में इस्तेमाल होने वाले सामान्य शब्दों की सूची यहां दी गई है:

Google Workspace इवेंट

Google Workspace के किसी संसाधन में बदलाव. इवेंट, CloudEvents स्पेसिफ़िकेशन का इस्तेमाल करके फ़ॉर्मैट किए जाते हैं. ये सदस्यता इवेंट या लाइफ़साइकल इवेंट हो सकते हैं:

सदस्यता इवेंट
Google Workspace के उस संसाधन में कोई बदलाव हुआ है जिसे मॉनिटर किया जा रहा है. जैसे, Google Chat स्पेस में कोई नया मैसेज. यह तय किया जा सकता है कि आपको बदले गए संसाधन के बारे में कितनी जानकारी चाहिए. ज़्यादा जानकारी के लिए, Google Workspace इवेंट का स्ट्रक्चर देखें.
लाइफ़साइकल इवेंट
Google Workspace की आपकी सदस्यता के बारे में इवेंट. लाइफ़साइकल इवेंट से आपको समस्याओं और सदस्यता की स्थिति के बारे में सूचना मिलती है, ताकि आप सदस्यता से जुड़े इवेंट को मिस न करें. डिफ़ॉल्ट रूप से, आपकी सदस्यता को हमेशा लाइफ़साइकल इवेंट मिलते हैं. ज़्यादा जानकारी के लिए, Google Workspace की सदस्यताओं के लाइफ़साइकल इवेंट देखें.
Google Workspace की सदस्यता

यह एक ऐसी इकाई होती है जो Google Workspace ऐप्लिकेशन के किसी संसाधन पर नज़र रखती है. सदस्यता को Subscription संसाधन के तौर पर दिखाया जाता है. सदस्यता के बारे में यहां दी गई जानकारी से पता चलता है:

टारगेट संसाधन
वह Google Workspace संसाधन जिसकी आपको निगरानी करनी है. यह संसाधन, Google Workspace की सदस्यता के targetResource फ़ील्ड में दिखाया जाता है. हर सदस्यता सिर्फ़ एक संसाधन की निगरानी कर सकती है. Google Workspace Events API के साथ काम करने वाले Google Workspace संसाधनों के बारे में जानने के लिए, Google Workspace के साथ काम करने वाले इवेंट देखें.
इवेंट के टाइप
टारगेट रिसॉर्स के लिए, आपको जिस तरह के बदलावों की सूचना चाहिए. उदाहरण के लिए, अगर आपने Google Chat के किसी स्पेस की सदस्यता ली है, तो आपके पास यह चुनने का विकल्प होता है कि आपको उस स्पेस और उसके चाइल्ड रिसॉर्स (जैसे कि सदस्यताएं और मैसेज) के बारे में सूचनाएं मिलें या नहीं.
सूचना एंडपॉइंट
वह एंडपॉइंट जहां Google Workspace की सदस्यता को इवेंट मिलते हैं. Google Workspace Events API, Google Cloud Pub/Sub विषयों को सूचना एंडपॉइंट के तौर पर इस्तेमाल करता है. Google Cloud Pub/Sub का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, Google Cloud Pub/Sub का दस्तावेज़ पढ़ें.
पे लोड के विकल्प
बदले गए संसाधनों के बारे में आपको जो इवेंट डेटा चाहिए.

Google Workspace के साथ काम करने वाले इवेंट

आपका ऐप्लिकेशन किन इवेंट को पा सकता है, यह आपकी सदस्यता के टारगेट रिसॉर्स पर निर्भर करता है. इस टेबल में, हर टारगेट रिसोर्स के लिए इस्तेमाल किए जा सकने वाले इवेंट दिखाए गए हैं.

टारगेट संसाधन समर्थित इवेंट
Google Chat स्पेस
  • Messages
  • सदस्यताएं
  • प्रतिक्रियाएं
  • स्पेस
Google Chat के उपयोगकर्ता
  • सदस्यताएं
Google Drive की फ़ाइलें
  • फ़ाइलें
  • ऐक्सेस करने के अनुरोध
Google Drive की शेयर की गई ड्राइव
  • फ़ाइलें
  • ऐक्सेस करने के अनुरोध
Google Meet के मीटिंग स्पेस
  • कॉन्फ़्रेंस
  • मीटिंग में हिस्सा लेने वाले लोगों के सेशन
  • रिकॉर्डिंग
  • ट्रांसक्रिप्ट की सुविधा
Google Meet के उपयोगकर्ता
  • कॉन्फ़्रेंस
  • मीटिंग में हिस्सा लेने वाले लोगों के सेशन
  • रिकॉर्डिंग
  • ट्रांसक्रिप्ट की सुविधा

ज़्यादा जानने के लिए, यहां दी गई गाइड देखें:

Google Workspace इवेंट का स्ट्रक्चर

Google Workspace इवेंट, CloudEvents स्पेसिफ़िकेशन का पालन करते हैं. यह इवेंट डेटा के बारे में बताने का इंडस्ट्री स्टैंडर्ड तरीका है. Google Workspace इवेंट में ये शामिल होते हैं:

  • CloudEvent के एट्रिब्यूट.
  • डेटा Google Workspace के उस संसाधन के बारे में जानकारी जिसमें इवेंट की वजह से बदलाव हुआ है

इस सेक्शन में, Google Workspace इवेंट के लिए एट्रिब्यूट और डेटा के स्ट्रक्चर के बारे में बताया गया है.

CloudEvent एट्रिब्यूट

Google Workspace इवेंट में, CloudEvents की ये ज़रूरी विशेषताएं शामिल होती हैं:

एट्रिब्यूट ब्यौरा उदाहरण

datacontenttype

इवेंट में किस तरह का डेटा पास किया गया है.

application/json

id

CloudEvent के लिए आइडेंटिफ़ायर.

spaces/AAAABBBBBBB/spaceEvents/ABCDEFGHIJKLMNO

source

इवेंट का सोर्स. Google Workspace इवेंट के लिए, यह सदस्यता का पूरा संसाधन नाम है. //workspaceevents.googleapis.com/subscriptions/chat-spaces-abcdefg

specversion

इस इवेंट के लिए इस्तेमाल किया गया CloudEvents स्पेसिफ़िकेशन वर्शन.

1.0

subject

वह Google Workspace संसाधन जहां इवेंट हुआ.

//chat.googleapis.com/spaces/AAAABBBBBBB

time

RFC 3339 फ़ॉर्मैट में, इवेंट होने का टाइमस्टैंप.

2023-09-07T21:37:36.260127Z

type

Google Workspace इवेंट का टाइप.

google.workspace.chat.message.v1.created

इवेंट का डेटा

इवेंट डेटा एक पेलोड होता है. यह आपकी सदस्यता के टारगेट रिसोर्स में हुए बदलाव को दिखाता है. इसमें टारगेट रिसोर्स के चाइल्ड रिसोर्स भी शामिल होते हैं. अपनी सदस्यता में, यह तय किया जा सकता है कि आपको पेलोड में बदले गए संसाधन का डेटा शामिल करना है या सिर्फ़ बदले गए संसाधन का नाम.

उदाहरण के लिए, अगर आपने किसी Chat स्पेस की सदस्यता ली है, तो आपको उस स्पेस में नए मैसेज के बारे में सूचनाएं मिल सकती हैं. नए मैसेज से जुड़े इवेंट के लिए, इवेंट डेटा में Chat spaces.message रिसॉर्स वाला पेलोड होता है.

सदस्यता बनाते समय, यह तय किया जा सकता है कि आपके ऐप्लिकेशन को मिलने वाले इवेंट में, संसाधन का कितना डेटा शामिल किया जाए:

  • संसाधन का डेटा शामिल करें: इसमें बदले गए संसाधन के कुछ या सभी फ़ील्ड शामिल होते हैं. अगर आपने संसाधन का डेटा शामिल करने का विकल्प चुना है, तो आपकी सदस्यता की अवधि चार घंटे तक सीमित होती है. हालांकि, अगर आपने डोमेन-वाइड डेलिगेशन का इस्तेमाल किया है, तो यह अवधि 24 घंटे तक हो सकती है.
  • संसाधन का डेटा शामिल न करें: इसमें सिर्फ़ बदले गए संसाधन का नाम होता है. सदस्यता की अवधि सात दिनों तक होती है. इवेंट के बारे में जानकारी पाने के लिए, संसाधन के नाम का इस्तेमाल करके संसाधन के बारे में क्वेरी की जा सकती है.

इवेंट डेटा के लिए उपलब्ध इन विकल्पों को आपकी सदस्यता के payloadOptions फ़ील्ड में दिखाया जाता है.

Google Cloud Pub/Sub मैसेज के तौर पर इवेंट

Google Workspace Events API की सदस्यताएं, Google Cloud Pub/Sub विषयों का इस्तेमाल सूचना एंडपॉइंट के तौर पर करती हैं. यह एंडपॉइंट, Google Workspace इवेंट पाता है. इवेंट को Google Cloud Pub/Sub मैसेज के तौर पर कोड किया जाता है. आपका ऐप्लिकेशन, Google Cloud Pub/Sub मैसेज को प्रोसेस करके, इवेंट पर कार्रवाई कर सकता है या उसका जवाब दे सकता है.

इस उदाहरण में, Google Cloud Pub/Sub का एक ऐसा मैसेज दिखाया गया है जिसमें Chat स्पेस में अपडेट किए गए मैसेज के बारे में इवेंट की जानकारी दी गई है:

 {
    "message":
    {
        "attributes":
        {
            "ce-datacontenttype": "application/json",
            "ce-id": "spaces/SPACE_ID/spaceEvents/SPACE_EVENT_ID",
            "ce-source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
            "ce-specversion": "1.0",
            "ce-subject": "//chat.googleapis.com/spaces/SPACE_ID",
            "ce-time": "2023-09-07T21:37:53.274191Z",
            "ce-type": "google.workspace.chat.message.v1.updated"
        },
        "data": "EVENT_DATA",
        "messageId": "PUBSUB_MESSAGE_ID",
        "orderingKey": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
        "publishTime": "2023-09-07T21:37:53.713Z"
    }
}

इन फ़ील्ड पर ध्यान दें:

  • attributes: CloudEvent के लिए एट्रिब्यूट. इनमें इवेंट टाइप शामिल है. इस मामले में, इवेंट स्पेस में अपडेट किए गए मैसेज के बारे में है.
  • data: अपडेट किए गए spaces.message रिसॉर्स की जानकारी वाला इवेंट डेटा, जिसे Base64-encoded स्ट्रिंग के तौर पर फ़ॉर्मैट किया गया है.
  • messageId: यह Google Cloud Pub/Sub मैसेज का आइडेंटिफ़ायर होता है.

Google Cloud Pub/Sub मैसेज में CloudEvents के बारे में ज़्यादा जानने के लिए, Google Cloud Pub/Sub Protocol Binding for CloudEvents देखें.