- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- इसे आज़माएं!
उपयोगकर्ता के मेलबॉक्स में मौजूद थ्रेड की सूची बनाता है.
एचटीटीपी अनुरोध
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
पैरामीटर | |
---|---|
userId |
उपयोगकर्ता का ईमेल पता. पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
maxResults |
लौटाए जाने वाले थ्रेड की ज़्यादा से ज़्यादा संख्या. यह फ़ील्ड डिफ़ॉल्ट रूप से 100 पर सेट होता है. इस फ़ील्ड के लिए ज़्यादा से ज़्यादा वैल्यू 500 है. |
pageToken |
सूची में नतीजों के किसी खास पेज को वापस लाने के लिए पेज टोकन. |
q |
सिर्फ़ उस क्वेरी से मैच होने वाली थ्रेड दिखाएं. यह Gmail के खोज बॉक्स की तरह ही क्वेरी फ़ॉर्मैट के साथ काम करता है. उदाहरण के लिए, |
labelIds[] |
सिर्फ़ उन थ्रेड को दिखाता है जिनमें बताए गए सभी लेबल आईडी से मैच करने वाले लेबल हैं. |
includeSpamTrash |
नतीजों में |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{
"threads": [
{
object ( |
फ़ील्ड | |
---|---|
threads[] |
थ्रेड की सूची. ध्यान दें कि हर थ्रेड रिसॉर्स में |
nextPageToken |
सूची में नतीजों का अगला पेज पाने के लिए पेज टोकन. |
resultSizeEstimate |
नतीजों की अनुमानित कुल संख्या. |
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/gmail.metadata
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.