Google Chat के इवेंट की सदस्यता लेना

इस पेज पर, Google Chat के उन इवेंट के बारे में बताया गया है जिनके लिए Google Chat ऐप्लिकेशन, Google Workspace Events API का इस्तेमाल करके सदस्यता ले सकता है. आपको किस तरह के इवेंट चाहिए, यह तय करने के बाद, सदस्यता लें, ताकि आपको Google Chat से इवेंट मिलने शुरू हो जाएं.

इवेंट की सदस्यता लेने के साथ-साथ, Chat API को कॉल करके भी इवेंट के बारे में क्वेरी की जा सकती है. Chat API को कॉल करने से, आपको समय-समय पर इवेंट वापस पाने में मदद मिलती है. इसके अलावा, अगर किसी गड़बड़ी की वजह से आपको सदस्यता से जुड़े इवेंट नहीं मिल पाए हैं, तो आपको उन इवेंट को वापस पाने में भी मदद मिलती है. Chat इवेंट पाने और उनका जवाब देने के तरीकों के बारे में जानने के लिए, Chat के दस्तावेज़ में Google Chat के इवेंट इस्तेमाल करना लेख पढ़ें.

चैट के लिए उपलब्ध इवेंट

Google Workspace की सदस्यताओं के ज़रिए, Chat में होने वाले इन बदलावों के बारे में सूचनाएं पाई जा सकती हैं:

  • स्पेस में मौजूद मैसेज में हुए बदलावों के बारे में सूचनाएं. जैसे, नए मैसेज, अपडेट किए गए मैसेज या मिटाए गए मैसेज.
  • किसी मैसेज पर नई प्रतिक्रियाएं दी गई हों या हटाई गई हों.
  • स्पेस में सदस्यों को जोड़ा, हटाया या अपडेट किया गया हो.
  • आपने जिस स्पेस की सदस्यता ली है उसमें किए गए बदलावों के बारे में सूचनाएं. जैसे, स्पेस के नाम या ब्यौरे में बदलाव.

ऐसे संसाधन जिनके इवेंट को मॉनिटर किया जा सकता है

इवेंट पाने के लिए, आपको मॉनिटर करने के लिए Chat रिसॉर्स तय करना होता है. इसे सदस्यता का टारगेट रिसॉर्स कहा जाता है.

Google Workspace Events API, Chat के लिए इन टारगेट रिसॉर्स के साथ काम करता है:

टारगेट संसाधन फ़ॉर्मैट सीमाएं
स्पेस

//chat.googleapis.com/spaces/SPACE

यहां SPACE, Chat API space संसाधन के संसाधन के नाम में मौजूद आईडी है. स्पेस का आईडी, स्पेस के यूआरएल से या spaces.list() तरीके का इस्तेमाल करके पाया जा सकता है.

सदस्यता की पुष्टि करने वाला Chat उपयोगकर्ता या Chat ऐप्लिकेशन, Google Workspace या Google खाते से स्पेस का सदस्य होना चाहिए. इनके साथ काम करता है:
किसी उपयोगकर्ता के सभी स्पेस

//chat.googleapis.com/spaces/-

सदस्यता को सिर्फ़ उन स्पेस के इवेंट मिलते हैं जिनमें उपयोगकर्ता, Google Workspace या Google खाते से सदस्य है. यह सिर्फ़ उपयोगकर्ता की पुष्टि करने की सुविधा के साथ काम करता है.
उपयोगकर्ता

//cloudidentity.googleapis.com/users/USER

यहां USER, Chat API user संसाधन के संसाधन के नाम में मौजूद आईडी है. ज़्यादा जानकारी के लिए, Google Chat इस्तेमाल करने वालों की पहचान करना और उन्हें तय करना लेख पढ़ें.

सदस्यता को सिर्फ़ उस उपयोगकर्ता के बारे में इवेंट मिलते हैं जिसने सदस्यता के लिए अनुमति दी है. कोई उपयोगकर्ता, अन्य उपयोगकर्ताओं की ओर से सदस्यता को अनुमति नहीं दे सकता. यह सिर्फ़ उपयोगकर्ता की पुष्टि करने की सुविधा के साथ काम करता है.

