Method: spaces.setup

यह स्पेस बनाता है और उसमें चुने गए उपयोगकर्ताओं को जोड़ता है. कॉल करने वाला उपयोगकर्ता, स्पेस में अपने-आप जुड़ जाता है. इसलिए, अनुरोध में उसे सदस्य के तौर पर नहीं बताया जाना चाहिए. उदाहरण के लिए, शुरुआती सदस्यों के साथ स्पेस सेट अप करना लेख पढ़ें.

जोड़ने के लिए, इंसानों के सदस्यों को तय करने के लिए, सही membership.member.name के साथ सदस्यताएं जोड़ें. किसी व्यक्ति को जोड़ने के लिए, users/{user} का इस्तेमाल करें. यहां {user}, उपयोगकर्ता का ईमेल पता हो सकता है. एक ही Workspace संगठन के उपयोगकर्ताओं के लिए, {user} People API के व्यक्ति के लिए id या Directory API के उपयोगकर्ता के लिए id भी हो सकता है. उदाहरण के लिए, अगर user@example.com के लिए People API की Person प्रोफ़ाइल का आईडी 123456789 है, तो उपयोगकर्ता को स्पेस में जोड़ा जा सकता है. इसके लिए, membership.member.name को users/user@example.com या users/123456789 पर सेट करें.

जोड़ने के लिए Google ग्रुप तय करने के लिए, सही membership.group_member.name के साथ सदस्यताएं जोड़ें. किसी Google ग्रुप को जोड़ने या उसे न्योता भेजने के लिए, groups/{group} का इस्तेमाल करें. यहां {group}, Cloud Identity Groups API से मिले ग्रुप के लिए id है. उदाहरण के लिए, ग्रुप का ईमेल पता group@example.com के लिए आईडी 123456789 को वापस पाने के लिए, Cloud Identity Groups lookup API का इस्तेमाल किया जा सकता है. इसके बाद, membership.group_member.name को groups/123456789 पर सेट करके, ग्रुप को स्पेस में जोड़ा जा सकता है. ग्रुप ईमेल का इस्तेमाल नहीं किया जा सकता. साथ ही, Google ग्रुप को सिर्फ़ नाम वाले स्पेस में सदस्यों के तौर पर जोड़ा जा सकता है.

अगर किसी स्पेस या ग्रुप चैट में कॉल करने वाला व्यक्ति, कुछ सदस्यों को ब्लॉक करता है या उसे कुछ सदस्य ब्लॉक करते हैं या उसके पास कुछ सदस्यों को जोड़ने की अनुमति नहीं है, तो उन सदस्यों को बनाए गए स्पेस में नहीं जोड़ा जाता.

कॉल करने वाले उपयोगकर्ता और किसी दूसरे व्यक्ति के बीच डायरेक्ट मैसेज (डीएम) बनाने के लिए, व्यक्ति को दिखाने के लिए सिर्फ़ एक सदस्यता तय करें. अगर कोई उपयोगकर्ता किसी दूसरे उपयोगकर्ता को ब्लॉक करता है, तो अनुरोध पूरा नहीं होता और डीएम नहीं बनता.

कॉल करने वाले व्यक्ति और कॉल करने वाले ऐप्लिकेशन के बीच डीएम बनाने के लिए, Space.singleUserBotDm को true पर सेट करें. साथ ही, कोई भी सदस्यता तय न करें. इस तरीके का इस्तेमाल सिर्फ़ कॉलिंग ऐप्लिकेशन के साथ डीएम सेट अप करने के लिए किया जा सकता है. कॉलिंग ऐप्लिकेशन को किसी स्पेस या दो लोगों के बीच मौजूद डीएम में सदस्य के तौर पर जोड़ने के लिए, किसी स्पेस में किसी उपयोगकर्ता या ऐप्लिकेशन को न्योता देना या उसे जोड़ना लेख पढ़ें.

अगर दो लोगों के बीच पहले से कोई डीएम मौजूद है, तो अनुरोध किए जाने के समय एक व्यक्ति के दूसरे को ब्लॉक करने पर भी, मौजूदा डीएम वापस आ जाता है.

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

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

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

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

POST https://chat.googleapis.com/v1/spaces:setup

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

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

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
फ़ील्ड
space

object (Space)

ज़रूरी है. Space.spaceType फ़ील्ड को भरना ज़रूरी है.

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

ग्रुप चैट बनाने के लिए, Space.spaceType को GROUP_CHAT पर सेट करें. Space.displayName को सेट न करें.

लोगों के बीच 1:1 बातचीत करने के लिए, Space.spaceType को DIRECT_MESSAGE पर सेट करें और Space.singleUserBotDm को false पर सेट करें. Space.displayName या Space.spaceDetails को सेट न करें.

किसी व्यक्ति और कॉल करने वाले Chat ऐप्लिकेशन के बीच 1:1 बातचीत करने के लिए, Space.spaceType को DIRECT_MESSAGE और Space.singleUserBotDm को true पर सेट करें. Space.displayName या Space.spaceDetails को सेट न करें.

