इस गाइड में, Google Chat API के Space
संसाधन पर, create()
वाले तरीके का इस्तेमाल करके, नाम वाला स्पेस बनाने का तरीका बताया गया है.
नाम वाला स्पेस (जहां spaceType
की जगह SPACE
है) एक ऐसी जगह है जहां लोग मैसेज भेजते हैं, फ़ाइलें शेयर करते हैं, और साथ मिलकर काम करते हैं.
नाम वाले स्पेस में Chat ऐप्लिकेशन शामिल किए जा सकते हैं. नाम वाले स्पेस के लिए, स्पेस मैनेजर चुने जाते हैं. ये मैनेजर, एडमिन सेटिंग लागू कर सकते हैं, स्पेस के बारे में जानकारी दे सकते हैं, और लोगों और ऐप्लिकेशन को जोड़ या हटा सकते हैं.
Chat में अलग-अलग तरह के स्पेस बनाने के लिए, setUp()
संसाधन पर Space
तरीके का इस्तेमाल करें. इससे, स्पेस बनाने के साथ-साथ उसमें सदस्य भी जोड़े जा सकते हैं. इनमें डायरेक्ट मैसेज या ग्रुप मैसेज भी शामिल हैं. ज़्यादा जानकारी के लिए, स्पेस सेट अप करें.
नाम वाला स्पेस बनाने के बाद, उसमें सिर्फ़ पुष्टि किए गए उपयोगकर्ता को ही शामिल किया जा सकता है. स्पेस में सदस्यों को जोड़ने के लिए, Membership
संसाधन पर create()
तरीका इस्तेमाल करें. यह तरीका, आपको जोड़ने के लिए चुने गए हर व्यक्ति या ऐप्लिकेशन के लिए इस्तेमाल करना होगा. इसके अलावा, setUp()
तरीके का इस्तेमाल करके, नाम वाला स्पेस बनाया जा सकता है और उसमें सदस्यों को एक साथ जोड़ा जा सकता है.
ज़रूरी शर्तें
Node.js
- आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करें.
- अपने Chat ऐप्लिकेशन के लिए नाम, आइकॉन, और जानकारी के साथ Google Chat API को चालू और कॉन्फ़िगर करें.
- Node.js क्लाउड क्लाइंट लाइब्रेरी इंस्टॉल करें.
- Google Chat API के अनुरोध में पुष्टि करने के तरीके के आधार पर, ऐक्सेस क्रेडेंशियल बनाएं:
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
client_secrets.json
नाम वाली JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए,
सेवा खाते के क्रेडेंशियल बनाएं और क्रेडेंशियल को
credentials.json
नाम वाली JSON फ़ाइल के तौर पर सेव करें.
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
- अनुमति का स्कोप चुनें. यह इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर या Chat ऐप्लिकेशन के तौर पर पुष्टि करनी है.
Python
- आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करें.
- अपने Chat ऐप्लिकेशन के लिए नाम, आइकॉन, और जानकारी के साथ Google Chat API को चालू और कॉन्फ़िगर करें.
- Python क्लाउड क्लाइंट लाइब्रेरी इंस्टॉल करें.
- Google Chat API के अनुरोध में पुष्टि करने के तरीके के आधार पर, ऐक्सेस क्रेडेंशियल बनाएं:
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
client_secrets.json
नाम वाली JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए,
सेवा खाते के क्रेडेंशियल बनाएं और क्रेडेंशियल को
credentials.json
नाम वाली JSON फ़ाइल के तौर पर सेव करें.
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
- अनुमति का स्कोप चुनें. यह इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर या Chat ऐप्लिकेशन के तौर पर पुष्टि करनी है.
Java
- आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करें.
- अपने Chat ऐप्लिकेशन के लिए नाम, आइकॉन, और जानकारी के साथ Google Chat API को चालू और कॉन्फ़िगर करें.
- Java क्लाउड क्लाइंट लाइब्रेरी इंस्टॉल करें.
- Google Chat API के अनुरोध में पुष्टि करने के तरीके के आधार पर, ऐक्सेस क्रेडेंशियल बनाएं:
- Chat के उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
client_secrets.json
नाम वाली JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए,
सेवा खाते के क्रेडेंशियल बनाएं और क्रेडेंशियल को
credentials.json
नाम वाली JSON फ़ाइल के तौर पर सेव करें.
- Chat के उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
- अनुमति का स्कोप चुनें. यह इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर या Chat ऐप्लिकेशन के तौर पर पुष्टि करनी है.
Apps Script
- आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करें.
- अपने Chat ऐप्लिकेशन के लिए नाम, आइकॉन, और जानकारी के साथ Google Chat API को चालू और कॉन्फ़िगर करें.
- स्टैंडअलोन Apps Script प्रोजेक्ट बनाएं और ऐडवांस चैट सेवा चालू करें.
- इस गाइड में, आपको उपयोगकर्ता या ऐप्लिकेशन की पुष्टि में से किसी एक का इस्तेमाल करना होगा. Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए, सेवा खाते के क्रेडेंशियल बनाएं. यह तरीका जानने के लिए, Google Chat ऐप्लिकेशन के तौर पर पुष्टि करना और अनुमति देना लेख पढ़ें.
- अनुमति का स्कोप चुनें. यह इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर या Chat ऐप्लिकेशन के तौर पर पुष्टि करनी है.
उपयोगकर्ता के तौर पर, नाम वाला स्पेस बनाना
उपयोगकर्ता की पुष्टि की सुविधा के साथ कोई नाम वाला स्पेस बनाने के लिए, अपने अनुरोध में ये चीज़ें डालें:
chat.spaces.create
याchat.spaces
ऑथराइज़ेशन स्कोप की जानकारी दें.CreateSpace()
वाला तरीका कॉल करें. इसके लिए,space
कोSpace
के इंस्टेंस के तौर पर पास करें. साथ ही, इन फ़ील्ड का इस्तेमाल करें:spaceType
कोSPACE
पर सेट करें.displayName
को स्पेस के उस नाम पर सेट करें जो उपयोगकर्ता को दिखता है.- इसके अलावा, अन्य एट्रिब्यूट भी सेट किए जा सकते हैं, जैसे कि:
spaceDetails
- स्पेस के लिए, उपयोगकर्ता को दिखने वाला ब्यौरा और दिशा-निर्देशों का सेट.predefinedPermissionSettings
- स्पेस के लिए पहले से तय की गई अनुमतियां. उदाहरण के लिए, इसे कॉन्फ़िगर करके यह तय किया जा सकता है कि सभी सदस्य या सिर्फ़ स्पेस के मैनेजर मैसेज पोस्ट कर सकते हैं.
नाम वाला स्पेस बनाने का तरीका यहां बताया गया है:
Node.js
Python
Java
Apps Script
Chat ऐप्लिकेशन के तौर पर, नाम वाला स्पेस बनाना
ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की अनुमति एक बार लेनी होती है.
ऐप्लिकेशन से पुष्टि करने की सुविधा का इस्तेमाल करके, किसी उपयोगकर्ता को स्पेस में शामिल होने का न्योता भेजने या जोड़ने के लिए, अपने अनुरोध में ये चीज़ें शामिल करें:
- अनुमति के
chat.app.spaces.create
याchat.app.spaces
दायरे के बारे में बताएं. Space
संसाधन पर,create
तरीके को कॉल करें.spaceType
कोSPACE
पर सेट करें.displayName
को स्पेस के उस नाम पर सेट करें जो उपयोगकर्ता को दिखता है. यहां दिए गए उदाहरण में,displayName
कोAPI-made
पर सेट किया गया है.customer
फ़ील्ड का इस्तेमाल करके, Google Workspace डोमेन का ग्राहक आईडी डालें.- इसके अलावा, स्पेस के लिए अन्य एट्रिब्यूट भी सेट किए जा सकते हैं. जैसे,
spaceDetails
(उपयोगकर्ता को दिखने वाला ब्यौरा और स्पेस के लिए दिशा-निर्देशों का सेट).
एपीआई पासकोड बनाना
डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई के खोज से जुड़े दस्तावेज़ के ऐसे वर्शन का इस्तेमाल करना होगा जो सार्वजनिक तौर पर उपलब्ध न हो. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.
एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:
- Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
- आपको अपनी नई एपीआई कुंजी दिखेगी.
- अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, एपीआई पासकोड कॉपी करने के लिए, कॉपी करें पर क्लिक करें. एपीआई पासकोड, प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी मिल सकता है.
- बेहतर सेटिंग अपडेट करने और एपीआई पासकोड के इस्तेमाल को सीमित करने के लिए, पासकोड पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड पर पाबंदियां लगाना लेख पढ़ें.
Chat API को कॉल करने वाली स्क्रिप्ट लिखना
नाम वाला स्पेस बनाने का तरीका यहां बताया गया है:
Python
- अपनी वर्किंग डायरेक्ट्री में,
chat_space_create_named_app.py
नाम की फ़ाइल बनाएं. chat_space_create_named_app.py
में यह कोड शामिल करें:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces.create"] def main(): ''' Authenticates with Chat API using app authentication, then creates a Chat 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().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made', # The customer ID of the Workspace domain. 'customer': 'CUSTOMER' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
कोड में, इनकी जगह ये डालें:
API_KEY
: Chat API के लिए सेवा एंडपॉइंट बनाने के लिए बनाई गई एपीआई पासकोड.CUSTOMER
:customer/{customer}
फ़ॉर्मैट में, स्पेस के डोमेन का ग्राहक आईडी, जहां{customer}
, Admin SDK टूल के ग्राहक संसाधन सेID
है. Chat ऐप्लिकेशन के उसी Google Workspace संगठन में स्पेस बनाने के लिए,customers/my_customer
का इस्तेमाल करें.
अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:
python3 chat_space_create_named_app.py
Google Chat में स्पेस खोलना
स्पेस पर जाने के लिए, स्पेस का यूआरएल बनाने के लिए, स्पेस के रिसॉर्स आईडी का इस्तेमाल करें. Google Chat के जवाब के मुख्य हिस्से में, स्पेस name
का संसाधन आईडी देखा जा सकता है. उदाहरण के लिए, अगर आपके स्पेस का name
spaces/1234567
है, तो इस यूआरएल का इस्तेमाल करके स्पेस पर जाया जा सकता है: https://mail.google.com/chat/u/0/#chat/space/1234567
.
मिलते-जुलते विषय
- सदस्य बनाकर, स्पेस में लोगों और ऐप्लिकेशन को जोड़ें.
- मैसेज बनाकर, स्पेस में कोई मैसेज पोस्ट करें.
- किसी स्पेस के बारे में जानकारी पाना.
- स्पेस की सूची.
- स्पेस को अपडेट करना.
- स्पेस मिटाना.
- स्पेस सेट अप करना.
- डायरेक्ट मैसेज स्पेस ढूंढें.
- स्पेस को चुनिंदा उपयोगकर्ताओं के लिए उपलब्ध कराना.