इस गाइड में, Google Chat API के SpaceEvent
रिसॉर्स पर get()
तरीके का इस्तेमाल करने का तरीका बताया गया है. इससे Google Chat स्पेस में मौजूद किसी इवेंट के बारे में जानकारी मिलती है.
SpaceEvent
संसाधन, किसी स्पेस या उसके चाइल्ड रिसॉर्स में हुए बदलाव को दिखाता है. जैसे, मैसेज, प्रतिक्रियाएं, और सदस्यताएं. इवेंट के उपलब्ध टाइप के बारे में जानने के लिए, SpaceEvent
संसाधन के eventType
फ़ील्ड
का रेफ़रंस दस्तावेज़ देखें.
अनुरोध करने की तारीख से 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()
तरीके का इस्तेमाल करें या स्पेस के यूआरएल से आईडी पाएं.SPACE_EVENT_NAME
: स्पेस इवेंट केname
का आईडी. आपको आईडी,ListSpaceEvents()
तरीके से मिल सकता है. इस तरीके का इस्तेमाल करने का तरीका जानने के लिए, किसी स्पेस के इवेंट की सूची बनाना लेख पढ़ें.
Chat API, इवेंट की जानकारी के साथ SpaceEvent
का एक इंस्टेंस दिखाता है.
किसी स्पेस इवेंट के बारे में जानकारी पाना (Chat ऐप्लिकेशन का प्रमाणीकरण)
इस प्रोग्राम में शामिल होने पर, आपको कुछ सुविधाओं को रिलीज़ होने से पहले ही इस्तेमाल करने का ऐक्सेस मिलता है.ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की एक बार की अनुमति ज़रूरी है.
ऐप्लिकेशन की पुष्टि की सुविधा वाले स्पेस से किसी स्पेस इवेंट के बारे में जानकारी पाने के लिए, Chat REST API का इस्तेमाल करें. इसके लिए, अपने अनुरोध में यह जानकारी शामिल करें:
- अपने अनुरोध में हर इवेंट टाइप के लिए, एक या उससे ज़्यादा अनुमति के स्कोप तय करें. सबसे सही तरीका यह है कि आप सबसे सीमित स्कोप चुनें. इससे आपका ऐप्लिकेशन काम कर पाएगा. स्कोप चुनने के बारे में ज़्यादा जानने के लिए, प्रमाणीकरण और अनुमति की खास जानकारी देखें.
https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.app.messages.readonly
https://www.googleapis.com/auth/chat.app.spaces
spaceEvents
संसाधन परget
तरीके को कॉल करें.- जिस स्पेस से इवेंट की जानकारी चाहिए उसका
name
पास करें.
एपीआई पासकोड बनाना
डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई डिस्कवरी दस्तावेज़ के डेवलपर प्रीव्यू वर्शन का इस्तेमाल करना होगा. यह वर्शन सार्वजनिक नहीं होता. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.
एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:
- Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
- आपको नई एपीआई कुंजी दिखेगी.
- अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, एपीआई पासकोड कॉपी करने के लिए, कॉपी करें पर क्लिक करें. एपीआई कुंजी, आपके प्रोजेक्ट के क्रेडेंशियल के "एपीआई कुंजियां" सेक्शन में भी देखी जा सकती है.
- हमारा सुझाव है कि बिना अनुमति के इस्तेमाल को रोकने के लिए, यह तय करें कि एपीआई कुंजी का इस्तेमाल कहां और किन एपीआई के लिए किया जा सकता है. ज़्यादा जानकारी के लिए, एपीआई पर पाबंदियां जोड़ना लेख पढ़ें.
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.readonly` 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.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces"] 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # 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()
कोड में, इनकी जगह ये डालें:
API_KEY
: Chat API के लिए सर्विस एंडपॉइंट बनाने के लिए, आपने जो एपीआई पासकोड बनाया है.SPACE_NAME
: स्पेस का नाम. इसे Chat API मेंspaces.list
तरीके से या स्पेस के यूआरएल से पाया जा सकता है.SPACE_EVENT_NAME
: स्पेस इवेंट केname
का आईडी. आपको आईडी,ListSpaceEvents()
तरीके से मिल सकता है. इस तरीके का इस्तेमाल करने का तरीका जानने के लिए, किसी स्पेस के इवेंट की सूची बनाना लेख पढ़ें.
अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और उसे चलाएं:
python3 chat_spaceevents_get_app.py
Chat API, नई मेंबरशिप और मैसेज के बारे में स्पेस इवेंट की पेज के हिसाब से बांटी गई सूची दिखाता है.