Google Chat स्पेस में उपयोगकर्ता की सदस्यता अपडेट करना

इस गाइड में, Google Chat API के Membership संसाधन पर update() के तरीके का इस्तेमाल करके, सदस्यता के एट्रिब्यूट बदलने का तरीका बताया गया है. जैसे, स्पेस के सदस्य को स्पेस मैनेजर बनाना या स्पेस मैनेजर को स्पेस का सदस्य बनाना.

अगर आप Google Workspace एडमिन हैं, तो अपने Google Workspace संगठन में किसी भी स्पेस की सदस्यता अपडेट करने के लिए, update() तरीका अपनाएं.

Membership संसाधन से यह पता चलता है कि किसी उपयोगकर्ता या Google Chat ऐप्लिकेशन को स्पेस में शामिल होने का न्योता दिया गया है या नहीं या वह स्पेस में नहीं है.

ज़रूरी शर्तें

Node.js

  • आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.

पैसे चुकाकर ली गई सदस्यता अपडेट करना

स्पेस की सदस्यता अपडेट करने के लिए, अपने अनुरोध में यह जानकारी दें:

  • अनुमति का दायरा तय करें:
  • UpdateMembership() वाला तरीका कॉल करें.
  • इन चीज़ों के साथ, membership को Membership के इंस्टेंस के तौर पर पास करें:
    • name फ़ील्ड, सदस्यता को अपडेट करने के लिए सेट किया गया है. इसमें स्पेस आईडी और सदस्य आईडी शामिल है.
    • सदस्यता के उन फ़ील्ड को अपडेट करने के लिए, नई वैल्यू सेट की गई हैं.
  • सदस्यता के जिन पहलुओं को अपडेट करना है उनके बारे में बताने के लिए, updateMask पास करें. इसमें ये शामिल हैं:
    • role: चैट स्पेस में उपयोगकर्ता की भूमिका, जिससे यह तय होता है कि स्पेस में उसे कौनसी कार्रवाइयां करने की अनुमति है. वैल्यू इस तरह की हो सकती हैं:
      • ROLE_MEMBER: स्पेस का सदस्य. उपयोगकर्ता के पास बुनियादी अनुमतियां होती हैं. जैसे, स्पेस में मैसेज भेजना. 1:1 और बिना नाम वाली ग्रुप बातचीत में, सभी लोगों की एक भूमिका होती है.
      • ROLE_MANAGER: स्पेस मैनेजर. उपयोगकर्ता के पास सभी बुनियादी अनुमतियां होती हैं. साथ ही, एडमिन की अनुमतियां भी होती हैं. इनकी मदद से, वह स्पेस को मैनेज कर सकता है. जैसे, सदस्यों को जोड़ना या हटाना. यह सुविधा सिर्फ़ उन स्पेस में काम करती है जहां spaceType, SPACE है (नाम वाले स्पेस).

स्पेस के सामान्य सदस्य को स्पेस मैनेजर बनाना

इस उदाहरण में, स्पेस के किसी नियमित सदस्य को स्पेस मैनेजर बनाने के लिए, उपयोगकर्ता की पहचान की पुष्टि करने की सुविधा का इस्तेमाल करके Chat API को कॉल किया गया है. इसके लिए, role को ROLE_MANAGER के तौर पर दिखाया गया है:

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

सैंपल चलाने के लिए, इन्हें बदलें:

  • 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

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

सैंपल चलाने के लिए, इन्हें बदलें:

  • SPACE_NAME: स्पेस के name का आईडी. आईडी पाने के लिए, ListSpaces() तरीके पर कॉल करें या स्पेस के यूआरएल का इस्तेमाल करें.
  • MEMBER_NAME: सदस्यता की name से मिला आईडी. आईडी पाने के लिए, ListMemberships() तरीका आज़माएं. इसके अलावा, Chat API की मदद से सदस्यता बनाने के बाद, रिस्पॉन्स बॉडी से भी आईडी पाया जा सकता है.
  • ROLE_NAME: अपडेट की गई भूमिका, ROLE_MEMBER.

Google Chat API, बताई गई सदस्यता को स्पेस मैनेजर के तौर पर अपडेट करता है और Membership का एक इंस्टेंस दिखाता है.

स्पेस के किसी नियमित सदस्य को चैट ऐप्लिकेशन के तौर पर स्पेस मैनेजर बनाना

ऐप्लिकेशन की पुष्टि करने के लिए, एक बार के लिए एडमिन की अनुमति ज़रूरी होती है.

एपीआई पासकोड बनाना

डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई के खोज से जुड़े दस्तावेज़ के ऐसे वर्शन का इस्तेमाल करना होगा जो सार्वजनिक तौर पर उपलब्ध न हो. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.

एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
  3. आपको अपनी नई एपीआई कुंजी दिखेगी.
    • अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, एपीआई पासकोड कॉपी करने के लिए, कॉपी करें पर क्लिक करें. एपीआई पासकोड, प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी मिल सकता है.
    • बेहतर सेटिंग अपडेट करने और एपीआई पासकोड का सीमित इस्तेमाल करने के लिए, कुंजी पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड पर पाबंदियां लगाना लेख पढ़ें.

Chat API को कॉल करने वाली स्क्रिप्ट लिखना

इस उदाहरण में, ऐप्लिकेशन की पुष्टि का इस्तेमाल करके Chat API को कॉल किया गया है. इससे, स्पेस के सामान्य सदस्य को स्पेस मैनेजर बनाया जा सकता है. इसके लिए, body में role को ROLE_MANAGER के तौर पर सेट किया गया है. body में, सदस्यता के अपडेट किए गए एट्रिब्यूट की जानकारी दी गई है:

Python

  1. अपनी वर्किंग डायरेक्ट्री में, chat_membership_update_to_manager_app.py नाम की फ़ाइल बनाएं.

  2. 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()

  3. कोड में, इनकी जगह ये डालें:

    • API_KEY: वह एपीआई पासकोड जिसे आपने Chat API का सर्विस एंडपॉइंट बनाने के लिए बनाया था.

    • SPACE: स्पेस का नाम, जो आपको Chat API में spaces.list तरीके या स्पेस के यूआरएल से मिल सकता है.

    • MEMBERSHIP: सदस्यता का नाम, जिसे Chat API में spaces.members.list तरीके से हासिल किया जा सकता है.

  4. अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:

    python3 chat_membership_update_to_manager_app.py

Chat ऐप्लिकेशन में, स्पेस मैनेजर को सामान्य सदस्य बनाना

ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की अनुमति एक बार लेनी होगी.

एपीआई पासकोड बनाना

डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई के खोज से जुड़े दस्तावेज़ के ऐसे वर्शन का इस्तेमाल करना होगा जो सार्वजनिक तौर पर उपलब्ध न हो. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.

एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
  3. आपको अपनी नई एपीआई कुंजी दिखेगी.
    • अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, एपीआई पासकोड कॉपी करने के लिए, कॉपी करें पर क्लिक करें. एपीआई पासकोड, प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी मिल सकता है.
    • बेहतर सेटिंग अपडेट करने और एपीआई पासकोड के इस्तेमाल को सीमित करने के लिए, पासकोड पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड पर पाबंदियां लगाना लेख पढ़ें.

Chat API को कॉल करने वाली स्क्रिप्ट लिखें

इस उदाहरण में, ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करके, Chat API को कॉल किया गया है. इससे, स्पेस मैनेजर को स्पेस का सामान्य सदस्य बनाया जा सकता है. इसके लिए, body में role को ROLE_MEMBER के तौर पर सेट किया गया है. body में, सदस्यता के अपडेट किए गए एट्रिब्यूट की जानकारी दी गई है:

Python

  1. अपनी वर्किंग डायरेक्ट्री में, chat_membership_update_to_member_app.py नाम की फ़ाइल बनाएं.

  2. 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()

  3. कोड में, इनकी जगह ये डालें:

    • API_KEY: Chat API के लिए सेवा एंडपॉइंट बनाने के लिए, आपने जो एपीआई पासकोड बनाया है.

    • SPACE: स्पेस का नाम, जो आपको Chat API में spaces.list तरीके या स्पेस के यूआरएल से मिल सकता है.

    • MEMBERSHIP: सदस्यता का नाम, जो आपको Chat API में spaces.members.list तरीके से मिल सकता है.

  4. अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:

    python3 chat_membership_update_to_member_app.py

Google Workspace एडमिन के तौर पर सदस्यताएं अपडेट करना

अगर आप Google Workspace एडमिन हैं, तो अपने Google Workspace संगठन के किसी भी स्पेस के लिए सदस्यताओं को अपडेट करने के लिए, update() तरीका अपनाएं.

Google Workspace एडमिन के तौर पर, इस तरीके को कॉल करने के लिए यह तरीका अपनाएं:

  • उपयोगकर्ता की पुष्टि करने के तरीके का इस्तेमाल करके, उस तरीके को कॉल करें. साथ ही, ऐसा अनुमति का दायरा तय करें जिससे एडमिन के अधिकारों का इस्तेमाल करके, उस तरीके को कॉल किया जा सके.
  • अपने अनुरोध में, useAdminAccess से true तक के क्वेरी पैरामीटर की जानकारी दें.

ज़्यादा जानकारी और उदाहरणों के लिए, Google Workspace एडमिन के तौर पर, Google Chat के स्पेस मैनेज करना लेख पढ़ें.