Method: spaces.list

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

पुष्टि करने के लिए, इन तरीकों का इस्तेमाल किया जा सकता है:

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

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

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)

अनुरोध किए गए (या पहले) पेज में स्पेस की सूची. ध्यान दें: सूची के अनुरोधों के लिए, Space ऑब्जेक्ट में permissionSettings फ़ील्ड नहीं दिखाया जाता.
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

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