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

ज़रूरी नहीं. यह पेज टोकन है, जो सेक्शन की सूची दिखाने के लिए किए गए पिछले कॉल से मिला है. अगला पेज पाने के लिए, इसे डालें.

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

अनुरोध का मुख्य हिस्सा

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

जवाब का मुख्य हिस्सा

सेक्शन की सूची दिखाने के लिए, जवाब का मैसेज.

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

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

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