REST Resource: spaces

संसाधन: स्पेस

Google Chat में स्पेस. स्पेस, दो या दो से ज़्यादा उपयोगकर्ताओं के बीच होने वाली बातचीत या उपयोगकर्ता और Chat ऐप्लिकेशन के बीच 1:1 मैसेज होते हैं.

जेएसओएन के काेड में दिखाना
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
फ़ील्ड
name

string

स्पेस के संसाधन का नाम.

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

type
(deprecated)

enum (Type)

सिर्फ़ आउटपुट के लिए. अब काम नहीं करता: इसके बजाय spaceType का इस्तेमाल करें. स्पेस का टाइप.

spaceType

enum (SpaceType)

स्पेस किस तरह का है. स्पेस बनाते समय या उसका टाइप अपडेट करते समय ज़रूरी है. सिर्फ़ अन्य इस्तेमाल के लिए आउटपुट.

singleUserBotDm

boolean

ज़रूरी नहीं. क्या चैट ऐप्लिकेशन और एक इंसान के बीच DM है.

threaded
(deprecated)

boolean

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

displayName

string

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

डायरेक्ट मैसेज के लिए, यह फ़ील्ड खाली हो सकता है.

इसमें 128 वर्ण इस्तेमाल किए जा सकते हैं.

externalUserAllowed

boolean

इम्यूटेबल. क्या इस स्पेस में, Google Chat इस्तेमाल करने वाले किसी भी व्यक्ति को सदस्य के तौर पर शामिल किया जा सकता है. Google Workspace का इस्तेमाल करने वाले संगठन में स्पेस बनाते समय इनपुट दें. इन स्थितियों में स्पेस बनाते समय इस फ़ील्ड को छोड़ दें:

  • प्रमाणित उपयोगकर्ता, उपभोक्ता खाते (मैनेज नहीं किया जा रहा उपयोगकर्ता खाता) का इस्तेमाल करता है. उपभोक्ता खाते से बनाए गए स्पेस में, डिफ़ॉल्ट रूप से Google Chat का कोई भी उपयोगकर्ता इस्तेमाल कर सकता है.

  • स्पेस का इस्तेमाल Google Chat में डेटा इंपोर्ट करने के लिए किया जाता है. ऐसा इसलिए, क्योंकि स्पेस में इंपोर्ट मोड का इस्तेमाल सिर्फ़ अपने Google Workspace संगठन के सदस्यों को अनुमति देने के लिए किया जाता है. हालांकि, Google Workspace Developer Preview Program के हिस्से के तौर पर, इंपोर्ट मोड स्पेस का इस्तेमाल करके, Google Chat का कोई भी उपयोगकर्ता इस फ़ील्ड को इंपोर्ट कर सकता है. ऐसा करने पर, इस फ़ील्ड को इंपोर्ट मोड के स्पेस के लिए सेट किया जा सकता है.

मौजूदा स्पेस के लिए, यह फ़ील्ड सिर्फ़ आउटपुट के तौर पर इस्तेमाल होता है.

spaceThreadingState

enum (SpaceThreadingState)

सिर्फ़ आउटपुट के लिए. चैट स्पेस में थ्रेड की स्थिति.

spaceDetails

object (SpaceDetails)

स्पेस का ब्यौरा, जिसमें उसका ब्यौरा और नियम शामिल हैं.

spaceHistoryState

enum (HistoryState)

इस स्पेस में मैसेज और थ्रेड के लिए, मैसेज के इतिहास की स्थिति.

importMode

boolean

ज़रूरी नहीं. Import Mode में यह स्पेस, Google Workspace में डेटा माइग्रेशन के हिस्से के तौर पर बनाया गया है या नहीं. स्पेस इंपोर्ट होने के दौरान, उपयोगकर्ताओं को वे तब तक नहीं दिखेंगे, जब तक इंपोर्ट पूरा नहीं हो जाता.

createTime

string (Timestamp format)

ज़रूरी नहीं. इम्यूटेबल. Chat में बनाए गए स्पेस के हिसाब से, स्पेस बनाए जाने का समय. यह फ़ील्ड सिर्फ़ आउटपुट के लिए है. हालांकि, इसे इंपोर्ट मोड वाले स्पेस में इस्तेमाल करने पर ही इस्तेमाल किया जा सकता है.

