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

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

Google Workspace इवेंट, Google Workspace संसाधनों में हुए बदलावों को दिखाते हैं. जैसे, संसाधन कब बनाए गए, अपडेट किए गए या मिटाए गए. Google Workspace Events API का इस्तेमाल करके, Google Workspace संसाधन की सदस्यता लें और उससे जुड़े इवेंट पाएं.

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

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

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

1. कोई Chat ऐप्लिकेशन, Google 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 के उस संसाधन में बदलाव जिसकी निगरानी की जा रही है. जैसे, 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 के साथ काम करने वाले इवेंट देखें.

इवेंट के टाइप

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

सूचना एंडपॉइंट

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

पे लोड के विकल्प

बदले गए संसाधनों के बारे में, आपको इवेंट का जो डेटा चाहिए.

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

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

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

• Chat के इवेंट के लिए सदस्यता लेना
• Drive के इवेंट के लिए सदस्यता लेना
• Meet के इवेंट की सदस्यता लेना

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

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

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

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

CloudEvent एट्रिब्यूट

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

इवेंट का डेटा

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

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

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

इवेंट डेटा के लिए उपलब्ध इन विकल्पों को आपकी सदस्यता के 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 के बारे में ज़्यादा जानने के लिए, Google Cloud Pub/Sub Protocol Binding for CloudEvents देखें.

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

• Google Workspace Events API के स्कोप चुनना
• Google Workspace की सदस्यता बनाना