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

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

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

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

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

इस उदाहरण में बताया गया है कि 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 इवेंट की सदस्यता लेना
• Google Meet इवेंट की सदस्यता लेना

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

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

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

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

CloudEvent एट्रिब्यूट

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

इवेंट का डेटा

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

उदाहरण के लिए, अगर आपने किसी Chat स्पेस की सदस्यता ली है, तो आपको उस स्पेस में नए मैसेज से जुड़े इवेंट मिल सकते हैं. नए मैसेज से जुड़े इवेंट के लिए, इवेंट डेटा में एक पेलोड होता है. इसमें, बनाए गए Chatspaces.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 में एन्कोड की गई स्ट्रिंग के तौर पर फ़ॉर्मैट किया गया है.
• messageId: Google Cloud Pub/Sub मैसेज का आइडेंटिफ़ायर.

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

मिलते-जुलते विषय

• Google Chat इवेंट की सदस्यता लेना
• Google Meet इवेंट की सदस्यता लेना
• Google Workspace की सदस्यताओं के लिए लाइफ़साइकल इवेंट
• Google Workspace Events API के स्कोप चुनना
• Google Workspace की सदस्यता बनाना