इंपोर्ट मोड वाले स्पेस के लिए, इस फ़ील्ड को उस पुराने टाइमस्टैंप पर सेट करें जिस पर सोर्स में स्पेस बनाया गया था. इससे मूल समय को सुरक्षित रखा जा सकता है.

आउटपुट में सिर्फ़ तब अपने-आप जानकारी भर जाती है, जब spaceType, GROUP_CHAT या SPACE हो.

adminInstalled

boolean

सिर्फ़ आउटपुट के लिए. Google Workspace एडमिन ने Chat ऐप्लिकेशन इंस्टॉल किया है या नहीं. एडमिन अपने डोमेन, संगठन की इकाई या उपयोगकर्ताओं के ग्रुप के लिए, Chat ऐप्लिकेशन इंस्टॉल कर सकते हैं.

एडमिन, उपयोगकर्ताओं और उनके बीच डायरेक्ट मैसेज भेजने के लिए सिर्फ़ Chat ऐप्लिकेशन इंस्टॉल कर सकते हैं. एडमिन इंस्टॉल की सुविधा देने के लिए, आपके ऐप्लिकेशन में डायरेक्ट मैसेज की सुविधा होनी चाहिए.

accessSettings

object (AccessSettings)

ज़रूरी नहीं. स्पेस की ऐक्सेस सेटिंग तय करती है. सिर्फ़ तब अपने-आप जानकारी भर जाती है, जब spaceType, SPACE हो.

spaceUri

string

सिर्फ़ आउटपुट के लिए. स्पेस का यूआरआई.

टाइप

अब काम नहीं करता: इसके बजाय SpaceType का इस्तेमाल करें.

Enums
TYPE_UNSPECIFIED रिज़र्व किया गया.
ROOM दो या दो से ज़्यादा लोगों के बीच बातचीत.
DM किसी व्यक्ति और Chat ऐप्लिकेशन के बीच 1:1 डायरेक्ट मैसेज, जिसमें किसी भी तरह का मैसेज बिना किसी रुकावट के दिखे. ध्यान दें कि इसमें दो लोगों के बीच के डायरेक्ट मैसेज शामिल नहीं हैं.

SpaceType

स्पेस किस तरह का है. स्पेस बनाते या अपडेट करते समय ज़रूरी है. सिर्फ़ अन्य इस्तेमाल के लिए आउटपुट.

Enums
SPACE_TYPE_UNSPECIFIED रिज़र्व किया गया.
SPACE वह जगह जहां लोग मैसेज भेजते हैं, फ़ाइलें शेयर करते हैं, और साथ मिलकर काम कर सकते हैं. SPACE में चैट ऐप्लिकेशन शामिल हो सकते हैं.
GROUP_CHAT तीन या उससे ज़्यादा लोगों के बीच ग्रुप बातचीत. GROUP_CHAT में चैट ऐप्लिकेशन शामिल हो सकते हैं.
DIRECT_MESSAGE एक Chat ऐप्लिकेशन और दो लोगों या एक इंसान के बीच 1:1 मैसेज.

SpaceThreadingState

इससे पता चलता है कि चैट स्पेस में थ्रेडिंग की स्थिति किस तरह की है.

Enums
SPACE_THREADING_STATE_UNSPECIFIED रिज़र्व किया गया.
THREADED_MESSAGES नाम वाले ऐसे स्पेस जिनमें मैसेज थ्रेड काम करती हैं. जब उपयोगकर्ता किसी मैसेज का जवाब देते हैं, तो वे थ्रेड में जवाब दे सकते हैं. इससे उनका जवाब मूल मैसेज के हिसाब से बना रहता है.
GROUPED_MESSAGES नाम वाले वे स्पेस जहां बातचीत को विषय के हिसाब से व्यवस्थित किया जाता है. विषयों और उन पर आने वाले जवाबों को एक साथ रखा जाता है.
UNTHREADED_MESSAGES दो लोगों के बीच डायरेक्ट मैसेज (DM) और तीन या उससे ज़्यादा लोगों के बीच ग्रुप बातचीत.

SpaceDetails

स्पेस का ब्यौरा, जिसमें उसका ब्यौरा और नियम शामिल हैं.

जेएसओएन के काेड में दिखाना
{
  "description": string,
  "guidelines": string
}
फ़ील्ड
description

