- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- इसे आज़माएं!
फ़िलहाल, सिर्फ़ स्पेस को सेक्शन आइटम के तौर पर इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, Google Chat में सेक्शन बनाना और उन्हें व्यवस्थित करना लेख पढ़ें.
इसके लिए, अनुमति के दायरे के साथ उपयोगकर्ता की पुष्टि करना ज़रूरी है:
https://www.googleapis.com/auth/chat.users.sectionshttps://www.googleapis.com/auth/chat.users.sections.readonly
एचटीटीपी अनुरोध
GET https://chat.googleapis.com/v1/{parent=users/*/sections/*}/items
यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
parent |
ज़रूरी है. पैरंट, जो सेक्शन के संसाधन का नाम है. यह सेक्शन के आइटम के इस कलेक्शन का मालिक होता है. यह सुविधा, कॉल करने वाले व्यक्ति के लिए सिर्फ़ लिस्टिंग सेक्शन में मौजूद आइटम के साथ काम करती है. फ़ॉर्मैट: |
क्वेरी पैरामीटर
| पैरामीटर | |
|---|---|
pageSize |
ज़रूरी नहीं. सेक्शन के ज़्यादा से ज़्यादा आइटम वापस लाने की संख्या. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए. अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 10 सेक्शन आइटम दिखाए जाएंगे. ज़्यादा से ज़्यादा वैल्यू 100 हो सकती है. अगर 100 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो उसे अपने-आप 100 पर सेट कर दिया जाता है. नेगेटिव वैल्यू डालने पर, |
pageToken |
ज़रूरी नहीं. यह पेज टोकन, 'सूची सेक्शन के आइटम दिखाएं' फ़ंक्शन को कॉल करने पर मिलता है. अगला पेज पाने के लिए, यह टोकन दें. पेज नंबर के हिसाब से नतीजे दिखाने के दौरान, दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मेल खाने चाहिए. अन्य पैरामीटर को अलग-अलग वैल्यू पास करने से, अनचाहे नतीजे मिल सकते हैं. |
filter |
ज़रूरी नहीं. क्वेरी फ़िल्टर. फ़िलहाल, सिर्फ़ स्पेस के हिसाब से फ़िल्टर करने की सुविधा उपलब्ध है. उदाहरण के लिए, अमान्य क्वेरी को |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
लिस्टिंग सेक्शन में मौजूद आइटम के लिए जवाब का मैसेज.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
| JSON के काेड में दिखाना |
|---|
{
"sectionItems": [
{
object ( |
| फ़ील्ड | |
|---|---|
sectionItems[] |
चुने गए सेक्शन के आइटम. |
nextPageToken |
यह एक टोकन है. इसका इस्तेमाल अगले पेज को वापस पाने के लिए, |
अनुमति पाने के लिंक
इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/chat.users.sectionshttps://www.googleapis.com/auth/chat.users.sections.readonly
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.