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

องค์กรของคุณมีป้ายกำกับได้หลายรายการ โดยที่ป้ายกำกับจะมีช่องหลายช่อง Label 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 ได้ด้วย ผลการค้นหาจะมีป้ายกำกับที่ปิดใช้ด้วย