string

ज़रूरी नहीं. स्पेस का ब्यौरा. उदाहरण के लिए, स्पेस के विषय, उसके काम करने के मकसद या उसमें हिस्सा लेने वाले लोगों के बारे में बताएं.

इसमें 150 वर्ण इस्तेमाल किए जा सकते हैं.

guidelines

string

ज़रूरी नहीं. स्पेस के नियम, उम्मीदें, और बर्ताव.

इसमें ज़्यादा से ज़्यादा 5,000 वर्ण इस्तेमाल किए जा सकते हैं.

HistoryState

मैसेज और स्पेस के इतिहास की स्थिति. इस नीति से पता चलता है कि मैसेज और बातचीत की थ्रेड बनाए जाने के बाद, उन्हें कितने समय तक रखा जाएगा.

Enums
HISTORY_STATE_UNSPECIFIED डिफ़ॉल्ट मान. इस्तेमाल न करें.
HISTORY_OFF इतिहास बंद है. मैसेज और थ्रेड 24 घंटे तक सेव रखी जाती हैं.
HISTORY_ON इतिहास चालू है. संगठन के Vault के निजी डेटा के रखरखाव के नियमों से यह तय होता है कि मैसेज और थ्रेड को कितने समय तक सेव रखा जाएगा.

AccessSettings

स्पेस की ऐक्सेस सेटिंग दिखाती है.

जेएसओएन के काेड में दिखाना
{
  "accessState": enum (AccessState),
  "audience": string
}
फ़ील्ड
accessState

enum (AccessState)

सिर्फ़ आउटपुट के लिए. स्पेस के ऐक्सेस की स्थिति के बारे में बताता है.

audience

string

ज़रूरी नहीं. टारगेट ऑडियंस के संसाधन का नाम जो स्पेस को ऐक्सेस कर सकता है. स्पेस को खोजने लायक बनाने के लिए, इस फ़ील्ड को सही टारगेट ऑडियंस आईडी पर सेट करें. इसके अलावा, Admin console में डिफ़ॉल्ट ऐक्सेस सेटिंग के साथ स्पेस को सेट करने के लिए, audiences/default उपनाम का इस्तेमाल करें. ज़्यादा जानने के लिए, टारगेट ऑडियंस के लिए स्पेस को खोजने लायक बनाना लेख पढ़ें. स्पेस का ऐक्सेस सीमित करने के लिए, इस फ़ील्ड को अनसेट करें. सिर्फ़ तब जानकारी अपने-आप भर जाती है, जब स्पेस को संगठन के सभी सदस्यों के साथ शेयर किया जा सकता है. फ़ॉर्मैट: audiences/{audience}, audiences/default का इस्तेमाल, Chat की डिफ़ॉल्ट शेयर करने की सेटिंग के उपनाम के तौर पर किया जा सकता है.

AccessState

यह स्पेस के ऐक्सेस की स्थिति के बारे में बताता है.

Enums
ACCESS_STATE_UNSPECIFIED इस एपीआई में, ऐक्सेस की स्थिति की जानकारी नहीं है या काम नहीं करता.
PRIVATE स्पेस को, जोड़े गए या न्योता पाने वाले सदस्य या ग्रुप ही खोज सकते हैं.
DISCOVERABLE स्पेस को सिर्फ़ चुने गए टारगेट ऑडियंस लोग ही खोज सकते हैं. साथ ही, इसे स्पेस में जोड़े गए या न्योता पाने वाले सदस्य या ग्रुप भी खोज सकते हैं.

तरीके

completeImport

तय किए गए स्पेस के लिए इंपोर्ट प्रोसेस को पूरा करता है और उपयोगकर्ताओं को दिखाता है.

create

नाम वाला स्पेस बनाता है.

delete

नाम वाले स्पेस को मिटाता है.

findDirectMessage

खास उपयोगकर्ता के लिए मौजूदा डायरेक्ट मैसेज दिखाता है.

get

किसी स्पेस की जानकारी दिखाता है.

list

यह उन स्पेस की जानकारी देता है जिनका कॉल करने वाले व्यक्ति ने सदस्यता ली है.

patch

स्पेस को अपडेट करता है.

setup

स्पेस बनाता है और उसमें चुनिंदा उपयोगकर्ताओं को जोड़ता है.