इस पेज पर, Google Chat के उन इवेंट के बारे में बताया गया है जिनकी सदस्यता Google Chat ऐप्लिकेशन को Google Workspace इवेंट एपीआई का इस्तेमाल करके मिल सकती है. आपको किस तरह के इवेंट की ज़रूरत है, यह तय करने के बाद, Google Chat से इवेंट पाने के लिए सदस्यता लें.
इवेंट की सदस्यता लेने के अलावा, Chat API को कॉल करके भी इवेंट के बारे में क्वेरी की जा सकती हैं. Chat API को कॉल करने पर, आपको समय-समय पर इवेंट की जानकारी पाने में मदद मिलती है. इसके अलावा, ऐसे इवेंट के बारे में भी जानकारी मिलती है जो हो सकता है कि किसी सेवा के बंद होने की वजह से सदस्यता में शामिल न हो पाए हों. Chat इवेंट पाने और उनका जवाब देने के तरीकों के बारे में जानने के लिए, Chat दस्तावेज़ में Google Chat के इवेंट के साथ काम करना देखें.
इस्तेमाल किए जा सकने वाले Chat टारगेट संसाधन
Google Workspace Events API में ये सदस्यताएं काम करती हैं:
- स्पेस,
space
संसाधनों के तौर पर दिखाए जाते हैं - उपयोगकर्ता, Cloud Identity API के
user
संसाधनों के तौर पर दिखाए गए हैं
साथ काम करने वाले Chat इवेंट
Google Workspace की सदस्यता से, आपको Chat में इस तरह के बदलावों के बारे में इवेंट की जानकारी मिलती है:
- स्पेस में मौजूद नए, अपडेट किए गए या मिटाए गए मैसेज.
- किसी मैसेज पर की गई नई या हटाई गई प्रतिक्रियाएं.
- स्पेस के नए, अपडेट किए गए या हटाए गए सदस्य.
- आपने जिस स्पेस की सदस्यता ली है उसमें होने वाले बदलाव. जैसे, स्पेस का अपडेट किया गया नाम या ब्यौरा.
सदस्यताएं बनाने के लिए इवेंट के टाइप
सदस्यता बनाते समय, eventTypes[]
फ़ील्ड का इस्तेमाल यह तय करने के लिए किया जाता है कि आपको किस तरह के इवेंट चाहिए. इवेंट के टाइप, CloudEVENT स्पेसिफ़िकेशन के मुताबिक फ़ॉर्मैट किए जाते हैं, जैसे कि
google.workspace.APPLICATION.RESOURCE.VERSION.ACTION
.
उदाहरण के लिए, चैट स्पेस में शामिल होने वाले उपयोगकर्ताओं के इवेंट पाने के लिए, आपको स्पेस को टारगेट संसाधन के तौर पर तय करना होता है और इवेंट टाइप को google.workspace.chat.membership.v1.created
के तौर पर तय करना होता है. किसी उपयोगकर्ता के किसी स्पेस में शामिल होने के इवेंट की जानकारी पाने के लिए, आपको उपयोगकर्ता को टारगेट संसाधन के तौर पर और इवेंट के टाइप को google.workspace.chat.membership.v1.created
के तौर पर बताना होता है. इवेंट के काम करने के तरीके के बारे में ज़्यादा जानने के लिए, Google Workspace इवेंट का स्ट्रक्चर देखें.
इस टेबल में बताया गया है कि स्पेस की सदस्यताओं और उपयोगकर्ताओं की सदस्यताओं के लिए, किस तरह के इवेंट काम करते हैं. इवेंट को ट्रिगर करने वाले अपवादों के बारे में जानने के लिए, सीमाएं देखें.
इवेंट का टाइप | फ़ॉर्मैट | संसाधन का डेटा | ||
---|---|---|---|---|
स्पेस की सदस्यताएं | ||||
एक मैसेज पोस्ट किया गया. |
|
|
||
एक मैसेज अपडेट किया गया. |
|
|
||
मैसेज मिटाया गया. |
|
|
||
प्रतिक्रिया तैयार की जाती है. |
|
|
||
प्रतिक्रिया को मिटाया गया. |
|
|
||
स्पेस में एक सदस्य जोड़ा गया. |
|
|
||
स्पेस में एक सदस्य की जानकारी अपडेट की गई. |
|
|
||
एक सदस्य को स्पेस से हटाया गया है. |
|
|
||
स्पेस को अपडेट कर दिया गया है. |
|
|
||
स्पेस को मिटा दिया गया है. |
|
|
||
उपयोगकर्ताओं के लिए सदस्यताएं | ||||
उपयोगकर्ता किसी स्पेस का सदस्य बन जाता है.
सभी नए सदस्य इवेंट ट्रिगर नहीं करते. ज़्यादा जानकारी के लिए, सीमाएं देखें |
|
|
||
स्पेस के उपयोगकर्ता की सदस्यता अपडेट हो जाती है. |
|
|
||
उपयोगकर्ता को स्पेस के प्रत्यक्ष सदस्य की भूमिका से हटा दिया जाता है. |
|
|
बैच इवेंट टाइप (सिर्फ़ आउटपुट के लिए)
आपने जिन इवेंट टाइप की सदस्यता ली है उन्हें आपको मिलने के अलावा, आपके Chat ऐप्लिकेशन को भी बैच इवेंट मिल सकते हैं. बैच इवेंट, ऐसा इवेंट होता है जो कम समय में होने वाले एक तरह के कई इवेंट को दिखाता है. बैच इवेंट के पेलोड में, बदले गए सभी संसाधनों की सूची होती है.
उदाहरण के लिए, अगर कोई उपयोगकर्ता स्पेस में एक ही समय में 20 उपयोगकर्ताओं को जोड़ता है, तो आपके Chat ऐप्लिकेशन को एक बैच इवेंट (google.workspace.chat.membership.v1.batchCreated
) मिल सकता है. इवेंट पेलोड में उन सभी नए Membership
संसाधनों की सूची होती है जो उपयोगकर्ता को स्पेस में जोड़ते समय बनाए गए थे.
आपने जिस तरह के इवेंट की सदस्यता ली है उसके लिए बैच इवेंट मिलता है. इसलिए, सदस्यता बनाते समय आपको बैच इवेंट की जानकारी देने की ज़रूरत नहीं है. उदाहरण के लिए, अगर नई प्रतिक्रियाओं (google.workspace.chat.reaction.v1.created
) की सदस्यता ली जाती है, तो आपका Chat ऐप्लिकेशन अपने-आप कॉन्फ़िगर हो जाता है. इस तरह, बैच में प्रतिक्रिया वाले इवेंट (google.workspace.chat.reaction.v1.batchCreated
) पाने की सुविधा चालू हो जाती है.
इस टेबल में, किसी सदस्यता के लिए संभावित बैच इवेंट दिखाए गए हैं:
बैच इवेंट टाइप | फ़ॉर्मैट |
---|---|
कई मैसेज पोस्ट किए गए हैं. |
|
एक से ज़्यादा मैसेज अपडेट कर दिए गए हैं. |
|
एक से ज़्यादा मैसेज मिटा दिए गए हैं. |
|
कई प्रतिक्रियाएं बनाई जाती हैं. |
|
एक से ज़्यादा प्रतिक्रियाएं मिटा दी जाती हैं. |
|
आपने जिस स्पेस की सदस्यता ली है उसमें कई सदस्य जोड़ दिए गए हैं या सदस्य को कई स्पेस में जोड़ दिया गया है. |
|
सदस्यता वाले स्पेस में या जिस उपयोगकर्ता ने सदस्यता ली हुई है उसके लिए एक से ज़्यादा सदस्यताएं अपडेट होती हैं. |
|
आपने जिस स्पेस की सदस्यता ली है उससे कई सदस्य हटा दिए गए हैं या सदस्य को कई स्पेस से हटा दिया गया है. |
|
स्पेस में कई अपडेट हैं. |
|
इवेंट डेटा
इस सेक्शन में, इवेंट डेटा और Chat में मौजूद इवेंट के पेलोड के उदाहरण के बारे में बताया गया है.
जब आपकी Google Workspace सदस्यता को Chat से कोई इवेंट मिलता है, तो data
फ़ील्ड में इवेंट के लिए पेलोड मौजूद होता है. इस पेलोड में, Google Workspace के उस संसाधन की जानकारी है जिसमें बदलाव हुआ है. उदाहरण के लिए, अगर आपने किसी स्पेस में सदस्यता इवेंट की सदस्यता ली है, तो इन इवेंट के पेलोड में उस spaces.membership
संसाधन के बारे में जानकारी होती है जिसमें बदलाव हुआ है.
इवेंट पेलोड में संसाधन डेटा
सदस्यता बनाते समय, यह तय किया जा सकता है कि पेलोड में संसाधन के बारे में जानकारी शामिल करनी है या सिर्फ़ संसाधन का नाम. उदाहरण के लिए, अगर आपको चैट स्पेस में सदस्यों से जुड़े इवेंट पाने हैं, तो आपके पास यह तय करने का विकल्प होता है कि आपको इवेंट पेलोड में, सदस्यता संसाधन के कौनसे फ़ील्ड चाहिए.
नीचे दी गई टेबल में, चैट स्पेस spaces/AAAABBBBBB
की सदस्यता के लिए JSON पेलोड के उदाहरण दिए गए हैं. सदस्यता को मिलने वाले हर इवेंट के लिए, इवेंट के data
फ़ील्ड में पेलोड दिखता है:
उदाहरण | इवेंट का टाइप | JSON पेलोड |
---|---|---|
कोई उपयोगकर्ता स्पेस में मैसेज पोस्ट कर रहा है, जिसमें लिखा है "नमस्ते दुनिया." |
|
इसमें संसाधन डेटा शामिल है
{ "message": { "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD", "sender": { "name": "users/1234567890987654321", "type": "HUMAN" }, "createTime": "2023-09-07T21:37:36.260127Z", "text": "Hello world", "thread": { "name": "spaces/AAAABBBBBB/threads/EEEEEEEEEEEE" }, "space": { "name": "spaces/AAAABBBBBB" }, "argumentText": "Hello world" } } संसाधन डेटा शामिल नहीं है
{ "message": { "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD" } } |
कोई उपयोगकर्ता, स्पेस मैनेजर बन जाता है. |
|
इसमें संसाधन डेटा शामिल है
{ "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321", "state": "JOINED", "member": { "name": "users/1234567890987654321", "type": "HUMAN" }, "createTime": "1970-01-01T00:00:00Z", "role": "ROLE_MANAGER" } } संसाधन डेटा शामिल नहीं है
{ "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321" } } |
कोई उपयोगकर्ता, "सिम्बल लैब के लिए सेल्स टीम" में स्पेस की जानकारी अपडेट करता है. | google.workspace.chat.space.v1.updated |
इसमें संसाधन डेटा शामिल है
{ "space": { "name": "spaces/AAAABBBBBB", "displayName": "Cymbal Sales", "spaceThreadingState": "THREADED_MESSAGES", "spaceType": "SPACE", "spaceDetails": { "description": "Sales team for Cymbal Labs." }, "spaceHistoryState": "HISTORY_ON" } } संसाधन डेटा शामिल नहीं है
{ "space": { "name": "spaces/AAAABBBBBB" } } |
स्पेस में एक ही समय पर, दो चैट उपयोगकर्ता जोड़े गए. | google.workspace.chat.membership.v1.batchCreated |
इसमें संसाधन डेटा शामिल है
{ "memberships": [ { "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321", "state": "JOINED", "member": { "name": "users/1234567890987654321", "type": "HUMAN" }, "createTime": "1970-01-01T00:00:00Z", "role": "ROLE_MEMBER" } }, { "membership": { "name": "spaces/AAAABBBBBB/members/987654321234567890", "state": "JOINED", "member": { "name": "users/987654321234567890", "type": "HUMAN" }, "createTime": "1970-01-01T00:00:00Z", "role": "ROLE_MEMBER" } } ] } संसाधन डेटा शामिल नहीं है
{ "memberships": [ { "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321" } }, { "membership": { "name": "spaces/AAAABBBBBB/members/98765432123456789019" } } ] } |
कोई उपयोगकर्ता, 😊 इमोजी वाले मैसेज पर प्रतिक्रिया देता है. | google.workspace.chat.reaction.v1.created |
इसमें संसाधन डेटा शामिल है
{ "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222", "user": { "name": "users/1234567890987654321", "type": "HUMAN" }, "emoji": { "unicode": "😊" } } } इसमें संसाधन का डेटा शामिल नहीं है
{ "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222" } } |
उपयोगकर्ता किसी मैसेज पर, 😊 इमोजी और HowTo इमोजी का इस्तेमाल करके, प्रतिक्रिया देते हैं. | google.workspace.chat.reaction.v1.batchCreated |
इसमें संसाधन डेटा शामिल है
{ "reactions": [ { "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222", "user": { "name": "users/1234567890987654321", "type": "HUMAN" }, "emoji": { "unicode": "😊" } } }, { "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444", "user": { "name": "users/98765431234564321", "type": "HUMAN" }, "emoji": { "unicode": "😸" } } } ] } इसमें संसाधन का डेटा शामिल नहीं है
{ "reactions": [ { "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222" }, "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444", } } ] } |
सीमाएं
-
उपयोगकर्ताओं की सदस्यताएं, डायरेक्ट मैसेज या बिना नाम वाली ग्रुप चैट (
google.workspace.chat.membership.v1.created
) में नए सदस्यों के बारे में इवेंट, पहला मैसेज पोस्ट होने के बाद ही ट्रिगर होते हैं. - स्पेस के इतिहास में बदलाव करने से, अपडेट किए गए स्पेस के इवेंट ट्रिगर नहीं होते (इवेंट टाइप:
google.workspace.chat.spaces.v1.updated
). - सदस्यता से जुड़े इवेंट की सूचनाएं पाने के लिए, यह ज़रूरी है कि उपयोगकर्ता स्पेस का सदस्य हो. अगर किसी उपयोगकर्ता को Google ग्रुप की मदद से, किसी स्पेस में सीधे तौर पर जोड़ा गया है, अपडेट किया गया है या हटाया गया है, तो सदस्यता को ऐसे इवेंट की जानकारी नहीं मिलेगी. यह समझने के लिए कि Google ग्रुप की सदस्यताएं कैसे काम करती हैं, स्पेस में Google ग्रुप जोड़ना लेख पढ़ें.
मिलते-जुलते विषय
- Google Workspace इवेंट का स्ट्रक्चर
- OAuth के दायरे चुनना
- Chat इवेंट पाने के लिए सदस्यता बनाएं