इस गाइड में, Google Chat API के Space
रिसॉर्स पर create()
तरीके का इस्तेमाल करके, नाम वाला स्पेस बनाने का तरीका बताया गया है.
नाम वाला स्पेस (जहां spaceType
SPACE
है) एक ऐसी जगह होती है जहां लोग मैसेज भेजते हैं, फ़ाइलें शेयर करते हैं, और साथ मिलकर काम करते हैं.
नाम वाले स्पेस में Chat ऐप्लिकेशन शामिल किए जा सकते हैं. नाम वाले स्पेस के मैनेजर, एडमिन सेटिंग लागू कर सकते हैं. साथ ही, स्पेस के ब्यौरे में बदलाव कर सकते हैं. इसके अलावा, वे स्पेस में लोगों और ऐप्लिकेशन को जोड़ या हटा सकते हैं.
अलग-अलग तरह के Chat स्पेस (जैसे, डायरेक्ट मैसेज या ग्रुप मैसेज) बनाने के लिए, setUp()
संसाधन पर Space
तरीके का इस्तेमाल करें. इससे स्पेस बनाने के साथ-साथ सदस्यों को भी जोड़ा जा सकता है. ज़्यादा जानकारी के लिए, स्पेस सेट अप करें.
नाम वाला स्पेस बनाने के बाद, पुष्टि किया गया उपयोगकर्ता ही स्पेस का सदस्य होता है. स्पेस में सदस्यों को जोड़ने के लिए, Membership
संसाधन पर create()
तरीके को कॉल करें. ऐसा उन सभी लोगों या ऐप्लिकेशन के लिए करें जिन्हें आपको जोड़ना है. इसके अलावा, setUp()
तरीके का इस्तेमाल करके, एक साथ कई सदस्यों को किसी स्पेस में जोड़ा जा सकता है.
ज़रूरी शर्तें
Node.js
- आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास Google Chat को ऐक्सेस करने की अनुमति होनी चाहिए.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth के लिए सहमति दी जाती है.
- अपने Chat ऐप्लिकेशन के लिए, Google Chat API चालू करें और उसे कॉन्फ़िगर करें. इसके लिए, Chat ऐप्लिकेशन का नाम, आइकॉन, और जानकारी दें.
- 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 चालू करें और उसे कॉन्फ़िगर करें. इसके लिए, Chat ऐप्लिकेशन का नाम, आइकॉन, और जानकारी दें.
- Python Cloud Client Library इंस्टॉल करें.
- Google Chat API के अनुरोध में पुष्टि करने के तरीके के आधार पर, ऐक्सेस क्रेडेंशियल बनाएं:
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए, OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
credentials.json
नाम की JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए, सेवा खाते के क्रेडेंशियल बनाएं और क्रेडेंशियल को
credentials.json
नाम की JSON फ़ाइल के तौर पर सेव करें.
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए, OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
- अनुमति का स्कोप चुनें. यह इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर पुष्टि करनी है या Chat ऐप्लिकेशन के तौर पर.
Java
- आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास Google Chat को ऐक्सेस करने की अनुमति होनी चाहिए.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth के लिए सहमति दी जाती है.
- अपने Chat ऐप्लिकेशन के लिए, Google Chat API चालू करें और उसे कॉन्फ़िगर करें. इसके लिए, Chat ऐप्लिकेशन का नाम, आइकॉन, और जानकारी दें.
- Java Cloud Client Library इंस्टॉल करें.
- Google Chat API के अनुरोध में पुष्टि करने के तरीके के आधार पर, ऐक्सेस क्रेडेंशियल बनाएं:
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए, OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
credentials.json
नाम की JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए, सेवा खाते के क्रेडेंशियल बनाएं और क्रेडेंशियल को
credentials.json
नाम की JSON फ़ाइल के तौर पर सेव करें.
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए, OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं. इसके बाद, क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में
- अनुमति का स्कोप चुनें. यह इस बात पर निर्भर करता है कि आपको उपयोगकर्ता के तौर पर पुष्टि करनी है या Chat ऐप्लिकेशन के तौर पर.
Apps Script
- आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास Google Chat को ऐक्सेस करने की अनुमति होनी चाहिए.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth के लिए सहमति दी जाती है.
- अपने Chat ऐप्लिकेशन के लिए, Google Chat API चालू करें और उसे कॉन्फ़िगर करें. इसके लिए, Chat ऐप्लिकेशन का नाम, आइकॉन, और जानकारी दें.
- 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 customer resource का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
.
सीमाएं और ज़रूरी बातें
- ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करके स्पेस बनाने पर, पुष्टि करने वाले Chat ऐप्लिकेशन को स्पेस के सदस्य के तौर पर जोड़ा जाता है. हालांकि, उपयोगकर्ता की पुष्टि करने की सुविधा के उलट, इसे स्पेस मैनेजर के तौर पर नहीं जोड़ा जाता. डिफ़ॉल्ट रूप से, स्पेस के सभी सदस्य Chat ऐप्लिकेशन को हटा सकते हैं. अगर आपको सिर्फ़ स्पेस मैनेजर को Chat ऐप्लिकेशन हटाने की अनुमति देनी है, तो
permissionSettings.manageApps
कोmanagersAllowed
पर सेट करें.
मिलते-जुलते विषय
- सदस्य बनाकर, स्पेस में लोगों और ऐप्लिकेशन को जोड़ें.
- मैसेज बनाकर, स्पेस में कोई मैसेज पोस्ट करें.
- किसी स्पेस के बारे में जानकारी पाना.
- स्पेस की सूची.
- स्पेस अपडेट करना.
- किसी स्पेस को मिटाना.
- कोई स्पेस सेट अप करना.
- डायरेक्ट मैसेज वाला स्पेस ढूंढें.
- किसी स्पेस को चुनिंदा लोगों के लिए उपलब्ध कराना.