Method: spaces.list

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

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

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

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

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

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

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

पैरामीटर
pageSize

integer

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

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

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

नेगेटिव वैल्यू दिखाने पर 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 गड़बड़ी के साथ अस्वीकार कर देता है.

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

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

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

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

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

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

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