Method: spaces.setup

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

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

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

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

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

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

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

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

उपयोगकर्ता की पुष्टि ज़रूरी है.

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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 के ऐसे उपयोगकर्ता या ग्रुप जिन्हें स्पेस में शामिल होने का न्योता भेजना है. कॉल करने वाले उपयोगकर्ता को शामिल न करें, क्योंकि वह अपने-आप जुड़ जाता है.

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

लोगों के लिए, 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

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