REST Resource: spaces

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

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

JSON के काेड में दिखाना 
{
  "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,
  "importModeExpireTime": string,
  "customer": 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}

यहां {space}, स्पेस के लिए सिस्टम से असाइन किया गया आईडी दिखाता है. spaces.list() तरीके को कॉल करके या स्पेस के यूआरएल से स्पेस आईडी पाया जा सकता है. उदाहरण के लिए, अगर स्पेस का यूआरएल https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA है, तो स्पेस का आईडी AAAAAAAAA होगा.
type
(deprecated)

enum (Type)

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

enum (SpaceType)

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

boolean

ज़रूरी नहीं. क्या स्पेस, Chat ऐप्लिकेशन और किसी व्यक्ति के बीच का डीएम है.
threaded
(deprecated)

boolean

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

string

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

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

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

boolean

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

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

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

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

ज़रूरी नहीं. इस स्पेस में मौजूद मैसेज और थ्रेड के लिए, मैसेज के इतिहास की स्थिति.
importMode

boolean

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

Import Mode में स्पेस बनाने के लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है.
createTime

string (Timestamp format)

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

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

यह फ़ील्ड, आउटपुट में सिर्फ़ तब दिखता है, जब spaceType की वैल्यू GROUP_CHAT या SPACE हो.
lastActiveTime

string (Timestamp format)

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

boolean

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

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

object (MembershipCount)

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

object (AccessSettings)

ज़रूरी नहीं. इससे स्पेस की ऐक्सेस सेटिंग के बारे में पता चलता है. यह फ़ील्ड तब ही दिखता है, जब spaceType SPACE हो.
spaceUri

string

सिर्फ़ आउटपुट के लिए. किसी उपयोगकर्ता के लिए, स्पेस को ऐक्सेस करने का यूआरआई.
importModeExpireTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब इंपोर्ट मोड में रहने पर, सिस्टम स्पेस को अपने-आप मिटा देगा.

इंपोर्ट मोड में बनाए गए हर स्पेस को, इस समयसीमा के खत्म होने से पहले spaces.completeImport का इस्तेमाल करके इस मोड से बाहर निकलना होगा.

यह फ़ील्ड सिर्फ़ उन स्पेस के लिए भरा जाता है जिन्हें इंपोर्ट मोड से बनाया गया था.
customer

string

ज़रूरी नहीं. इम्यूटेबल. स्पेस के डोमेन का ग्राहक आईडी. इसकी ज़रूरत सिर्फ़ तब होती है, जब ऐप्लिकेशन की पुष्टि करके स्पेस बनाया जा रहा हो और SpaceType SPACE हो. ऐसा न होने पर, इसे सेट नहीं किया जाना चाहिए.

यह customers/{customer} फ़ॉर्मैट में होता है. यहां customer, Admin SDK customer resource का id होता है. प्राइवेट ऐप्लिकेशन भी customers/my_customer उपनाम का इस्तेमाल करके, ऐप्लिकेशन के Google Workspace संगठन में स्पेस बना सकते हैं.

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

enum (PredefinedPermissionSettings)

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

अनुमति की पहले से तय की गई सेटिंग के साथ ये काम किए जा सकते हैं:
permissionSettings

object (PermissionSettings)

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

अनुमति की सेटिंग को पढ़ने और अपडेट करने की सुविधा इनके साथ काम करती है:

टाइप

इस्तेमाल बंद कर दिया गया है: इसके बजाय, SpaceType का इस्तेमाल करें.

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

SpaceType

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

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

SpaceThreadingState

Chat स्पेस में थ्रेडिंग की स्थिति के बारे में बताता है.

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

SpaceDetails

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

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

string

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

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

string

ज़रूरी नहीं. स्पेस के नियम, उम्मीदें, और शिष्टाचार.

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

HistoryState

मैसेज और स्पेस के इतिहास की स्थिति. इससे यह तय होता है कि मैसेज और बातचीत की थ्रेड को बनाने के बाद कितने समय तक सेव रखा जाता है.

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

MembershipCount

यह स्पेस की सदस्यता की संख्या दिखाता है. इसे कैटगरी के हिसाब से ग्रुप किया जाता है.

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

integer

