इस गाइड में, Google Chat API के Membership
संसाधन पर update()
तरीके का इस्तेमाल करने का तरीका बताया गया है. इससे सदस्यता के बारे में एट्रिब्यूट बदले जा सकते हैं. जैसे, स्पेस के सदस्य को स्पेस मैनेजर में बदलना या स्पेस मैनेजर को स्पेस के सदस्य में बदलना.
अगर आप Google Workspace एडमिन हैं, तो update()
तरीके का इस्तेमाल करके, अपने Google Workspace संगठन में किसी भी स्पेस की सदस्यता अपडेट की जा सकती है.
Membership
संसाधन से पता चलता है कि किसी व्यक्ति या Google Chat ऐप्लिकेशन को स्पेस में शामिल होने का न्योता मिला है या नहीं. इससे यह भी पता चलता है कि वह स्पेस में शामिल है या नहीं.
ज़रूरी शर्तें
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 ऐप्लिकेशन के तौर पर.
सदस्यता अपडेट करना
स्पेस की सदस्यता अपडेट करने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:
- ऑथराइज़ेशन स्कोप तय करें:
- उपयोगकर्ता की पुष्टि करने की सुविधा की मदद से,
chat.memberships
अनुमति का दायरा तय करें. - ऐप्लिकेशन की पुष्टि करके,
chat.app.memberships
के लिए अनुमति का दायरा तय करें. ऐप्लिकेशन की पुष्टि करके ली गई सदस्यता को अपडेट करते समय, सिर्फ़ उन स्पेस में सदस्यताएं अपडेट की जा सकती हैं जिन्हें Chat ऐप्लिकेशन ने बनाया है. ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की एक बार की अनुमति ज़रूरी है.
- उपयोगकर्ता की पुष्टि करने की सुविधा की मदद से,
UpdateMembership()
तरीके को कॉल करें.membership
कोMembership
के इंस्टेंस के तौर पर पास करें. इसके साथ ही, यह भी पास करें:- अपडेट की जाने वाली सदस्यता के लिए सेट किया गया
name
फ़ील्ड. इसमें स्पेस आईडी और सदस्य आईडी शामिल होता है. - सदस्यता वाले फ़ील्ड को नई वैल्यू पर अपडेट किया जाना चाहिए.
- अपडेट की जाने वाली सदस्यता के लिए सेट किया गया
- सदस्यता के जिन पहलुओं को अपडेट करना है उनके लिए
updateMask
पास करें. इनमें ये शामिल हैं:role
: Chat स्पेस में उपयोगकर्ता की भूमिका. इससे यह तय होता है कि वह स्पेस में कौन-कौनसी कार्रवाइयां कर सकता है. संभावित वैल्यू ये हैं:ROLE_MEMBER
: स्पेस का सदस्य. उपयोगकर्ता के पास बुनियादी अनुमतियां हों, जैसे कि स्पेस में मैसेज भेजने की अनुमति. एक-दूसरे से की जाने वाली बातचीत और ग्रुप में होने वाली जिन बातचीत का कोई नाम नहीं है उनमें मौजूद सभी लोगों के पास यह भूमिका होती है.ROLE_MANAGER
: स्पेस मैनेजर. उपयोगकर्ता के पास सभी बुनियादी अनुमतियां होती हैं. साथ ही, उसके पास एडमिन से जुड़ी अनुमतियां भी होती हैं. इनकी मदद से, वह स्पेस को मैनेज कर सकता है. जैसे, सदस्यों को जोड़ना या हटाना. यह सुविधा सिर्फ़ उन स्पेस में काम करती है जहांspaceType
SPACE
है (नाम वाले स्पेस).
किसी सामान्य सदस्य को स्पेस मैनेजर बनाना
यहां दिए गए उदाहरण में, Chat API को कॉल किया गया है. इसमें उपयोगकर्ता की पुष्टि करने की सुविधा का इस्तेमाल किया गया है. साथ ही, स्पेस के सामान्य सदस्य को स्पेस मैनेजर बनाने के लिए, role
को ROLE_MANAGER
के तौर पर सेट किया गया है:
Node.js
सैंपल चलाने के लिए, इनकी जगह ये डालें:
SPACE_NAME
: स्पेस केname
का आईडी. आईडी पाने के लिए,ListSpaces()
तरीके का इस्तेमाल करें या स्पेस के यूआरएल से आईडी पाएं.MEMBER_NAME
: सदस्यता केname
से मिला आईडी. आईडी पाने के लिए,ListMemberships()
तरीके को कॉल करें. इसके अलावा, Chat API के साथ एसिंक्रोनस तरीके से सदस्यता बनाने के बाद, आईडी को रिस्पॉन्स बॉडी से भी पाया जा सकता है.ROLE_NAME
: अपडेट की गई भूमिका,ROLE_MANAGER
.
Google Chat API, स्पेस मैनेजर के तौर पर चुनी गई सदस्यता को अपडेट करता है और Membership
का इंस्टेंस दिखाता है.
किसी स्पेस मैनेजर को उपयोगकर्ता के तौर पर सामान्य सदस्य बनाना
यहां दिए गए उदाहरण में, उपयोगकर्ता की पुष्टि करने की सुविधा का इस्तेमाल करके Chat API को कॉल किया गया है. इससे स्पेस मैनेजर को स्पेस का सामान्य सदस्य बनाया जा सकता है. इसके लिए, role
को ROLE_MEMBER
के तौर पर सेट करें:
Node.js
सैंपल चलाने के लिए, इनकी जगह ये डालें:
SPACE_NAME
: स्पेस केname
का आईडी. आईडी पाने के लिए,ListSpaces()
तरीके का इस्तेमाल करें या स्पेस के यूआरएल से आईडी पाएं.MEMBER_NAME
: सदस्यता केname
से मिला आईडी. आईडी पाने के लिए,ListMemberships()
तरीके को कॉल करें. इसके अलावा, Chat API के साथ एसिंक्रोनस तरीके से सदस्यता बनाने के बाद, आईडी को रिस्पॉन्स बॉडी से भी पाया जा सकता है.ROLE_NAME
: अपडेट की गई भूमिका,ROLE_MEMBER
.
Google Chat API, स्पेस मैनेजर के तौर पर चुनी गई सदस्यता को अपडेट करता है और Membership
का इंस्टेंस दिखाता है.
Chat ऐप्लिकेशन के तौर पर, किसी सामान्य सदस्य को स्पेस मैनेजर बनाना
ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की एक बार की अनुमति ज़रूरी है.
Chat API को कॉल करने वाली स्क्रिप्ट लिखना
यहां दिए गए उदाहरण में, Chat API को कॉल किया गया है. इसमें ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल किया गया है. साथ ही, स्पेस के किसी सामान्य सदस्य को स्पेस मैनेजर बनाने के लिए, role
को ROLE_MANAGER
के तौर पर सेट किया गया है. यह body
में मौजूद है, जिसमें सदस्यता के अपडेट किए गए एट्रिब्यूट दिए गए हैं:
Python
- अपनी वर्किंग डायरेक्ट्री में,
chat_membership_update_to_manager_app.py
नाम की एक फ़ाइल बनाएं. chat_membership_update_to_manager_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.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MANAGER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
कोड में, इनकी जगह ये डालें:
SPACE
: स्पेस का नाम. इसे Chat API में मौजूदspaces.list
तरीके से या स्पेस के यूआरएल से पाया जा सकता है.MEMBERSHIP
: सदस्यता का नाम, जिसे Chat API मेंspaces.members.list
तरीके से हासिल किया जा सकता है.
अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और उसे चलाएं:
python3 chat_membership_update_to_manager_app.py
किसी स्पेस मैनेजर को Chat ऐप्लिकेशन के तौर पर सामान्य सदस्य बनाना
ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की एक बार की अनुमति ज़रूरी है.
Chat API को कॉल करने वाली स्क्रिप्ट लिखना
यहां दिए गए उदाहरण में, Chat API को कॉल किया गया है. इसमें ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल किया गया है. इससे स्पेस मैनेजर को स्पेस का सामान्य सदस्य बनाया जा सकता है. इसके लिए, role
को ROLE_MEMBER
के तौर पर सेट किया गया है. यह body
में मौजूद है. body
में सदस्यता से जुड़े अपडेट किए गए एट्रिब्यूट शामिल हैं:
Python
- अपनी वर्किंग डायरेक्ट्री में,
chat_membership_update_to_member_app.py
नाम की एक फ़ाइल बनाएं. chat_membership_update_to_member_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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MEMBER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
कोड में, इनकी जगह ये डालें:
SPACE
: स्पेस का नाम. इसे Chat API में मौजूदspaces.list
तरीके से या स्पेस के यूआरएल से पाया जा सकता है.MEMBERSHIP
: सदस्यता का नाम, जिसे Chat API मेंspaces.members.list
तरीके से हासिल किया जा सकता है.
अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और उसे चलाएं:
python3 chat_membership_update_to_member_app.py
Google Workspace एडमिन के तौर पर सदस्यताएं अपडेट करना
अगर आप Google Workspace एडमिन हैं, तो update()
तरीके का इस्तेमाल करके, अपने Google Workspace संगठन के किसी भी स्पेस के लिए सदस्यताएं अपडेट की जा सकती हैं.
Google Workspace एडमिन के तौर पर इस तरीके को कॉल करने के लिए, यह तरीका अपनाएं:
- उपयोगकर्ता की पुष्टि करने के लिए, इस तरीके का इस्तेमाल करें. साथ ही, अनुमति का दायरा तय करें. इससे एडमिन के अधिकारों का इस्तेमाल करके, इस तरीके को कॉल किया जा सकेगा.
- अपने अनुरोध में, क्वेरी पैरामीटर
useAdminAccess
कोtrue
पर सेट करें.
ज़्यादा जानकारी और उदाहरणों के लिए, Google Workspace एडमिन के तौर पर Google Chat स्पेस मैनेज करना लेख पढ़ें.
मिलते-जुलते विषय
- किसी स्पेस में किसी उपयोगकर्ता या Google Chat ऐप्लिकेशन को न्योता भेजना या उसे जोड़ना.
- किसी उपयोगकर्ता या Chat ऐप्लिकेशन की सदस्यता के बारे में जानकारी पाना.
- किसी स्पेस में मौजूद सदस्यों की सूची देखना.
- किसी स्पेस से किसी उपयोगकर्ता या Chat ऐप्लिकेशन को हटाना.