คุณสามารถอัปเดตป้ายกำกับเดียวโดยใช้ชุดคำขออัปเดตซึ่งส่งผล
ฉบับร่างใหม่ เช่น คุณสามารถอัปเดตป้ายกำกับที่มีอยู่
property (ป้ายกำกับ
คำอธิบาย) หรือคุณสามารถเพิ่ม
Field
ไปยังป้ายกำกับ
การอัปเดตป้ายกำกับจะทำหน้าที่เป็นการอัปเดตเป็นกลุ่ม เนื่องจากเมธอดจะใช้รายการการอัปเดต
Request
ออบเจ็กต์ ทั้งนี้
ทำการอัปเดตตามลำดับเดียวกันที่ระบุไว้ในคำขอแบบกลุ่ม
การอัปเดตในการอัปเดตเป็นกลุ่มจะถูกนำไปใช้อย่างปรมาณู กล่าวคือ หากมีคำขอใน
กลุ่มไม่สำเร็จ การอัปเดตทั้งหมดไม่สำเร็จ และไม่มี
การเปลี่ยนแปลง (ที่อาจขึ้นอยู่กับ) จะมีผล ป้ายกำกับจะไม่ถูกเปลี่ยนแปลง
หากอัปเดตสำเร็จ จะต้องเผยแพร่การแก้ไขฉบับร่างที่ได้ ก่อนจะนำการเปลี่ยนแปลงไปใช้กับรายการในไดรฟ์ได้
อัปเดตออบเจ็กต์ป้ายกำกับ
ป้ายกำกับจะมีออบเจ็กต์ประเภทอื่นๆ อีกหลายประเภทที่อัปเดตได้ เช่น
- คุณสมบัติของป้ายกำกับ
- ฟิลด์และประเภทฟิลด์
- ตัวเลือกการเลือกและพร็อพเพอร์ตี้ตัวเลือก
ที่กล่าวมาเป็นวัตถุที่ควบคุมลักษณะที่ปรากฏและการทำงานของ ป้ายกำกับ
หมวดหมู่ของการดำเนินงาน
การดำเนินการต่อไปนี้สนับสนุนโดย
วิธี labels.delta
โดยแบ่งเป็นหมวดหมู่กว้างๆ ดังต่อไปนี้
หมวดหมู่ | คำอธิบาย |
---|---|
สร้าง | เพิ่มวัตถุ |
อัปเดต | อัปเดตคุณสมบัติบางอย่างของวัตถุ |
เปิดใช้ | เปิดใช้ออบเจ็กต์ |
ปิดใช้ | ปิดใช้ออบเจ็กต์ |
ลบ | นำออบเจ็กต์ออก |
หมวดหมู่เหล่านี้จะใช้ในส่วนถัดไปเพื่ออธิบายลักษณะการทำงานของ การดำเนินงานเฉพาะด้าน
อัปเดตคำขอ
เมธอด labels.delta
จะใช้งานได้
โดยดำเนินการ
ส่งคำขอออบเจ็กต์ แต่ละรายการ
คำขอหนึ่งระบุคำขอประเภทเดียวที่จะดำเนินการ ซึ่งมีหลายประเภท
คำขอประเภทต่างๆ ต่อไปนี้เป็นรายละเอียดเกี่ยวกับประเภทของคำขอ ซึ่งจัดกลุ่มเป็น
หมวดหมู่ต่างๆ ได้
ประเภทคำขอ | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
คุณสมบัติของป้ายกำกับ |
|
||||||||||
ฟิลด์ |
|
||||||||||
ตัวเลือกการเลือก |
|
ฟิลด์มาสก์
ฟังก์ชัน "อัปเดต" หลายอย่าง และ "ปิดใช้" คำขอประเภทต้องมี
FieldMask
ซึ่งเป็นรายการช่องที่คั่นด้วยคอมมาที่คุณต้องการอัปเดตขณะออกจากช่อง
ช่องอื่นๆ ที่ไม่ได้เปลี่ยนแปลง คุณต้องมาสก์เพื่อให้แน่ใจว่ามีเฉพาะช่องที่คุณ
ที่คุณต้องการแก้ไข คุณต้องระบุอย่างน้อย 1 ช่อง
ตัวอย่าง
หากต้องการอัปเดตป้ายกำกับ ให้ใช้
delta
ใน
labels
คอลเล็กชัน
นอกจากนี้ คุณยังต้องระบุข้อมูลต่อไปนี้ด้วย
useAdminAccess
คือtrue
เพื่อใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบของผู้ใช้ ยืนยันว่าผู้ใช้เป็นผู้ดูแลระบบสำหรับป้ายกำกับก่อนอนุญาต สิทธิ์การเข้าถึงRequest
ที่ ระบุการอัปเดตที่เกี่ยวข้องกับป้ายกำกับป้ายกำกับ
title
ผ่านproperty
Field
อย่างน้อย 1 รายการทรัพยากรป้ายกำกับ ที่แสดงถึงป้ายกำกับทุกป้าย มีทรัพยากร
Name
และID
ซึ่ง เป็นตัวระบุที่ไม่ซ้ำกันทั่วโลกสำหรับป้ายกำกับLabelView
คือLABEL_VIEW_FULL
เพื่อตั้งค่ามุมมองทรัพยากรที่ใช้กับการตอบกลับป้ายกำกับLABEL_VIEW_FULL
จะแสดงช่องที่เป็นไปได้ทั้งหมด
ตัวอย่างนี้ใช้ ID
เพื่ออัปเดตป้ายกำกับที่ถูกต้อง
Python
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()
Node.js
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
ก่อนที่จะมีการเปลี่ยนแปลง
แสดงต่อผู้ใช้ ดูข้อมูลเพิ่มเติมได้ที่ป้ายกำกับ
วงจร