इस गाइड में, Google Chat API के Membership
संसाधन पर update()
के तरीके का इस्तेमाल करके, सदस्यता के एट्रिब्यूट बदलने का तरीका बताया गया है. जैसे, स्पेस के सदस्य को स्पेस मैनेजर में बदलना या स्पेस मैनेजर को स्पेस के सदस्य में बदलना.
अगर आप Google Workspace एडमिन हैं, तो अपने Google Workspace संगठन में किसी भी स्पेस की सदस्यता अपडेट करने के लिए, update()
तरीका अपनाएं.
Membership
रिसॉर्स से पता चलता है कि किसी व्यक्ति या Google Chat ऐप्लिकेशन को स्पेस में शामिल होने का न्योता मिला है या नहीं. साथ ही, यह भी पता चलता है कि वह स्पेस में शामिल है या नहीं.
ज़रूरी शर्तें
Node.js
- कारोबार या एंटरप्राइज़ Google Workspace खाता, जिसके पास इसका ऐक्सेस है Google Chat.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करें.
- Google Chat API को चालू और कॉन्फ़िगर करें. इसका नाम रखें, आइकॉन और ब्यौरा जोड़ें.
- इंस्टॉल करें Node.js Cloud क्लाइंट लाइब्रेरी.
- अपने Google Chat API में, पुष्टि करने के तरीके के हिसाब से ऐक्सेस क्रेडेंशियल बनाएं
अनुरोध:
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
client_secrets.json
नाम वाली JSON फ़ाइल के तौर पर सेव करें. - Chat ऐप्लिकेशन के तौर पर पुष्टि करने के लिए,
सेवा खाता बनाएं
क्रेडेंशियल पर क्लिक करें और क्रेडेंशियल को नाम वाली JSON फ़ाइल के रूप में सेव करें
credentials.json
.
- Chat उपयोगकर्ता के तौर पर पुष्टि करने के लिए,
OAuth क्लाइंट आईडी के क्रेडेंशियल बनाएं और क्रेडेंशियल को अपनी लोकल डायरेक्ट्री में,
- अनुमति देने का दायरा इस आधार पर चुनें कि आपको उपयोगकर्ता के तौर पर पुष्टि करनी है या चैट ऐप्लिकेशन.
पैसे चुकाकर ली गई सदस्यता अपडेट करना
स्पेस की सदस्यता अपडेट करने के लिए, अपने अनुरोध में यह जानकारी दें:
- अनुमति देने का दायरा तय करें:
- उपयोगकर्ता की पुष्टि करने की सुविधा से,
chat.memberships
की अनुमति के दायरे की जानकारी दें. - ऐप्लिकेशन की पुष्टि (डेवलपर के लिए उपलब्ध झलक में उपलब्ध) की मदद से,
chat.app.memberships
अनुमति का दायरा तय करें. ऐप्लिकेशन की पुष्टि करके सदस्यता अपडेट करते समय, सिर्फ़ चैट ऐप्लिकेशन से बनाए गए स्पेस में सदस्यताएं अपडेट की जा सकती हैं. ऐप्लिकेशन की पुष्टि करने के लिए, एक बार पुष्टि करना ज़रूरी है एडमिन की मंज़ूरी.
- उपयोगकर्ता की पुष्टि करने की सुविधा से,
UpdateMembership()
वाला तरीका कॉल करें.membership
कोMembership
के इंस्टेंस के तौर पर पास करें. इसके लिए, इनका इस्तेमाल करें:name
फ़ील्ड, सदस्यता को अपडेट करने के लिए सेट किया गया है. इसमें स्पेस आईडी और सदस्य आईडी शामिल है.- सदस्यता के उन फ़ील्ड को अपडेट करने के लिए, नई वैल्यू सेट की गई हैं.
- पैसे चुकाकर ली गई सदस्यता को अपडेट करने की ज़रूरी शर्तें पूरी करने के लिए,
updateMask
को पास करें. इसमें ये शामिल हैं:role
: चैट स्पेस में उपयोगकर्ता की भूमिका. इससे तय होता है कि उसे किन उपयोगकर्ताओं को सूचना भेजनी है कार्रवाइयां. आपको ये वैल्यू दिख सकती हैं:ROLE_MEMBER
: स्पेस का सदस्य. उपयोगकर्ता के पास बुनियादी अनुमतियां होती हैं, जैसे कि स्पेस में मैसेज भेजना. 1:1 और बिना नाम वाले ग्रुप में बातचीत, सभी की भूमिका है.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 ऐप्लिकेशन में, स्पेस के सामान्य सदस्य को स्पेस मैनेजर बनाना
ऐप्लिकेशन की पुष्टि करने के लिए, एक बार पुष्टि करना ज़रूरी है एडमिन की मंज़ूरी.
एपीआई पासकोड बनाना
डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई के खोज से जुड़े दस्तावेज़ के ऐसे वर्शन का इस्तेमाल करना होगा जो सार्वजनिक तौर पर उपलब्ध न हो. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.
एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:
- Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
- आपको अपनी नई API (एपीआई) कुंजी दिखेगी.
- कॉपी करें पर क्लिक करें का इस्तेमाल करें. एपीआई पासकोड, प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी मिल सकता है.
- बेहतर सेटिंग अपडेट करने और एपीआई पासकोड के इस्तेमाल को सीमित करने के लिए, पासकोड पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड से जुड़ी पाबंदियां लागू करना लेख पढ़ें.
Chat API को कॉल करने वाली स्क्रिप्ट लिखें
इस उदाहरण में, ऐप्लिकेशन की पुष्टि का इस्तेमाल करके Chat API को कॉल किया गया है. इससे, स्पेस के सामान्य सदस्य को स्पेस मैनेजर बनाया जा सकता है. इसके लिए, body
में 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, 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().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()
कोड में, इनकी जगह ये डालें:
API_KEY
: Chat API के लिए सेवा एंडपॉइंट बनाने के लिए, आपने जो एपीआई पासकोड बनाया है.SPACE
: स्पेस का नाम, जो आपको Chat API मेंspaces.list
तरीके या स्पेस के यूआरएल से मिल सकता है.MEMBERSHIP
: सदस्यता का नाम, जो तो आपको यहां सेspaces.members.list
तरीका Chat API में.
अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:
python3 chat_membership_update_to_manager_app.py
स्पेस मैनेजर को Chat ऐप्लिकेशन का सामान्य सदस्य बनाना
ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की अनुमति एक बार लेनी होगी.
एपीआई पासकोड बनाना
डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई के खोज से जुड़े दस्तावेज़ के ऐसे वर्शन का इस्तेमाल करना होगा जो सार्वजनिक तौर पर उपलब्ध न हो. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.
एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:
- Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल. पर जाएं
- क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
- आपको अपनी नई API (एपीआई) कुंजी दिखेगी.
- कॉपी करें पर क्लिक करें का इस्तेमाल करें. एपीआई पासकोड, प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी मिल सकता है.
- बेहतर सेटिंग अपडेट करने और एपीआई पासकोड के इस्तेमाल को सीमित करने के लिए, पासकोड पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड पर पाबंदियां लगाना लेख पढ़ें.
Chat API को कॉल करने वाली स्क्रिप्ट लिखें
नीचे दिए गए उदाहरण में, Chat API को कॉल करने के बारे में बताया गया है
ऐप्लिकेशन की पुष्टि करना
स्पेस मैनेजर को स्पेस का सामान्य सदस्य बनाने के लिए, role
को
body
में ROLE_MEMBER
, जो अपडेट किए गए सदस्यता एट्रिब्यूट की जानकारी देता है:
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, 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().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()
कोड में, इन्हें बदलें:
API_KEY
: वह एपीआई पासकोड जिसे आपने बनाने के लिए बनाया है Chat API के लिए सेवा एंडपॉइंट.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 ऐप्लिकेशन को हटाना.