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,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
फ़ील्ड
name

string

स्पेस में मौजूद संसाधन का नाम.

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

type
(deprecated)

enum (Type)

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

spaceType

enum (SpaceType)

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

singleUserBotDm

boolean

ज़रूरी नहीं. क्या स्पेस, Chat ऐप्लिकेशन और किसी एक इंसान के बीच का कोई डायरेक्ट मैसेज है.

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 पर सेट होती है.

lastActiveTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. स्पेस में, आखिरी मैसेज का टाइमस्टैंप.

adminInstalled

boolean

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

एडमिन इंस्टॉल करने की सुविधा देने के लिए, आपके Chat ऐप्लिकेशन में डायरेक्ट मैसेज की सुविधा होनी चाहिए.

membershipCount

object (MembershipCount)

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

accessSettings

object (AccessSettings)

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

spaceUri

string

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

यूनियन फ़ील्ड space_permission_settings. यह किसी स्पेस की अनुमति की सेटिंग दिखाता है. space_type के SPACE होने पर ही जानकारी अपने-आप भर जाती है. space_permission_settings इनमें से सिर्फ़ एक हो सकता है:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

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

permissionSettings

object (PermissionSettings)

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

टाइप

अब काम नहीं करता: इसके बजाय, 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 के निजी डेटा के रखरखाव के नियम से पता चलता है कि मैसेज और थ्रेड को कितने समय तक रखा जाएगा.

MembershipCount

इससे किसी स्पेस में मौजूद सदस्यों की संख्या के बारे में पता चलता है. इसके लिए, इन सदस्यों को कैटगरी में बांटा जाता है.

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

integer

ऐसे लोगों की संख्या जो स्पेस में सीधे तौर पर शामिल हुए हैं. हालांकि, इसमें उन लोगों की गिनती नहीं की जाती है जो किसी ग्रुप में शामिल होने के बाद स्पेस में शामिल होते हैं.

joinedGroupCount

integer

स्पेस में सीधे तौर पर शामिल होने वाले सभी ग्रुप की संख्या.

AccessSettings

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

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

enum (AccessState)

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

audience

string

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

AccessState

इससे स्पेस का ऐक्सेस मिलता है.

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

PredefinedPermissionSettings

स्पेस की अनुमति से जुड़ी सेटिंग. इन्हें नाम वाला स्पेस बनाते समय तय किया जा सकता है. आने वाले समय में, और भी सेटिंग जोड़ी जा सकती हैं. नाम वाले स्पेस के लिए अनुमति की सेटिंग के बारे में जानने के लिए, स्पेस के बारे में जानें लेख पढ़ें.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED नहीं बताया गया है इस्तेमाल न करें.
COLLABORATION_SPACE स्पेस को दूसरों के साथ मिलकर काम करने के लिए बनाए जाने वाले स्पेस के तौर पर सेट किया जा रहा है, जहां सभी सदस्य मैसेज पोस्ट कर सकते हैं.
ANNOUNCEMENT_SPACE इस स्पेस को सूचना ब्रॉडकास्ट करने के लिए सेट किया गया है. इसमें स्पेस मैनेजर ही मैसेज पोस्ट कर सकते हैं.

PermissionSettings

नाम वाले स्पेस के लिए, अनुमति की सेटिंग. स्पेस बनाते समय अनुमति की सेटिंग को सेट करने के लिए, अपने अनुरोध में PredefinedPermissionSettings फ़ील्ड के बारे में बताएं.

जेएसओएन के काेड में दिखाना
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
फ़ील्ड
manageMembersAndGroups

object (PermissionSetting)

स्पेस में सदस्यों और ग्रुप को मैनेज करने की सेटिंग.

modifySpaceDetails

object (PermissionSetting)

स्पेस का नाम, अवतार, ब्यौरा, और दिशा-निर्देशों को अपडेट करने के लिए सेटिंग.

toggleHistory

object (PermissionSetting)

स्पेस के इतिहास को चालू और बंद करने की सेटिंग.

useAtMentionAll

object (PermissionSetting)

स्पेस में @all का इस्तेमाल करने की सेटिंग.

manageApps

object (PermissionSetting)

स्पेस में ऐप्लिकेशन मैनेज करने की सेटिंग.

manageWebhooks

object (PermissionSetting)

स्पेस में वेबहुक मैनेज करने की सेटिंग.

postMessages

object (PermissionSetting)

सिर्फ़ आउटपुट के लिए. स्पेस में मैसेज पोस्ट करने की सेटिंग.

replyMessages

object (PermissionSetting)

स्पेस में मैसेज का जवाब देने के लिए सेटिंग.

PermissionSetting

यह स्पेस की अनुमति की सेटिंग दिखाता है.

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

boolean

स्पेस के मैनेजर के पास यह अनुमति है या नहीं.

membersAllowed

boolean

क्या नॉन-मैनेजर सदस्यों के पास यह अनुमति है.

तरीके

completeImport

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

create

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

delete

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

findDirectMessage

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

get

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

list

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

patch

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

setup

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