सदस्यताएं बनाने के लिए इवेंट टाइप

सदस्यता बनाते समय, आपको eventTypes[] फ़ील्ड का इस्तेमाल करके यह बताना होता है कि आपको किस तरह के इवेंट की सूचनाएं चाहिए. इवेंट टाइप को CloudEvents स्पेसिफ़िकेशन के मुताबिक फ़ॉर्मैट किया जाता है. जैसे, google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.

उदाहरण के लिए, Chat स्पेस में शामिल होने वाले उपयोगकर्ताओं के बारे में इवेंट पाने के लिए, स्पेस को टारगेट रिसॉर्स के तौर पर और इवेंट टाइप को google.workspace.chat.membership.v1.created के तौर पर सेट करें. किसी स्पेस में शामिल होने वाले उपयोगकर्ता के बारे में इवेंट पाने के लिए, उपयोगकर्ता को टारगेट रिसॉर्स के तौर पर और इवेंट टाइप को google.workspace.chat.membership.v1.created के तौर पर सेट करें. इवेंट के काम करने के तरीके के बारे में ज़्यादा जानने के लिए, Google Workspace इवेंट का स्ट्रक्चर लेख पढ़ें.

इस टेबल में बताया गया है कि स्पेस की सदस्यताएं और उपयोगकर्ताओं की सदस्यताओं के लिए, किस तरह के इवेंट इस्तेमाल किए जा सकते हैं. इवेंट को ट्रिगर करने वाली स्थितियों के बारे में अपवादों के बारे में जानने के लिए, सीमाएं लेख पढ़ें.

इवेंट का टाइप फ़ॉर्मैट संसाधन का डेटा
स्पेस की सदस्यताएं  
मैसेज पोस्ट किया गया है.

google.workspace.chat.message.v1.created

space.message

मैसेज अपडेट किया गया है.

google.workspace.chat.message.v1.updated

space.message

मैसेज मिटा दिया गया है.

google.workspace.chat.message.v1.deleted

space.message

प्रतिक्रिया दी गई हो.

google.workspace.chat.reaction.v1.created

space.message.reaction

प्रतिक्रिया मिटाई गई.

google.workspace.chat.reaction.v1.deleted

space.message.reaction

स्पेस में किसी सदस्य को जोड़ा जाता है.

google.workspace.chat.membership.v1.created

space.membership

स्पेस में किसी सदस्य की जानकारी अपडेट की गई है.

google.workspace.chat.membership.v1.updated

space.membership

किसी सदस्य को स्पेस से हटा दिया जाता है.

google.workspace.chat.membership.v1.deleted

space.membership

स्पेस अपडेट हो जाएगा.

google.workspace.chat.space.v1.updated

space

स्पेस मिटा दिया जाता है.

google.workspace.chat.space.v1.deleted

space

उपयोगकर्ताओं के लिए सदस्यताएं  
उपयोगकर्ता, स्पेस का सदस्य बन जाता है.

सभी नए सदस्यों से इवेंट ट्रिगर नहीं होते. ज़्यादा जानकारी के लिए, सीमाएं देखें

google.workspace.chat.membership.v1.created

space.membership

किसी स्पेस में उपयोगकर्ता की सदस्यता अपडेट की जाती है.

google.workspace.chat.membership.v1.updated

space.membership

उपयोगकर्ता को स्पेस के डायरेक्ट सदस्य के तौर पर हटा दिया जाता है.

google.workspace.chat.membership.v1.deleted

space.membership

बैच इवेंट के टाइप (सिर्फ़ आउटपुट)

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

