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

องค์กรของคุณมีป้ายกำกับได้หลายป้ายกำกับ โดยแต่ละป้ายกำกับจะมีหลายช่อง Labels API มีคอลเล็กชัน labels เพื่อเปิดใช้การอ่านป้ายกำกับ

หน้านี้จะอธิบายวิธีค้นหาและเรียกข้อมูลป้ายกำกับ

เมธอด

คอลเล็กชัน labels มีวิธีการต่อไปนี้ในการอ่านค่าป้ายกำกับ โดยแต่ละวิธีมีไว้เพื่องานที่เฉพาะเจาะจง

ช่วง การอ่าน
ป้ายกำกับเดี่ยวตามชื่อทรัพยากร labels.get
ป้ายกำกับทั้งหมด labels.list

รับป้ายกำกับตามชื่อทรัพยากร

หากต้องการรับป้ายกำกับรายการเดียวตามชื่อทรัพยากร ให้ใช้เมธอด labels.get

ต้องระบุชื่อทรัพยากรป้ายกำกับและสามารถมีโครงสร้างดังนี้

  • labels/{id} หรือ labels/{id}@latest - รับการแก้ไขป้ายกำกับล่าสุด
  • labels/{id}@published - รับการแก้ไขป้ายกำกับที่เผยแพร่ในปัจจุบัน
  • labels/{id}@{revisionId} - รับป้ายกำกับที่รหัสการแก้ไขที่ระบุ

นอกจากนี้ คุณยังต้องระบุข้อมูลต่อไปนี้ด้วย

  • LabelView is LABEL_VIEW_FULL to set the Resource view applied to label responses. 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 is LABEL_VIEW_FULL to set the Resource view applied to label responses. 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');
  }
});