- एचटीटीपी अनुरोध
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- कॉर्पस
- इसे आज़माएं!
उपयोगकर्ता की फ़ाइलों की सूची बनाता है.
यह तरीका q
पैरामीटर को स्वीकार करता है. यह एक ऐसी खोज क्वेरी है जिसमें एक या उससे ज़्यादा खोज शब्दों को मिलाया जाता है. ज़्यादा जानकारी के लिए, फ़ाइलें और फ़ोल्डर खोजें गाइड देखें.
एचटीटीपी अनुरोध
GET https://www.googleapis.com/drive/v3/files
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
corpora |
आइटम (फ़ाइलें या दस्तावेज़) जिन पर क्वेरी लागू होती है. 'user', 'domain', 'drive', और 'allDrive' बॉडी का इस्तेमाल किया जा सकता है. बेहतर परफ़ॉर्मेंस के लिए, 'allDrive' पर 'उपयोगकर्ता' या 'ड्राइव करें' को प्राथमिकता दें. डिफ़ॉल्ट रूप से, कॉर्पस 'उपयोगकर्ता' पर सेट होता है. हालांकि, 'q' पैरामीटर से सेट किए गए फ़िल्टर के आधार पर यह बदल सकता है. |
corpus |
अब सेवा में नहीं है: लिस्ट की जाने वाली फ़ाइलों का सोर्स. इसके बजाय, 'corpora' शब्द का इस्तेमाल करें. |
driveId |
खोजने के लिए शेयर की गई ड्राइव का आईडी. |
includeItemsFromAllDrives |
नतीजों में, 'मेरी ड्राइव' और 'शेयर की गई ड्राइव' के आइटम, दोनों शामिल किए जाने चाहिए या नहीं. |
includeTeamDriveItems |
अब सेवा में नहीं है: इसके बजाय |
orderBy |
क्रम से लगाने वाली कुंजियों की कॉमा-सेपरेटेड लिस्ट. मान्य कुंजियां 'createdTime', 'फ़ोल्डर', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'रीसेंसी', 'sharedWithMeTime', 'starred', और 'viewedByMeTime' हैं. हर कुंजी डिफ़ॉल्ट रूप से बढ़ते हुए क्रम में दिखती है. हालांकि, 'ब्यौरा' मॉडिफ़ायर की मदद से इसे उलटा किया जा सकता है. इस्तेमाल का उदाहरण: ?orderBy=फ़ोल्डर,modifiedTime Description,name. |
pageSize |
हर पेज पर लौटाने के लिए फ़ाइलों की ज़्यादा से ज़्यादा संख्या. फ़ाइलों की सूची खत्म होने से पहले ही, नतीजों वाले पेजों के कुछ हिस्से या खाली हो सकते हैं. |
pageToken |
अगले पेज पर सूची के पिछले अनुरोध को जारी रखने के लिए टोकन. इसे पिछले जवाब के 'nextPageToken' की वैल्यू पर सेट किया जाना चाहिए. |
q |
फ़ाइल के नतीजों को फ़िल्टर करने के लिए क्वेरी. काम करने वाले सिंटैक्स के लिए "फ़ाइलें और फ़ोल्डर खोजें" गाइड देखें. |
spaces |
कॉर्पस में क्वेरी करने के लिए स्पेस की कॉमा-सेपरेटेड लिस्ट. 'drive' और 'appDataफ़ोल्डर' की वैल्यू इस्तेमाल की जा सकती है. |
supportsAllDrives |
अनुरोध किया गया ऐप्लिकेशन, 'मेरी ड्राइव' और 'शेयर की गई ड्राइव', दोनों के साथ काम करता है या नहीं. |
supportsTeamDrives |
अब सेवा में नहीं है: इसके बजाय |
teamDriveId |
अब सेवा में नहीं है: इसके बजाय |
includePermissionsForView |
इससे पता चलता है कि जवाब में कौनसे अतिरिक्त व्यू की अनुमतियां शामिल करनी हैं. सिर्फ़ 'पब्लिश की गई' साइट को ऐक्सेस किया जा सकता है. |
includeLabels |
जवाब के |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
फ़ाइलों की सूची.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
फ़ील्ड | |
---|---|
nextPageToken |
फ़ाइलों के अगले पेज के लिए पेज टोकन. अगर फ़ाइलों की सूची का आखिरी एलिमेंट खत्म हो गया है, तो यह फ़ाइल नहीं दिखेगी. अगर किसी वजह से टोकन अस्वीकार किया जाता है, तो उसे खारिज कर देना चाहिए. साथ ही, नतीजों के पहले पेज से ही पेज नंबर को फिर से शुरू करना चाहिए. पेज टोकन आम तौर पर कुछ घंटों के लिए मान्य रहता है. हालांकि, अगर नए आइटम जोड़े या हटाए जाते हैं, तो आपको अलग नतीजे मिल सकते हैं. |
kind |
यह बताता है कि यह किस तरह का संसाधन है. वैल्यू: तय स्ट्रिंग |
incompleteSearch |
क्या खोज की प्रोसेस अधूरी थी. सही होने पर, हो सकता है कि कुछ खोज नतीजे मौजूद न हों, क्योंकि सभी दस्तावेज़ नहीं खोजे गए हैं. ऐसा तब हो सकता है, जब 'allDrives' कॉर्पस का इस्तेमाल करके कई ड्राइव को खोजा जा रहा हो, लेकिन सभी कॉर्पस को नहीं खोजा जा सका. ऐसा होने पर, क्लाइंट को अपनी क्वेरी को और सटीक बनाने के लिए, 'उपयोगकर्ता' या 'ड्राइव' जैसे किसी दूसरे कलेक्शन को चुनने का सुझाव दिया जाता है. |
files[] |
फ़ाइलों की सूची. अगर NextPageToken को पॉप्युलेट किया जाता है, तो यह सूची अधूरी हो सकती है. साथ ही, नतीजों का एक और पेज फ़ेच किया जाना चाहिए. |
अनुमति देने के दायरे
इनमें से कोई एक OAuth स्कोप ज़रूरी है:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive.readonly
कुछ दायरे सीमित हैं. इनका इस्तेमाल करने के लिए, सुरक्षा जांच की ज़रूरत होती है. ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.
कॉर्पस
Enums | |
---|---|
user |
उपयोगकर्ता के मालिकाना हक वाली या उपयोगकर्ता के साथ शेयर की गई फ़ाइलें. |
domain |
उपयोगकर्ता के डोमेन में शेयर की गई फ़ाइलें. |