Method: labels.list

लेबल की सूची बनाएं.

एचटीटीपी अनुरोध

GET https://drivelabels.googleapis.com/v2/labels

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
publishedOnly

boolean

क्या नतीजों में सिर्फ़ पब्लिश किए गए लेबल शामिल करने हैं.

  • true पर, सिर्फ़ पब्लिश किए गए मौजूदा लेबल में बदलाव किए जाते हैं. बंद किए गए लेबल शामिल हैं. लौटाए गए लेबल के रिसॉर्स के नाम, पब्लिश किए गए बदलावों (labels/{id}/{revisionId}) के बारे में बताते हैं.
  • false होने पर, लेबल में किए गए मौजूदा बदलाव दिखते हैं, लेकिन हो सकता है कि वे पब्लिश न हों. लौटाए गए लेबल के रिसॉर्स के नाम में किसी खास बदलाव (labels/{id}) का रेफ़रंस नहीं दिया गया है.
customer

string

वह ग्राहक जिसके लिए इस सूची का अनुरोध करना है. उदाहरण के लिए: "customers/abcd1234". अगर यह नीति सेट नहीं है, तो मौजूदा ग्राहक के सभी लेबल दिखाएगा.

languageCode

string

स्थानीय जगह के अनुसार फ़ील्ड लेबल का आकलन करने के लिए, BCP-47 भाषा कोड का इस्तेमाल करना. अगर कोई वैल्यू तय नहीं की गई है, तो कॉन्फ़िगर की गई डिफ़ॉल्ट भाषा का इस्तेमाल किया जाता है.

pageSize

integer

हर पेज पर दिखाए जाने वाले लेबल की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट: 50. ज़्यादा से ज़्यादा: 200.

pageToken

string

वापस जाने के लिए पेज का टोकन.

view

enum (LabelView)

तय किए जाने पर, बताए गए व्यू से जुड़े कुछ फ़ील्ड ही लौटाए जाते हैं.

यूनियन पैरामीटर access.

access इनमें से सिर्फ़ एक हो सकता है:

useAdminAccess

boolean

उपयोगकर्ता के एडमिन क्रेडेंशियल का इस्तेमाल करने के लिए, true पर सेट करें. इससे ग्राहक के अंदर सभी लेबल दिखेंगे.

minimumRole

enum (LabelRole)

इससे पता चलता है कि दिखाए गए लेबल पर, उपयोगकर्ता के पास किस लेवल का ऐक्सेस होना चाहिए. लेबल में किसी उपयोगकर्ता की कम से कम भूमिका. डिफ़ॉल्ट तौर पर, यह READER पर सेट होता है.

अनुरोध का मुख्य भाग

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

जवाब का मुख्य भाग

लेबल की सूची के लिए जवाब.

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

JSON के काेड में दिखाना
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
labels[]

object (Label)

लेबल.

nextPageToken

string

जवाब में मौजूद अगले पेज का टोकन.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

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