उदाहरण के लिए, अगर कोई उपयोगकर्ता एक साथ 20 लोगों को किसी स्पेस में जोड़ता है, तो आपके Chat ऐप्लिकेशन को बैच इवेंट (google.workspace.chat.membership.v1.batchCreated) मिल सकता है. इवेंट पेलोड में, उन सभी नए Membership संसाधनों की सूची होती है जो उपयोगकर्ता के स्पेस में सदस्यों को जोड़ने पर बनाए गए थे.

आपने जिस भी इवेंट टाइप की सदस्यता ली है उसके लिए, आपको बैच इवेंट मिलता है. इसलिए, सदस्यता बनाते समय आपको बैच इवेंट तय करने की ज़रूरत नहीं होती. उदाहरण के लिए, अगर आपने नई प्रतिक्रियाओं (google.workspace.chat.reaction.v1.created) के लिए सदस्यता ली है, तो आपका Chat ऐप्लिकेशन, बैच रिएक्शन इवेंट (google.workspace.chat.reaction.v1.batchCreated) पाने के लिए अपने-आप कॉन्फ़िगर हो जाता है.

यहां दी गई टेबल में, सदस्यता के लिए संभावित बैच इवेंट दिखाए गए हैं:

बैच इवेंट का टाइप फ़ॉर्मैट
एक से ज़्यादा मैसेज पोस्ट किए गए हैं.

google.workspace.chat.message.v1.batchCreated

एक से ज़्यादा मैसेज अपडेट किए गए हैं.

google.workspace.chat.message.v1.batchUpdated

एक से ज़्यादा मैसेज मिटा दिए गए हैं.

google.workspace.chat.message.v1.batchDeleted

एक से ज़्यादा प्रतिक्रियाएं बनाई गई हैं.

google.workspace.chat.reaction.v1.batchCreated

एक से ज़्यादा प्रतिक्रियाएं मिटाई गई हैं.

google.workspace.chat.reaction.v1.batchDeleted

सदस्यता वाले स्पेस में एक से ज़्यादा सदस्यों को जोड़ा गया हो या सदस्यता लेने वाले व्यक्ति को एक से ज़्यादा स्पेस में जोड़ा गया हो.

google.workspace.chat.membership.v1.batchCreated

सदस्यता वाले स्पेस या सदस्यता वाले उपयोगकर्ता के लिए, एक से ज़्यादा सदस्यताएं अपडेट की गई हैं.

google.workspace.chat.membership.v1.batchUpdated

सदस्यता वाले स्पेस से कई सदस्यों को हटा दिया गया है या सदस्यता लेने वाले उपयोगकर्ता को कई स्पेस से हटा दिया गया है.

google.workspace.chat.membership.v1.batchDeleted

स्पेस में कई अपडेट मौजूद हैं.

google.workspace.chat.space.v1.batchUpdated

इवेंट का डेटा

इस सेक्शन में, Chat में होने वाले इवेंट के लिए इवेंट डेटा और सैंपल पेलोड के बारे में बताया गया है.

जब आपकी Google Workspace सदस्यता को Chat से कोई इवेंट मिलता है, तो data फ़ील्ड में इवेंट का पेलोड होता है. इस पेलोड में, Google Workspace के उस संसाधन के बारे में जानकारी होती है जिसमें बदलाव हुआ है. उदाहरण के लिए, अगर आपने किसी स्पेस में सदस्यता से जुड़े इवेंट के लिए सदस्यता ली है, तो इन इवेंट के पेलोड में spaces.membership रिसॉर्स में हुए बदलाव के बारे में जानकारी होती है.

इवेंट पेलोड में मौजूद रिसॉर्स डेटा

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

इस टेबल में, चैट स्पेस spaces/AAAABBBBBB की सदस्यता लेने के लिए, JSON पेलोड के उदाहरण दिए गए हैं. सदस्यता को मिलने वाले हर इवेंट के लिए, पेलोड इवेंट के data फ़ील्ड में दिखता है:

उदाहरण इवेंट का टाइप JSON पेलोड

किसी उपयोगकर्ता ने स्पेस में "सभी को नमस्ते" मैसेज पोस्ट किया.

