इस गाइड में, Google Chat API के SpaceEvent संसाधन पर
get()
तरीके का इस्तेमाल करके, Google Chat के किसी स्पेस से
इवेंट की जानकारी पाने का तरीका बताया गया है.
`SpaceEvent`
SpaceEvent संसाधन
, किसी स्पेस या उसके चाइल्ड संसाधनों में होने वाले बदलाव को दिखाता है. जैसे, मैसेज, रिएक्शन, और सदस्यताएं. इवेंट के काम करने वाले टाइप के बारे में जानने के लिए, eventType संसाधन के SpaceEventरेफ़रंस दस्तावेज़ का
फ़ील्ड देखें.
अनुरोध सबमिट करने से 28 दिन पहले तक के इवेंट के बारे में जानकारी पाने का अनुरोध किया जा सकता है. इवेंट में, बदले गए संसाधन का सबसे नया वर्शन शामिल होता है. उदाहरण के लिए, अगर आपने किसी नए मैसेज के बारे में इवेंट का अनुरोध किया है, लेकिन बाद में उस मैसेज को अपडेट कर दिया गया, तो सर्वर, इवेंट पेलोड में अपडेट किया गया Message संसाधन दिखाता है.
इस तरीके को कॉल करने के लिए, आपको उपयोगकर्ता की पुष्टि करनी होगी. किसी इवेंट की जानकारी पाने के लिए, पुष्टि किया गया उपयोगकर्ता उस स्पेस का सदस्य होना चाहिए जहां इवेंट हुआ है.
ज़रूरी शर्तें
Node.js
- Business या Enterprise Google Workspace खाता, जिसके पास Google Chat का ऐक्सेस हो.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth को सहमति दी जाती है.
- अपने Chat ऐप्लिकेशन के लिए, Google Chat API को नाम, आइकॉन, और जानकारी के साथ चालू और कॉन्फ़िगर करें.
- Node.js Cloud Client Library इंस्टॉल करें.
- Google Chat API के अनुरोध में पुष्टि करने के तरीके के आधार पर, ऐक्सेस क्रेडेंशियल बनाएं:
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी
क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
credentials.jsonनाम की JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए,
सेवा खाते के क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को
credentials.jsonनाम की JSON फ़ाइल के तौर पर सेव करें.
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी
क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
- पुष्टि करने के लिए, अनुमति पाने का कोई लिंक चुनें. यह लिंक इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर पुष्टि करनी है या Chat ऐप्लिकेशन के तौर पर.
Python
- Business या Enterprise Google Workspace खाता, जिसके पास Google Chat का ऐक्सेस हो.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth को सहमति दी जाती है.
- अपने Chat ऐप्लिकेशन के लिए, Google Chat API को नाम, आइकॉन, और जानकारी के साथ चालू और कॉन्फ़िगर करें.
- Python Cloud Client Library इंस्टॉल करें.
- Google Chat API के अनुरोध में पुष्टि करने के तरीके के आधार पर, ऐक्सेस क्रेडेंशियल बनाएं:
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी
क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
credentials.jsonनाम की JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए,
सेवा खाते के क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को
credentials.jsonनाम की JSON फ़ाइल के तौर पर सेव करें.
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी
क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
- पुष्टि करने के लिए, अनुमति पाने का कोई लिंक चुनें. यह लिंक इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर पुष्टि करनी है या Chat ऐप्लिकेशन के तौर पर.
स्पेस इवेंट के बारे में जानकारी पाना (उपयोगकर्ता की पुष्टि)
Google Chat में किसी स्पेस इवेंट के बारे में जानकारी पाने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:
- अपने अनुरोध में, अनुमति पाने का ऐसा लिंक तय करें जो इवेंट के टाइप के साथ काम करता हो. सबसे सही तरीका यह है कि अनुमति पाने का ऐसा लिंक चुनें जो सबसे ज़्यादा पाबंदियां लगाता हो, लेकिन फिर भी आपके ऐप्लिकेशन को काम करने की अनुमति देता हो.
-
GetSpaceEvent()तरीके को कॉल करें. इसके लिए, उस स्पेस इवेंट काnameपास करें जिसके बारे में जानकारी चाहिए.
यहां दिए गए उदाहरण में, स्पेस इवेंट की जानकारी पाई जा रही है:
Node.js
Node.js के इस कोड सैंपल में, Chat RPC API का इस्तेमाल किया गया है.
इस नमूने को चलाने के लिए, इनकी जगह ये डालें:
SCOPE_NAME: अनुमति पाने का ऐसा लिंक जो इवेंट के टाइप पर आधारित हो. उदाहरण के लिए, अगर आपको नई सदस्यता के बारे में कोई स्पेस इवेंट मिल रहा है, तोchat.memberships.readonlyलिंक का इस्तेमाल करें. इसेhttps://www.googleapis.com/auth/chat.memberships.readonlyके तौर पर फ़ॉर्मैट किया जाता है.ListSpaceEvents()तरीके से, इवेंट का टाइप पाया जा सकता है. इस तरीके का इस्तेमाल करने का तरीका जानने के लिए, किसी स्पेस से इवेंट की सूची बनाना लेख पढ़ें.SPACE_NAME: स्पेस केnameसे मिली आईडी. `ListSpaces()`ListSpaces()तरीके को कॉल करके या स्पेस के यूआरएल से आईडी पाई जा सकती है.SPACE_EVENT_NAME: स्पेस इवेंट केnameसे मिली आईडी.ListSpaceEvents()तरीके से, आईडी पाई जा सकती है. इस तरीके का इस्तेमाल करने का तरीका जानने के लिए, किसी स्पेस से इवेंट की सूची बनाना लेख पढ़ें.
Chat API,
SpaceEvent
का एक इंस्टेंस दिखाता है. इसमें इवेंट के बारे में जानकारी होती है.
स्पेस इवेंट के बारे में जानकारी पाना (Chat ऐप्लिकेशन की पुष्टि)
ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की अनुमति सिर्फ़ एक बार लेनी होती है .
Chat REST API का इस्तेमाल करके, ऐप्लिकेशन की पुष्टि वाले किसी स्पेस से स्पेस इवेंट के बारे में जानकारी पाने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:
- अपने अनुरोध में, हर इवेंट टाइप के लिए अनुमति पाने के एक या उससे ज़्यादा लिंक तय करें. सबसे सही तरीका यह है कि अनुमति पाने का ऐसा लिंक चुनें जो सबसे ज़्यादा पाबंदियां लगाता हो, लेकिन फिर भी आपके ऐप्लिकेशन को काम करने की अनुमति देता हो. लिंक चुनने के बारे में ज़्यादा जानने के लिए, पुष्टि और अनुमति की खास जानकारी लेख पढ़ें.
https://www.googleapis.com/auth/chat.app.membershipshttps://www.googleapis.com/auth/chat.app.memberships.readonlyhttps://www.googleapis.com/auth/chat.app.messages.readonlyhttps://www.googleapis.com/auth/chat.app.spaceshttps://www.googleapis.com/auth/chat.app.spaces.readonly
- `
spaceEvents` संसाधन पर `get` तरीका कॉल करें. - उस स्पेस का
nameपास करें जिससे इवेंट की जानकारी चाहिए.
Chat API को कॉल करने के लिए स्क्रिप्ट लिखना
यहां, Chat REST API और ऐप्लिकेशन की पुष्टि की मदद से, स्पेस इवेंट के बारे में जानकारी पाने का तरीका बताया गया है:
Python
Python के इस कोड सैंपल में, Chat REST API का इस्तेमाल किया गया है.
- अपनी वर्किंग डायरेक्ट्री में,
chat_spaceevents_get_app.pyनाम की एक फ़ाइल बनाएं. chat_spaceevents_get_app.pyमें यह कोड शामिल करें:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # Set authorization scopes based on the # event type. For example, if you are getting a space event # about a new membership, use the `chat.app.memberships` scope. # # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.app.spaces.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then lists space events from a specified space. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().spaceEvents().get( # The space to get event details from. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME', ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()कोड में, इनकी जगह ये डालें:
SPACE_NAME: स्पेस का नाम. इसे Chat API मेंspaces.listतरीके से या किसी स्पेस के यूआरएल से पाया जा सकता है.SPACE_EVENT_NAME: स्पेस इवेंट केnameसे मिली आईडी.ListSpaceEvents()तरीके से, आईडी पाई जा सकती है. इस तरीके का इस्तेमाल करने का तरीका जानने के लिए, किसी स्पेस से इवेंट की सूची बनाना लेख पढ़ें.
अपनी वर्किंग डायरेक्ट्री में, नमूना बनाएं और चलाएं:
python3 chat_spaceevents_get_app.py
Chat API, नई सदस्यताओं और मैसेज के बारे में स्पेस इवेंट की पेज वाली सूची दिखाता है.