Method: spaces.patch

इस तरीके का इस्तेमाल करके, किसी स्पेस को अपडेट किया जा सकता है. उदाहरण के लिए, स्पेस अपडेट करना लेख पढ़ें.

अगर आपको displayName फ़ील्ड अपडेट करते समय, गड़बड़ी का मैसेज ALREADY_EXISTS मिलता है, तो कोई दूसरा डिसप्ले नेम आज़माएं.. ऐसा हो सकता है कि Google Workspace संगठन के किसी मौजूदा स्पेस में पहले से ही इस डिसप्ले नेम का इस्तेमाल किया जा रहा हो.

इन तरह के authentication का इस्तेमाल किया जा सकता है:

  • ऐप्लिकेशन की पुष्टि के लिए, एडमिन की मंज़ूरी और यहां दिए गए किसी एक ऑथराइज़ेशन स्कोप का इस्तेमाल किया जाता है:

    • https://www.googleapis.com/auth/chat.app.spaces

  • उपयोगकर्ता की पुष्टि, अनुमति के इन स्कोप में से किसी एक के साथ:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (सिर्फ़ इंपोर्ट मोड वाले स्पेस)
    • उपयोगकर्ता की पुष्टि करने पर, एडमिन के अधिकारों का इस्तेमाल किया जा सकता है. इसके लिए, एडमिन खाते की पुष्टि होनी चाहिए, useAdminAccess true होना चाहिए, और अनुमति के इन स्कोप का इस्तेमाल किया जाना चाहिए:
      • https://www.googleapis.com/auth/chat.admin.spaces

ऐप्लिकेशन की पुष्टि करने की सुविधा पर ये सीमाएं लागू होती हैं:

  • space.predefined_permission_settings या space.permission_settings को अपडेट करने के लिए, ऐप्लिकेशन को स्पेस बनाने वाला होना चाहिए.
  • ऐप्लिकेशन की पुष्टि करने के लिए, space.access_settings.audience को अपडेट नहीं किया जा सकता.

एचटीटीपी अनुरोध

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
space.name

string

आइडेंटिफ़ायर. स्पेस का संसाधन नाम.

फ़ॉर्मैट: spaces/{space}

यहां {space}, स्पेस के लिए सिस्टम की ओर से असाइन किया गया आईडी दिखाता है. स्पेस का आईडी पाने के लिए, spaces.list() तरीके को कॉल करें या स्पेस के यूआरएल से आईडी पाएं. उदाहरण के लिए, अगर स्पेस का यूआरएल https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA है, तो स्पेस का आईडी AAAAAAAAA होगा.

क्वेरी पैरामीटर

पैरामीटर
updateMask

string (FieldMask format)

ज़रूरी है. अपडेट किए गए फ़ील्ड के पाथ. अगर एक से ज़्यादा फ़ील्ड हैं, तो उन्हें कॉमा से अलग करें.

किसी स्पेस के लिए, इन फ़ील्ड को अपडेट किया जा सकता है:

spaceDetails: इससे स्पेस के ब्यौरे और दिशा-निर्देशों को अपडेट किया जाता है. आपको अपडेट के अनुरोध में, ब्यौरे और दिशा-निर्देश, दोनों को SpaceDetails के तौर पर पास करना होगा. अगर आपको सिर्फ़ एक फ़ील्ड अपडेट करना है, तो दूसरे फ़ील्ड के लिए मौजूदा वैल्यू पास करें.

displayName: यह सुविधा सिर्फ़ उन स्पेस के लिए उपलब्ध है जहां spaceType फ़ील्ड SPACE है. अगर आपको गड़बड़ी का मैसेज ALREADY_EXISTS मिलता है, तो कोई दूसरी वैल्यू आज़माएं. ऐसा हो सकता है कि Google Workspace संगठन के किसी मौजूदा स्पेस में पहले से ही इस डिसप्ले नेम का इस्तेमाल किया जा रहा हो.

spaceType: सिर्फ़ GROUP_CHAT स्पेस टाइप को SPACE में बदला जा सकता है. अपडेट मास्क में spaceType के साथ displayName को शामिल करें. साथ ही, पक्का करें कि तय की गई जगह का डिसप्ले नेम खाली न हो और वह SPACE स्पेस टाइप का हो. डिसप्ले नेम अपडेट करते समय, तय किए गए स्पेस में spaceType मास्क और SPACE टाइप शामिल करना ज़रूरी नहीं है. ऐसा तब होता है, जब मौजूदा स्पेस में पहले से ही SPACE टाइप मौजूद हो. स्पेस के टाइप को अपडेट करने के अन्य तरीकों से, अमान्य तर्क से जुड़ी गड़बड़ी होती है. useAdminAccess के साथ spaceType का इस्तेमाल नहीं किया जा सकता.

