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,
  "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

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

customer

string

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

customers/{customer} फ़ॉर्मैट में, जहां customer, [एडमिन SDK के ग्राहक संसाधन]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) का id है. निजी ऐप्लिकेशन भी उसी Google Workspace संगठन में स्पेस बनाने के लिए customers/my_customer उपनाम का इस्तेमाल कर सकते हैं जिसमें यह ऐप्लिकेशन मौजूद है.

डीएम के लिए, इस फ़ील्ड में अपने-आप जानकारी नहीं भरती.

यूनियन फ़ील्ड 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 में चैट ऐप्लिकेशन शामिल हो सकते हैं.
GROUP_CHAT तीन या उससे ज़्यादा लोगों के बीच की ग्रुप बातचीत. GROUP_CHAT में चैट ऐप्लिकेशन शामिल हो सकते हैं.
DIRECT_MESSAGE दो लोगों के बीच या किसी व्यक्ति और Chat ऐप्लिकेशन के बीच 1:1 मैसेज.

SpaceThreadingState

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

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

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