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

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

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

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

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

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

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

1. Chat ऐप्लिकेशन, Google Chat स्पेस की सदस्यता लेता है.
2. Chat स्पेस में बदलाव होता है. उदाहरण के लिए, स्पेस में कोई नया मैसेज पोस्ट किया जाता है.
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 स्पेस	मैसेज सदस्यताएं प्रतिक्रियाएं स्पेस
Chat के उपयोगकर्ता	सदस्यताएं पढ़ने की स्थिति ( डेवलपर प्रीव्यू)
Google Drive की फ़ाइलें या शेयर की गई ड्राइव में मौजूद फ़ाइलें	लोगों ने ऐक्सेस करने का अनुरोध किया अनुमतियां टिप्पणियां फ़ाइलें जवाब
Google Meet के मीटिंग स्पेस और उपयोगकर्ता	कॉन्फ़्रेंस हिस्सा लेने वाले व्यक्ति के सेशन रिकॉर्डिंग स्मार्ट नोट ट्रांसक्रिप्ट की सुविधा

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

• Chat के इवेंट की सदस्यता लेना
• Drive के इवेंट की सदस्यता लेना
• 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 के बारे में ज़्यादा जानने के लिए, CloudEvents के लिए Google Cloud की Pub/Sub सेवा का प्रोटोकॉल बाइंडिंग देखें.

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

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