องค์กรของคุณมีป้ายกำกับได้หลายป้าย โดยป้ายกำกับจะมีช่องหลายช่อง
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');
}
});