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