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