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

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

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

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

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

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

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

  1. 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 के इवेंट एपीआई, 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
  • मैसेज
  • पैसे चुकाकर ली जाने वाली सदस्यताएं
  • प्रतिक्रियाएं
  • सामाजिक स्थिति

ज़्यादा जानकारी के लिए, 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 इवेंट में ये ज़रूरी CloudEvent एट्रिब्यूट शामिल होते हैं:

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

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 घंटे तक सीमित होती है.
  • संसाधन डेटा शामिल न करें: इसमें सिर्फ़ बदले गए संसाधन का नाम होता है. आपकी सदस्यता की अवधि सात दिनों तक की होती है. इवेंट के बारे में जानकारी पाने के लिए, संसाधन के नाम का इस्तेमाल करके संसाधन से क्वेरी की जा सकती है.

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

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

Google Workspace इवेंट एपीआई की सदस्यताएं, Google Cloud Pub/Sub विषयों का इस्तेमाल सूचना के एंडपॉइंट के तौर पर करती हैं. इस एंडपॉइंट पर Google Workspace इवेंट मिलते हैं. इवेंट को 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 मैसेज में CloudEvent कैसे शामिल किया जाता है, CloudEvent के लिए Google Cloud Pub/Sub प्रोटोकॉल बाइंडिंग देखें.