ค้นหาป้ายกำกับ

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

หมายเหตุ: หากต้องการแสดงผลเฉพาะการแก้ไขป้ายกำกับที่เผยแพร่แล้ว คุณก็ทำได้ด้วย ระบุ publishedOnly คือ true ผลการค้นหายังมีป้ายกำกับที่ปิดใช้ด้วย