คุณอัปเดตป้ายกำกับรายการเดียวได้โดยใช้ชุดคำขออัปเดตซึ่งจะส่งผลให้มีฉบับร่างการแก้ไขใหม่ เช่น คุณสามารถอัปเดตพร็อพเพอร์ตี้ป้ายกำกับที่มีอยู่ (คําอธิบายป้ายกำกับ) หรือเพิ่มField
ใหม่ลงในป้ายกำกับ
การอัปเดตป้ายกำกับจะทํางานเป็นการอัปเดตหลายรายการพร้อมกัน เนื่องจากเมธอดจะนํารายการออบเจ็กต์การอัปเดต Request
โดยจะอัปเดตตามลําดับเดียวกันกับที่ระบุไว้ในคําขอแบบเป็นกลุ่ม ระบบจะใช้การอัปเดตในการอัปเดตแบบเป็นกลุ่มพร้อมกัน กล่าวคือ หากคำขอใดในชุดไม่สำเร็จ การอัปเดตทั้งหมดจะไม่สำเร็จและจะไม่มีการใช้การเปลี่ยนแปลง (ที่อาจขึ้นต่อกัน) ใดๆ ป้ายกำกับจะไม่มีการเปลี่ยนแปลง
หากการอัปเดตสำเร็จ คุณต้องเผยแพร่ฉบับร่างฉบับแก้ไขที่เป็นผลลัพธ์ก่อนจึงจะใช้การเปลี่ยนแปลงกับรายการในไดรฟ์ได้
อัปเดตออบเจ็กต์ป้ายกำกับ
ป้ายกํากับประกอบด้วยออบเจ็กต์ประเภทอื่นๆ อีกมากมายที่อัปเดตได้ เช่น
- พร็อพเพอร์ตี้ของป้ายกำกับ
- ฟิลด์และประเภทฟิลด์
- ตัวเลือกการเลือกและพร็อพเพอร์ตี้ตัวเลือกการเลือก
ต่อไปนี้คือออบเจ็กต์บางส่วนที่ควบคุมลักษณะที่ปรากฏและการทำงานของป้ายกำกับ
หมวดหมู่ของการดำเนินการ
การดำเนินการต่อไปนี้ที่รองรับโดยเมธอด labels.delta
สามารถแบ่งออกเป็นหมวดหมู่กว้างๆ ต่อไปนี้
หมวดหมู่ | คำอธิบาย |
---|---|
สร้าง | เพิ่มวัตถุ |
อัปเดต | อัปเดตพร็อพเพอร์ตี้บางอย่างของออบเจ็กต์ |
เปิดใช้ | เปิดใช้ออบเจ็กต์ |
ปิดใช้ | ปิดใช้วัตถุ |
ลบ | นำวัตถุออก |
ระบบจะใช้หมวดหมู่เหล่านี้ในส่วนถัดไปเพื่ออธิบายลักษณะการทํางานของการดำเนินการที่เฉพาะเจาะจง
อัปเดตคำขอ
เมธอด labels.delta
จะทํางานโดยรับออบเจ็กต์ Request อย่างน้อย 1 รายการ โดยแต่ละรายการจะระบุคําขอประเภทเดียวที่จะดําเนินการ คำขอมีหลายประเภท รายละเอียดประเภทคำขอที่จัดกลุ่มเป็นหมวดหมู่ต่างๆ มีดังนี้
ประเภทคำขอ | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พร็อพเพอร์ตี้ป้ายกำกับ |
|
||||||||||
ฟิลด์ |
|
||||||||||
ตัวเลือกการเลือก |
มาสก์ช่อง
คำขอประเภท "อัปเดต" และ "ปิดใช้" จำนวนมากต้องใช้ FieldMask
รายการช่องที่คั่นด้วยคอมมาซึ่งคุณต้องการอัปเดตโดยไม่เปลี่ยนแปลงช่องอื่นๆ จำเป็นต้องใช้หน้ากากเพื่อให้แน่ใจว่าระบบจะอัปเดตเฉพาะช่องที่คุณต้องการแก้ไขเท่านั้น คุณต้องระบุฟิลด์อย่างน้อย 1 ช่อง
ตัวอย่าง
หากต้องการอัปเดตป้ายกำกับ ให้ใช้เมธอด delta
ในคอลเล็กชัน labels
นอกจากนี้ คุณยังต้องระบุข้อมูลต่อไปนี้ด้วย
useAdminAccess
มีสิทธิ์true
ในการเข้าถึงข้อมูลเข้าสู่ระบบของผู้ดูแลระบบ เซิร์ฟเวอร์จะยืนยันว่าผู้ใช้เป็นผู้ดูแลระบบของป้ายกำกับก่อนที่จะอนุญาตให้เข้าถึงRequest
ที่ระบุการอัปเดตที่เกี่ยวข้องของป้ายกำกับป้ายกํากับ
title
ผ่านเมธอดproperty
Field
อย่างน้อย 1 รายการทรัพยากรป้ายกำกับที่แสดงป้ายกำกับทั้งหมด ซึ่งมีทรัพยากร
Name
และID
ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันทั่วโลกสำหรับค่ายเพลงLabelView
isLABEL_VIEW_FULL
to set the Resource view applied to label responses.LABEL_VIEW_FULL
จะแสดงผลลัพธ์ของช่องที่เป็นไปได้ทั้งหมด
ตัวอย่างนี้ใช้ ID
เพื่ออัปเดตป้ายกำกับที่ถูกต้อง
body = {
'use_admin_access': True,
'requests': [{
'update_label': {
'properties': {
'title': 'TITLE '
},
'update_mask': {
'paths': ['title']
}
},
}, {
'create_field': {
'field': {
'properties': {
'display_name': 'DISPLAY_NAME '
},
'text_options': {}
}
}
}],
'view': 'LABEL_VIEW_FULL'
}
response = service.labels().delta(
body=body,
name='labels/ID ').execute()
var body = {
'use_admin_access': true,
'requests': [{
'update_label': {
'properties': {
'title': 'TITLE '
},
'update_mask': {
'paths': ['title']
}
},
}, {
'create_field': {
'field': {
'properties': {
'display_name': 'DISPLAY_NAME '
},
'text_options': {}
}
}
}],
'view': 'LABEL_VIEW_FULL'
};
service.labels.delta({
'resource': body,
'name': 'labels/ID '
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
ระบบจะอัปเดตป้ายกำกับ ช่อง หรือตัวเลือก เพิ่มรหัสการแก้ไขของป้ายกำกับ และจัดเก็บป้ายกำกับเป็นป้ายกำกับฉบับร่างในฐานข้อมูล ป้ายกำกับมีState
ของ PUBLISHED
พร้อม hasUnpublishedChanges=true
ซึ่งหมายความว่ามีการเปลี่ยนแปลงฉบับร่าง แต่ผู้ใช้ไม่สามารถเข้าถึงได้ ป้ายกำกับที่อัปเดตแล้วต้องเป็น PUBLISHED
ก่อนที่ผู้ใช้จะเห็นการเปลี่ยนแปลง ดูข้อมูลเพิ่มเติมได้ที่วงจรชีวิตของป้ายกำกับ