सिर्फ़ आउटपुट के लिए. उन उपयोगकर्ताओं की संख्या जो सीधे तौर पर स्पेस में शामिल हुए हैं. इसमें उन उपयोगकर्ताओं को शामिल नहीं किया जाता जो किसी ग्रुप की सदस्यता लेकर स्पेस में शामिल हुए हैं.
joinedGroupCount

integer

सिर्फ़ आउटपुट के लिए. उन सभी ग्रुप की संख्या जिन्होंने सीधे तौर पर स्पेस में शामिल होने का अनुरोध किया है.

AccessSettings

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

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

enum (AccessState)

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

string

ज़रूरी नहीं. टारगेट ऑडियंस का संसाधन नाम. इस ऑडियंस के पास स्पेस को ढूंढने, उसमें शामिल होने, और स्पेस में मौजूद मैसेज की झलक देखने का विकल्प होता है. अगर यह विकल्प सेट नहीं किया जाता है, तो सिर्फ़ वे उपयोगकर्ता या Google ग्रुप स्पेस को ऐक्सेस कर सकते हैं जिन्हें स्पेस में शामिल होने का न्योता दिया गया है या जोड़ा गया है. ज़्यादा जानकारी के लिए, किसी स्पेस को टारगेट ऑडियंस के लिए उपलब्ध कराना लेख पढ़ें.

फ़ॉर्मैट: audiences/{audience}

Google Workspace संगठन के लिए डिफ़ॉल्ट टारगेट ऑडियंस का इस्तेमाल करने के लिए, इसे audiences/default पर सेट करें.

टारगेट ऑडियंस की जानकारी पढ़ने से ये काम किए जा सकते हैं:

ऐप्लिकेशन की पुष्टि करने के लिए, chat.bot स्कोप का इस्तेमाल करने पर इस फ़ील्ड में जानकारी नहीं भरी जाती.

टारगेट ऑडियंस सेट करने के लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है.

AccessState

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

Enums
ACCESS_STATE_UNSPECIFIED ऐक्सेस की स्थिति के बारे में जानकारी नहीं है या यह इस एपीआई में काम नहीं करती.
PRIVATE सिर्फ़ वे उपयोगकर्ता या Google ग्रुप स्पेस को ढूंढकर ऐक्सेस कर सकते हैं जिन्हें अन्य उपयोगकर्ताओं या Google Workspace एडमिन ने स्पेस में जोड़ा है या उसमें शामिल होने का न्योता भेजा है.
DISCOVERABLE

स्पेस मैनेजर ने टारगेट ऑडियंस को स्पेस का ऐक्सेस दिया हो. जिन उपयोगकर्ताओं या Google ग्रुप को स्पेस में अलग-अलग तौर पर जोड़ा गया है या शामिल होने का न्योता दिया गया है वे भी स्पेस को ढूंढ सकते हैं और उसे ऐक्सेस कर सकते हैं. ज़्यादा जानने के लिए, स्पेस को कुछ उपयोगकर्ताओं के लिए खोज नतीजों में दिखने की सुविधा चालू करना लेख पढ़ें.

संगठन के सभी सदस्यों के लिए स्पेस बनाने के लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है.

PredefinedPermissionSettings

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

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

PermissionSettings

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

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

JSON के काेड में दिखाना 
{
  "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

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

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

boolean

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

boolean

ज़रूरी नहीं. मैनेजर की भूमिका के अलावा अन्य भूमिका वाले सदस्यों के पास यह अनुमति है या नहीं.

तरीके

completeImport

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

create

 स्पेस बनाता है.

delete

 इस तरीके का इस्तेमाल करके, नाम वाला स्पेस मिटाया जाता है.

findDirectMessage

 यह फ़ंक्शन, चुने गए उपयोगकर्ता के साथ मौजूद डायरेक्ट मैसेज दिखाता है.

get

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

list

 इससे उन स्पेस की सूची मिलती है जिनमें कॉल करने वाला व्यक्ति शामिल है.

patch

 किसी स्पेस को अपडेट करता है.
यह फ़ंक्शन, एडमिन की खोज के आधार पर Google Workspace संगठन में मौजूद स्पेस की सूची दिखाता है.

setup

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