Method: spaces.setup

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

जोड़ने के लिए लोगों के नाम बताने के लिए, सही membership.member.name के साथ सदस्यताएं जोड़ें. किसी व्यक्ति को जोड़ने के लिए, users/{user} का इस्तेमाल करें. यहां {user}, उपयोगकर्ता का ईमेल पता हो सकता है. एक ही Workspace संगठन के उपयोगकर्ताओं के लिए, {user}, People API में मौजूद व्यक्ति के लिए id या Directory API में मौजूद उपयोगकर्ता के लिए id भी हो सकता है. उदाहरण के लिए, अगर user@example.com के लिए People API का व्यक्तिगत प्रोफ़ाइल आईडी 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

ज़रूरी नहीं. इस अनुरोध के लिए यूनीक आइडेंटिफ़ायर. हमारा सुझाव है कि आप कोई रैंडम यूयूआईडी डालें. किसी मौजूदा अनुरोध आईडी की जानकारी देने पर, नया स्पेस बनाने के बजाय उस आईडी से बनाया गया स्पेस दिखता है. पुष्टि किए गए किसी दूसरे उपयोगकर्ता के साथ, उसी Chat ऐप्लिकेशन से मौजूदा अनुरोध आईडी डालने पर, गड़बड़ी का मैसेज दिखता है.
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

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