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

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

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

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

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

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

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

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

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

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