आपके संगठन में कई लेबल हो सकते हैं. साथ ही, हर लेबल में कई फ़ील्ड हो सकते हैं.
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');
}
});