Method: spaces.list

उन स्पेस की सूची बनाता है जिनका सदस्य कॉलर है. पहला मैसेज भेजे जाने तक, ग्रुप चैट और डायरेक्ट मैसेज की सूची नहीं दिखाई जाती है. उदाहरण के लिए, स्पेस की सूची बनाना देखें.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है.

कॉलर या पुष्टि किए गए उपयोगकर्ता को दिखने वाले स्पेस की सूची बनाता है. पहला मैसेज भेजे जाने तक, ग्रुप चैट और डायरेक्ट मैसेज की सूची नहीं दिखाई जाती है.

Google Workspace संगठन के नाम वाले सभी स्पेस को सूची में शामिल करने के लिए, spaces.search() तरीके का इस्तेमाल करें. इसके लिए, Workspace एडमिन के खास अधिकारों का इस्तेमाल करें.

एचटीटीपी अनुरोध

GET https://chat.googleapis.com/v1/spaces

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

ज़रूरी नहीं. लौटाए जाने वाले स्पेस की ज़्यादा से ज़्यादा संख्या. यह सेवा इस वैल्यू से कम वैल्यू दिखा सकती है.

अगर कोई वैल्यू न दी गई हो, तो ज़्यादा से ज़्यादा 100 स्पेस लौटाए जाते हैं.

ज़्यादा से ज़्यादा वैल्यू 1,000 है. अगर 1,000 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 1,000 में बदल जाता है.

नेगेटिव वैल्यू से INVALID_ARGUMENT गड़बड़ी मिलती है.
pageToken

string

ज़रूरी नहीं. पेज टोकन, जो पिछले स्पेस स्पेस कॉल से मिला है. बाद वाले पेज को फिर से पाने के लिए यह पैरामीटर दें.

पेजों पर नंबर डालते समय, फ़िल्टर की वैल्यू उस कॉल से मैच होनी चाहिए जिससे पेज टोकन मिला है. कोई अलग वैल्यू पास करने पर, अनचाहे नतीजे मिल सकते हैं.
filter

string

ज़रूरी नहीं. क्वेरी फ़िल्टर.

स्पेस के टाइप (spaceType) के हिसाब से, स्पेस फ़िल्टर किए जा सकते हैं.

स्पेस के टाइप के हिसाब से फ़िल्टर करने के लिए, आपको ईनम की मान्य वैल्यू डालनी होगी. जैसे, SPACE या GROUP_CHAT (spaceType, SPACE_TYPE_UNSPECIFIED नहीं हो सकता). एक से ज़्यादा तरह के स्पेस के बारे में क्वेरी करने के लिए, OR ऑपरेटर का इस्तेमाल करें.

उदाहरण के लिए, नीचे दी गई क्वेरी मान्य हैं:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

अमान्य क्वेरी को सर्वर INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

स्पेस की सूची के अनुरोध का जवाब.

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

JSON के काेड में दिखाना 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
spaces[]

object (Space)

अनुरोध किए गए (या पहले) पेज में स्पेस की सूची.
nextPageToken

string

नतीजों का अगला पेज वापस पाने के लिए, pageToken के तौर पर टोकन भेजा जा सकता है. अगर खाली है, तो इसके बाद कोई पेज नहीं होता.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.