आपके संगठन के पास कई लेबल हो सकते हैं. साथ ही, लेबल में कई फ़ील्ड हो सकते हैं.
Google Drive Labels API, लेबल को पढ़ने की सुविधा देने के लिए,
labels संसाधन उपलब्ध कराता है.
इस दस्तावेज़ में, Drive Labels API का इस्तेमाल करके, लेबल खोजने और उन्हें वापस पाने का तरीका बताया गया है.
तरीके
labels संसाधन, लेबल की वैल्यू पढ़ने के लिए ये तरीके उपलब्ध कराता है. हर तरीके का इस्तेमाल किसी खास काम के लिए किया जाता है:
| रेंज | तरीका |
|---|---|
| संसाधन के नाम के हिसाब से एक लेबल | labels.get |
| सभी लेबल | labels.list |
संसाधन के नाम के हिसाब से लेबल पाना
किसी लेबल को उसके संसाधन के नाम के हिसाब से पाने के लिए, get तरीके का इस्तेमाल
labels संसाधन पर करें.
लेबल संसाधन का name ज़रूरी है. इसे इस तरह से बनाया जा सकता है:
labels/{id}याlabels/{id}@latest: इससे लेबल का सबसे नया वर्शन मिलता है.labels/{id}@published: इससे लेबल का मौजूदा पब्लिश किया गया वर्शन मिलता है.labels/{id}@{revisionId}: इससे, बताए गए वर्शन आईडी वाला लेबल मिलता है.
लेबल के जवाबों पर लागू होने वाला संसाधन व्यू सेट करने के लिए, आपको
LabelView ऑब्जेक्ट को
LABEL_VIEW_FULL के तौर पर सेट करना होगा.
LABEL_VIEW_FULL से सभी संभावित फ़ील्ड की वैल्यू मिलती है.
यहां दिए गए कोड सैंपल में, संसाधन के नाम के हिसाब से एक लेबल पाने के लिए, लेबल के name का इस्तेमाल करने का तरीका बताया गया है:
Python
# Label name, with or without revision:
#
# Revision specified:
# labels/LABEL_ID@published
# labels/LABEL_ID@latest
# labels/LABEL_ID@1
#
# No revision specified, returns latest revision:
# labels/LABEL_ID
name = 'labels/NAME@published'
# Label view controls level of data in response
view = 'LABEL_VIEW_FULL'
label = service.labels().get(
name=name,
view=view
).execute()
Node.js
// Label name, with or without revision:
//
// Revision specified:
// labels/LABEL_ID@published
// labels/LABEL_ID@latest
// labels/LABEL_ID@1
//
// No revision specified, returns latest revision:
// labels/LABEL_ID
const name = 'labels/NAME@published';
// Label view controls level of data in response
const view = 'LABEL_VIEW_FULL';
service.labels.get({
name: name,
view: view
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
NAME की जगह लेबल का नाम डालें.
सभी लेबल की सूची पाना
लेबल की सूची पाने के लिए, list तरीके का इस्तेमाल
labels संसाधन पर करें.
आपको यह भी बताना होगा:
एक
customerक्वेरी पैरामीटर, ताकि इस सूची के लिए किए गए अनुरोध को किसी खास ग्राहक तक सीमित किया जा सके. अगरcustomerसेट नहीं है, तो मौजूदा ग्राहक के सभी लेबल वापस कर दिए जाते हैं.A
LabelViewऑब्जेक्ट कोLABEL_VIEW_FULLके तौर पर सेट करना होगा, ताकि लेबल के जवाबों पर लागू होने वाला संसाधन व्यू सेट किया जा सके.LABEL_VIEW_FULLसे सभी संभावित फ़ील्ड की वैल्यू मिलती है.
यहां दिए गए कोड सैंपल में, लेबल की सूची पाने के लिए, customer क्वेरी पैरामीटर का इस्तेमाल करने का तरीका बताया गया है:
Python
response = service.labels().list(
customer='customers/CUSTOMER',
view='LABEL_VIEW_FULL'
).execute()
Node.js
const params = {
customer: 'customers/CUSTOMER',
view: 'LABEL_VIEW_FULL'
};
service.labels.list(params, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
const labels = res.data.labels;
if (labels) {
labels.forEach((label) => {
const name = label.name;
const title = label.properties.title;
console.log(`${name}\t${title}`);
});
} else {
console.log('No Labels');
}
});
CUSTOMER की जगह ग्राहक का नाम डालें.