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 किसी चैट ऐप्लिकेशन में इवेंट कैसे डिलीवर करता है.

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

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

अहम शब्दावली

Google Workspace Event 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 के कौनसे इवेंट, 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
Google Chat स्पेस

किसी खास स्पेस की सदस्यता लेने के लिए:

//chat.googleapis.com/spaces/SPACE_ID

उन सभी स्पेस की सदस्यता लेने के लिए जहां उपयोगकर्ता सदस्य है:

//chat.googleapis.com/spaces/-
  • मैसेज
  • पैसे चुकाकर ली जाने वाली सदस्यताएं
  • प्रतिक्रियाएं
  • सामाजिक स्थिति

ज़्यादा जानकारी के लिए, Google Chat के इवेंट की सदस्यता लेना देखें.		 Google Chat का इस्तेमाल करने वाले व्यक्ति के पास, Google Workspace या Google खाते से स्पेस का सदस्य होना ज़रूरी है.
Google Chat का इस्तेमाल करने वाले लोग //cloudidentity.googleapis.com/users/USER_ID
  • पैसे चुकाकर ली जाने वाली सदस्यताएं

ज़्यादा जानकारी के लिए, Google Chat के इवेंट की सदस्यता लेना देखें.

सदस्यता में सिर्फ़ उस उपयोगकर्ता के इवेंट मिलते हैं जिसने सदस्यता की अनुमति दी है. एक उपयोगकर्ता अन्य उपयोगकर्ताओं की ओर से सदस्यता को अनुमति नहीं दे सकता.
Google Meet
Google Meet की मीटिंग के लिए स्पेस //meet.googleapis.com/spaces/SPACE_ID
  • कॉन्फ़्रेंस
  • हिस्सा लेने वाले लोगों के सेशन
  • रिकॉर्डिंग
  • ट्रांसक्रिप्ट की सुविधा

ज़्यादा जानकारी के लिए, Google Meet इवेंट की सदस्यता लेना देखें.
Google Meet के उपयोगकर्ता //cloudidentity.googleapis.com/users/USER_ID
  • कॉन्फ़्रेंस
  • हिस्सा लेने वाले लोगों के सेशन
  • रिकॉर्डिंग
  • ट्रांसक्रिप्ट की सुविधा

ज़्यादा जानकारी के लिए, Google Meet इवेंट की सदस्यता लेना देखें.

सदस्यता को उन मीटिंग स्पेस से जुड़े इवेंट मिलते हैं जहां उपयोगकर्ता इनमें से कोई एक होता है:

  • मीटिंग की जगह का मालिक.
  • मीटिंग की जगह से जुड़े Google Calendar इवेंट का आयोजक.

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

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

इस इवेंट के लिए, इस्तेमाल किया गया CloudEvent की खास बातों का वर्शन.

1.0

subject

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

//chat.googleapis.com/spaces/AAAABBBBBBB

time

आरएफ़सी 3339 फ़ॉर्मैट में, इवेंट के समय का टाइमस्टैंप.

2023-09-07T21:37:36.260127Z

type

Google Workspace इवेंट किस तरह का है.

google.workspace.chat.message.v1.created

इवेंट डेटा

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

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

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

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

इवेंट डेटा के ये विकल्प, आपकी सदस्यता के payloadOptions फ़ील्ड में दिखाए गए हैं.

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

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

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

 {
    "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 कोड में बदली गई स्ट्रिंग के फ़ॉर्मैट में होती है.
  • messageId: Google Cloud Pub/Sub मैसेज के लिए आइडेंटिफ़ायर.

Google Cloud Pub/Sub मैसेज में, CloudEvents कैसे तय किए जाते हैं, इस बारे में ज़्यादा जानने के लिए, CloudEvent के लिए Google Cloud Pub/Sub प्रोटोकॉल बाइंडिंग देखें.