google.workspace.chat.message.v1.created

इसमें संसाधन का डेटा शामिल होता है:

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID",
        "sender":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "2023-09-07T21:37:36.260127Z",
        "text": "Hello world",
        "thread":
        {
            "name": "spaces/SPACE_ID/threads/THREAD_ID"
        },
        "space":
        {
            "name": "spaces/SPACE_ID"
        },
        "argumentText": "Hello world"
    }
}
      

इसमें संसाधन का डेटा शामिल नहीं होता:

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID"
    }
}
      
कोई उपयोगकर्ता स्पेस मैनेजर बन जाता है.

google.workspace.chat.membership.v1.updated

इसमें संसाधन का डेटा शामिल होता है:

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID",
        "state": "JOINED",
        "member":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "1970-01-01T00:00:00Z",
        "role": "ROLE_MANAGER"
    }
}
      

इसमें संसाधन का डेटा शामिल नहीं होता:

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID"
    }
}
      
कोई उपयोगकर्ता, स्पेस के ब्यौरे को "Cymbal Labs की सेल्स टीम." के तौर पर अपडेट करता है. google.workspace.chat.space.v1.updated

इसमें संसाधन का डेटा शामिल होता है:

{
    "space":
    {
        "name": "spaces/SPACE_ID",
        "displayName": "Cymbal Sales",
        "spaceThreadingState": "THREADED_MESSAGES",
        "spaceType": "SPACE",
        "spaceDetails":
        {
            "description": "Sales team for Cymbal Labs."
        },
        "spaceHistoryState": "HISTORY_ON"
    }
}
      

इसमें संसाधन का डेटा शामिल नहीं होता:

{
    "space":
    {
        "name": "spaces/SPACE_ID"
    }
}
      
Chat का इस्तेमाल करने वाले दो लोगों को एक ही समय पर स्पेस में जोड़ा गया था. google.workspace.chat.membership.v1.batchCreated

इसमें संसाधन का डेटा शामिल होता है:

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        }
    ]
}
      

इसमें संसाधन का डेटा शामिल नहीं होता:

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        }
    ]
}
      
किसी उपयोगकर्ता ने 😊 इमोजी का इस्तेमाल करके, मैसेज पर प्रतिक्रिया दी है. google.workspace.chat.reaction.v1.created

इसमें संसाधन का डेटा शामिल होता है:

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        "user":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "emoji":
        {
            "unicode": "😊"
        }
    }
}
      

इसमें संसाधन का डेटा शामिल नहीं होता:

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
    }
}
      
उपयोगकर्ता, मैसेज पर 😊 और 😸 इमोजी से प्रतिक्रिया देते हैं. google.workspace.chat.reaction.v1.batchCreated

इसमें संसाधन का डेटा शामिल होता है:

{
    "reactions": [
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😊"
            }
          }
        },
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😸"
            }
          }
        }
    ]
}
      

इसमें संसाधन का डेटा शामिल नहीं होता:

{
    "reactions": [
      {
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
        },
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        }
      }
    ]
}
      

सीमाएं

  • उपयोगकर्ताओं की सदस्यताओं के लिए, डायरेक्ट मैसेज या बिना नाम वाली ग्रुप चैट (google.workspace.chat.membership.v1.created) में नए सदस्यों के बारे में इवेंट, सिर्फ़ पहला मैसेज पोस्ट होने के बाद ट्रिगर होते हैं.
  • सदस्यता से जुड़े इवेंट पाने के लिए, उपयोगकर्ता या Chat ऐप्लिकेशन को स्पेस का सदस्य होना चाहिए. अगर उन्हें Google ग्रुप के ज़रिए स्पेस में जोड़ा गया है, अपडेट किया गया है या हटाया गया है, तो सदस्यता को इन इवेंट की सूचना नहीं मिलती. Google ग्रुप की सदस्यता के काम करने का तरीका जानने के लिए, किसी स्पेस में Google ग्रुप जोड़ना लेख पढ़ें.