spaceHistoryState: स्पेस के लिए, इतिहास की सुविधा चालू या बंद करके, स्पेस के इतिहास की सेटिंग अपडेट करता है. इस सुविधा का इस्तेमाल सिर्फ़ तब किया जा सकता है, जब Google Workspace संगठन के लिए इतिहास की सेटिंग चालू हों. स्पेस के इतिहास की स्थिति को अपडेट करने के लिए, आपको अपने अनुरोध में अन्य सभी फ़ील्ड मास्क हटाने होंगे. useAdminAccess के साथ spaceHistoryState का इस्तेमाल नहीं किया जा सकता.

accessSettings.audience: इससे यह अपडेट होता है कि स्पेस को कौन ढूंढ सकता है, स्पेस में कौन शामिल हो सकता है, और स्पेस में मौजूद मैसेज का पूर्वावलोकन कौन कर सकता है. यह अपडेट, स्पेस के लिए ऐक्सेस सेटिंग में होता है. इस स्पेस में spaceType फ़ील्ड की वैल्यू SPACE होती है. अगर मौजूदा स्पेस में टारगेट ऑडियंस है, तो ऑडियंस को हटाया जा सकता है. साथ ही, इस फ़ील्ड मास्क के लिए वैल्यू छोड़कर, स्पेस के ऐक्सेस को सीमित किया जा सकता है. किसी स्पेस के लिए ऐक्सेस सेटिंग अपडेट करने के लिए, पुष्टि करने वाले उपयोगकर्ता का स्पेस मैनेजर होना ज़रूरी है. साथ ही, उसे अपने अनुरोध में अन्य सभी फ़ील्ड मास्क हटाने होंगे. अगर स्पेस इंपोर्ट मोड में है, तो इस फ़ील्ड को अपडेट नहीं किया जा सकता. ज़्यादा जानने के लिए, स्पेस को चुनिंदा उपयोगकर्ताओं के लिए उपलब्ध कराना लेख पढ़ें. useAdminAccess के साथ accessSettings.audience का इस्तेमाल नहीं किया जा सकता.

accessSettings.access_permission_settings: इससे ऐक्सेस करने की अनुमति से जुड़ी सेटिंग अपडेट होती हैं. इससे यह तय होता है कि spaceType फ़ील्ड के SPACE होने पर, कौन स्पेस को ढूंढ सकता है और उसमें शामिल हो सकता है. जिन प्रिंसिपल को स्पेस में शामिल होने की अनुमति है उन्हें स्पेस ढूंढने की अनुमति भी होनी चाहिए. किसी स्पेस के लिए, ऐक्सेस करने की अनुमति से जुड़ी सेटिंग अपडेट करने के लिए, पुष्टि करने वाले उपयोगकर्ता का स्पेस मैनेजर या असिस्टेंट मैनेजर होना ज़रूरी है. साथ ही, उसे अनुरोध में अन्य सभी फ़ील्ड मास्क हटाने होंगे. अगर स्पेस इंपोर्ट मोड में है, तो इस फ़ील्ड को अपडेट नहीं किया जा सकता. ज़्यादा जानने के लिए, स्पेस को चुनिंदा उपयोगकर्ताओं के लिए उपलब्ध कराना लेख पढ़ें. useAdminAccess के साथ accessSettings.access_permission_settings का इस्तेमाल नहीं किया जा सकता. इन फ़ील्ड मास्क का इस्तेमाल किया जा सकता है:

  • accessSettings.access_permission_settings.discoverSpaceSetting
  • accessSettings.access_permission_settings.joinSpaceSetting
  • accessSettings.access_permission_settings.viewSpaceMembershipSetting

permissionSettings: इससे स्पेस की अनुमति की सेटिंग बदली जा सकती हैं. अनुमति की सेटिंग अपडेट करते समय, सिर्फ़ permissionSettings फ़ील्ड मास्क तय किए जा सकते हैं. एक ही समय में अन्य फ़ील्ड मास्क अपडेट नहीं किए जा सकते. इन फ़ील्ड मास्क का इस्तेमाल किया जा सकता है:

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
  • permissionSettings.viewSpaceMembership
useAdminAccess

boolean

ज़रूरी नहीं. true होने पर, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के अधिकारों का इस्तेमाल करके काम करता है.

कॉल करने वाला व्यक्ति, Google Workspace एडमिन होना चाहिए. साथ ही, उसके पास चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

इसके लिए, chat.admin.spaces OAuth 2.0 स्कोप की ज़रूरत होती है.

एडमिन ऐक्सेस का इस्तेमाल करके, FieldMask की कुछ वैल्यू सेट नहीं की जा सकतीं. ज़्यादा जानकारी के लिए, updateMask का ब्यौरा देखें.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य भाग में Space का उदाहरण है.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में Space का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.