अगर DIRECT_MESSAGE स्पेस पहले से मौजूद है, तो नया स्पेस बनाने के बजाय उसी स्पेस को दिखाया जाता है.
requestId

string

ज़रूरी नहीं. इस अनुरोध के लिए यूनीक आईडी. हमारा सुझाव है कि आप रैंडम यूयूआईडी का इस्तेमाल करें. अनुरोध आईडी तय करने से, अनुरोध आइडेमपोटेंट हो जाता है. इससे यह पक्का होता है कि एक ही अनुरोध आईडी वाले कई एक जैसे अनुरोधों से सिर्फ़ एक स्पेस बनाया जाए. एक ही अनुरोध आईडी के साथ किए गए बाद के अनुरोधों से, मौजूदा स्पेस वापस मिल जाता है. साथ ही, स्पेस अपडेट नहीं होता. भले ही, अनुरोध की गई जानकारी मौजूदा स्थिति से अलग हो.

इस फ़ील्ड का सही तरीके से इस्तेमाल करने के लिए:

  • पक्का करें कि बाद के अनुरोध एक जैसे हों और उनमें पुष्टि करने के लिए वही क्रेडेंशियल इस्तेमाल किए गए हों जो मूल अनुरोध में इस्तेमाल किए गए थे.
  • अगर दिए गए अनुरोध आईडी से कोई स्पेस पहले ही बनाया जा चुका है, तो अनुरोध उस स्पेस को वापस कर देता है. ध्यान दें कि हो सकता है कि लौटाया गया स्पेस पूरी तरह से न भरा गया हो. एपीआई, आपके अनुरोध में मौजूद स्पेस को सिस्टम की ओर से असाइन किए गए संसाधन के नाम के साथ दिखाता है. स्पेस का नया मेटाडेटा पाने के लिए, spaces.get को कॉल करें.
  • पुष्टि किए गए किसी दूसरे उपयोगकर्ता के साथ, मौजूदा अनुरोध आईडी का फिर से इस्तेमाल करने पर गड़बड़ी होती है.
memberships[]

object (Membership)

ज़रूरी नहीं. Google Chat के उन उपयोगकर्ताओं या ग्रुप को चुनें जिन्हें स्पेस में शामिल होने का न्योता भेजना है. कॉल करने वाले व्यक्ति का नाम शामिल न करें, क्योंकि उसे अपने-आप जोड़ दिया जाता है.

फ़िलहाल, इस सेट में कॉल करने वाले व्यक्ति के अलावा, ज़्यादा से ज़्यादा 49 सदस्य शामिल किए जा सकते हैं.

अगर किसी व्यक्ति को सदस्य बनाना है, तो Membership.member फ़ील्ड में user होना चाहिए. साथ ही, name फ़ील्ड में वैल्यू भरी होनी चाहिए (फ़ॉर्मैट: users/{user}) और type फ़ील्ड की वैल्यू User.Type.HUMAN पर सेट होनी चाहिए. स्पेस सेट अप करते समय, सिर्फ़ इंसानों को जोड़ा जा सकता है. Chat ऐप्लिकेशन जोड़ने की सुविधा, सिर्फ़ कॉलिंग ऐप्लिकेशन के साथ डायरेक्ट मैसेज सेट अप करने के लिए उपलब्ध है. उपयोगकर्ता के ईमेल पते को {user} के लिए उपनाम के तौर पर इस्तेमाल करके भी सदस्यों को जोड़ा जा सकता है. उदाहरण के लिए, user.name, users/example@gmail.com हो सकता है. Gmail का इस्तेमाल करने वाले लोगों या Google Workspace के बाहरी डोमेन के उपयोगकर्ताओं को न्योता भेजने के लिए, उपयोगकर्ता के ईमेल पते का इस्तेमाल {user} के लिए किया जाना चाहिए.

Google ग्रुप की सदस्यता के लिए, Membership.group_member फ़ील्ड में group होना चाहिए. साथ ही, name फ़ील्ड में वैल्यू भरी होनी चाहिए (फ़ॉर्मैट groups/{group}). Space.spaceType को SPACE पर सेट करने पर ही, Google ग्रुप जोड़े जा सकते हैं.

Space.spaceType को SPACE पर सेट करते समय, यह एट्रिब्यूट ज़रूरी नहीं है.

Space.spaceType एट्रिब्यूट की वैल्यू GROUP_CHAT पर सेट करने के साथ-साथ, कम से कम दो सदस्यताएं सेट करने पर यह एट्रिब्यूट ज़रूरी है.

किसी व्यक्ति के लिए Space.spaceType को DIRECT_MESSAGE पर सेट करते समय, इस एट्रिब्यूट की वैल्यू देना ज़रूरी है. साथ ही, एक सदस्यता की जानकारी भी देनी होगी.

किसी व्यक्ति और कॉल करने वाले Chat ऐप्लिकेशन के बीच 1:1 बातचीत बनाते समय, यह फ़ील्ड खाली होना चाहिए. ऐसा तब होता है, जब Space.spaceType को DIRECT_MESSAGE और Space.singleUserBotDm को true पर सेट किया जाता है.

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

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

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

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

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

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