Method: users.sections.list

Chat उपयोगकर्ता के लिए उपलब्ध सेक्शन की सूची बनाता है. सेक्शन की मदद से, उपयोगकर्ता अपनी बातचीत को ग्रुप कर सकते हैं. साथ ही, Chat के नेविगेशन पैनल में दिखने वाले स्पेस की सूची को पसंद के मुताबिक बना सकते हैं. ज़्यादा जानकारी के लिए, Google Chat में सेक्शन बनाना और उन्हें व्यवस्थित करना लेख पढ़ें.

इसके लिए, अनुमति के दायरे के साथ उपयोगकर्ता की पुष्टि करना ज़रूरी है:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

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

GET https://chat.googleapis.com/v1/{parent=users/*}/sections

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. पैरंट, जो उपयोगकर्ता के संसाधन का वह नाम है जिसके पास सेक्शन के इस कलेक्शन का मालिकाना हक है. यह सिर्फ़ कॉल करने वाले व्यक्ति के लिए, लिस्टिंग सेक्शन दिखाता है. कॉल करने वाले उपयोगकर्ता को रेफ़र करने के लिए, इनमें से कोई एक विकल्प सेट करें:

  • me का दूसरा ईमेल पता. उदाहरण के लिए, users/me.

  • उनके Workspace खाते का ईमेल पता. उदाहरण के लिए, users/user@example.com.

  • उनका यूज़र आईडी. उदाहरण के लिए, users/123456789.

फ़ॉर्मैट: users/{user}

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

पैरामीटर
pageSize

integer

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

अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 10 सेक्शन दिखाए जाएंगे.

ज़्यादा से ज़्यादा वैल्यू 100 हो सकती है. अगर 100 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो उसे अपने-आप 100 पर सेट कर दिया जाता है.

नेगेटिव वैल्यू डालने पर, INVALID_ARGUMENT गड़बड़ी दिखती है.
pageToken

string

ज़रूरी नहीं. यह एक पेज टोकन है. यह पिछले list sections कॉल से मिला था. अगला पेज पाने के लिए, यह टोकन दें.

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

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

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

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

लिस्टिंग सेक्शन के लिए जवाब का मैसेज.

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

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

object (Section)

चुने गए उपयोगकर्ता के सेक्शन.
nextPageToken

string

यह एक टोकन है. इसका इस्तेमाल अगले पेज को वापस पाने के लिए, pageToken के तौर पर किया जा सकता है. अगर इस फ़ील्ड को शामिल नहीं किया जाता है, तो इसके बाद कोई पेज नहीं होता.

अनुमति पाने के लिंक

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

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