- एचटीटीपी अनुरोध
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- कोरस
- इसे आज़माएं!
उपयोगकर्ता की फ़ाइलों की सूची दिखाता है.
यह तरीका q
पैरामीटर को स्वीकार करता है. यह एक या उससे ज़्यादा खोज के लिए इस्तेमाल हुए शब्दों को जोड़ने वाली खोज क्वेरी होती है. ज़्यादा जानकारी के लिए, फ़ाइलें और फ़ोल्डर खोजना गाइड देखें.
एचटीटीपी अनुरोध
GET https://www.googleapis.com/drive/v2/files
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
corpora |
उन आइटम (फ़ाइलों/दस्तावेज़ों) के मुख्य हिस्से जिन पर क्वेरी लागू होती है. |
corpus |
अब काम नहीं करता: उन आइटम (फ़ाइलों/दस्तावेज़ों) का मुख्य हिस्सा जिन पर क्वेरी लागू होती है. इसके बजाय, |
driveId |
शेयर की गई उस ड्राइव का आईडी जिसमें खोजना है. |
includeItemsFromAllDrives |
'मेरी ड्राइव' और शेयर की गई ड्राइव, दोनों के आइटम नतीजों में शामिल करने हैं या नहीं. |
includeTeamDriveItems |
इस्तेमाल नहीं किया जा सकता: इसके बजाय, |
maxResults |
हर पेज पर दिखाने के लिए, फ़ाइलों की ज़्यादा से ज़्यादा संख्या. फ़ाइलों की सूची खत्म होने से पहले ही, नतीजों के पेज पर कुछ या कोई नतीजा नहीं दिख सकता. |
orderBy |
कॉमा लगाकर अलग की गई, क्रम से लगाने की कुंजियों की सूची. मान्य कुंजियां ये हैं:
हर की, डिफ़ॉल्ट रूप से बढ़ते क्रम में क्रम से लगाती है. हालांकि, 'desc' मॉडिफ़ायर की मदद से, इसे घटते क्रम में लगाया जा सकता है. इस्तेमाल का उदाहरण: ध्यान दें कि फ़िलहाल, जिन उपयोगकर्ताओं के पास करीब एक करोड़ फ़ाइलें हैं उनके लिए, फ़ाइलों को क्रम से लगाने के अनुरोध को अनदेखा कर दिया जाता है. |
pageToken |
फ़ाइलों के लिए पेज टोकन. |
projection |
अब काम नहीं करता: इस पैरामीटर का कोई फ़ंक्शन नहीं है. |
q |
फ़ाइलों को खोजने के लिए क्वेरी स्ट्रिंग. |
spaces |
क्वेरी करने के लिए, कॉमा लगाकर अलग की गई स्पेस की सूची. |
supportsAllDrives |
अनुरोध करने वाला ऐप्लिकेशन, 'मेरी ड्राइव' और शेयर की गई ड्राइव, दोनों के साथ काम करता है या नहीं. |
supportsTeamDrives |
इस्तेमाल नहीं किया जा सकता: इसके बजाय, |
teamDriveId |
इस्तेमाल नहीं किया जा सकता: इसके बजाय, |
includePermissionsForView |
इससे यह तय होता है कि जवाब में कौनसे अतिरिक्त व्यू की अनुमतियां शामिल करनी हैं. वैल्यू के तौर पर, सिर्फ़ |
includeLabels |
जवाब के |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
फ़ाइलों की सूची.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{
"nextPageToken": string,
"kind": string,
"etag": string,
"selfLink": string,
"incompleteSearch": boolean,
"nextLink": string,
"items": [
{
object ( |
फ़ील्ड | |
---|---|
nextPageToken |
फ़ाइलों के अगले पेज का पेज टोकन. अगर फ़ाइलों की सूची खत्म हो गई है, तो यह विकल्प नहीं दिखेगा. अगर किसी वजह से टोकन अस्वीकार कर दिया जाता है, तो उसे खारिज कर दिया जाना चाहिए. साथ ही, नतीजों के पहले पेज से पेजेशन को फिर से शुरू किया जाना चाहिए. |
kind |
यह हमेशा |
etag |
सूची का ETag. |
selfLink |
इस सूची पर वापस ले जाने वाला लिंक. |
incompleteSearch |
क्या खोज की प्रोसेस पूरी नहीं हुई थी. अगर यह 'सही' है, तो हो सकता है कि खोज के कुछ नतीजे न दिखें, क्योंकि सभी दस्तावेज़ों को खोजा नहीं गया था. ऐसा तब हो सकता है, जब "allDrives" कॉर्पस की मदद से एक से ज़्यादा ड्राइव खोजी जा रही हों, लेकिन सभी कॉर्पस खोजे न जा सकें. ऐसा होने पर, हमारा सुझाव है कि क्लाइंट "डिफ़ॉल्ट" या "ड्राइव" जैसे किसी दूसरे कॉर्पस को चुनकर, अपनी क्वेरी को छोटा करें. |
nextLink |
फ़ाइलों के अगले पेज का लिंक. |
items[] |
फ़ाइलों की सूची. अगर nextPageToken की वैल्यू मौजूद है, तो हो सकता है कि यह सूची पूरी न हो. ऐसे में, नतीजों का एक और पेज फ़ेच किया जाना चाहिए. |
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/docs
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.apps.readonly
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.meet.readonly
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 | |
---|---|
DEFAULT |
वे आइटम जिन्हें उपयोगकर्ता ने ऐक्सेस किया है. |
DOMAIN |
उपयोगकर्ता के डोमेन में शेयर किए गए आइटम. |