आपके संगठन में कई लेबल हो सकते हैं. साथ ही, लेबल में कई फ़ील्ड हो सकते हैं.
Labels API, लेबल पढ़ने की सुविधा चालू करने के लिए labels
कलेक्शन उपलब्ध कराता है.
इस पेज पर, लेबल खोजने और उन्हें वापस पाने का तरीका बताया गया है.
तरीके
labels
कलेक्शन, लेबल वैल्यू को पढ़ने के लिए ये तरीके उपलब्ध कराता है. हर तरीके का इस्तेमाल किसी खास काम के लिए किया जाता है:
सीमा | रीडिंग |
---|---|
संसाधन के नाम के हिसाब से एक लेबल | labels.get |
सभी लेबल | labels.list |
संसाधन के नाम के हिसाब से लेबल पाना
किसी लेबल को उसके संसाधन के नाम के हिसाब से पाने के लिए, labels.get
तरीके का इस्तेमाल करें.
लेबल के संसाधन का नाम देना ज़रूरी है. इसे इस तरह से स्ट्रक्चर किया जा सकता है:
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
name = "labels/NAME@published"
# Label view controls level of data in response
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);
});
सभी लेबल की सूची बनाना
लेबल की सूची पाने के लिए, labels.list
तरीके का इस्तेमाल करें.
आपको यह भी बताना होगा कि:
इस सूची के अनुरोध को स्कोप करने के लिए,
customer
. अगरcustomer
को सेट नहीं किया गया है, तो मौजूदा ग्राहक के सभी लेबल दिखते हैं.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');
}
});