หน้านี้จะอธิบายวิธีสร้างและเผยแพร่ป้ายกำกับ
สร้างป้ายกำกับ
หากต้องการสร้างป้ายกำกับ ให้ใช้เมธอด create
ในคอลเล็กชัน labels
ป้ายกำกับมีFields
อย่างน้อย 1 รายการหรือไม่มีก็ได้
นอกจากนี้ คุณยังต้องระบุข้อมูลต่อไปนี้ด้วย
ป้ายกํากับ
title
ผ่านเมธอดproperty
useAdminAccess
มีสิทธิ์true
ในการเข้าถึงข้อมูลเข้าสู่ระบบของผู้ดูแลระบบ เซิร์ฟเวอร์จะยืนยันว่าผู้ใช้เป็นผู้ดูแลระบบที่มีสิทธิ์ "จัดการป้ายกํากับ" ก่อนอนุญาตให้เข้าถึง
ตัวอย่างนี้จะสร้างป้ายกำกับมาตรฐานสำหรับผู้ดูแลระบบที่มีชื่อที่ระบุและ SelectionOptions
1 รายการ ที่มี Choices
2 รายการField
label_body = {
'label_type': 'ADMIN',
'properties': {
'title': 'TITLE '
},
'fields': [{
'properties': {
'display_name': 'DISPLAY_NAME '
},
'selection_options': {
'list_options': {},
'choices': [{
'properties': {
'display_name': 'CHOICE_1 '
}
}, {
'properties': {
'display_name': 'CHOICE_2 '
}
}]
}
}]
}
response = service.labels().create(
body=label_body, useAdminAccess=True).execute()
var label = {
'label_type': 'ADMIN',
'properties': {
'title': 'TITLE '
},
'fields': [{
'properties': {
'display_name': 'DISPLAY_NAME '
},
'selection_options': {
'list_options': {},
'choices': [{
'properties': {
'display_name': 'CHOICE_1 '
}
}, {
'properties': {
'display_name': 'CHOICE_2 '
}
}]
}
}]
};
service.labels.create({
'resource': label,
'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
ระบบจะสร้างป้ายกำกับใน UNPUBLISHED_DRAFT
State
โดยต้องเป็นPUBLISHED
สำหรับใช้ในไฟล์และแสดงให้ผู้ใช้เห็น ดูข้อมูลเพิ่มเติมได้ที่วงจรชีวิตของป้ายกำกับ
ขีดจำกัดของป้ายกำกับ
ขีดจํากัดต่อไปนี้มีผลเมื่อสร้างและใช้ป้ายกํากับ
- ป้ายกำกับมาตรฐาน - 150
- ฟิลด์ต่อป้ายกำกับ - 10
- ป้ายกำกับที่ผู้ใช้ติดต่อไฟล์ - 5 รายการ
การทํางานกับช่องในป้ายกํากับ
Field Type |
สิ่งที่ผู้ใช้ทำได้ | ข้อควรพิจารณาและขีดจำกัดเกี่ยวกับรูปแบบ |
---|---|---|
SelectionOptions |
เลือกตัวเลือกอย่างน้อย 1 รายการจากรายการ | จํานวนตัวเลือกสูงสุดที่รองรับคือ 200 รายการ จํานวนสูงสุดของการเลือกไฟล์คือ 10 รายการตามที่กําหนดค่าไว้ใน ListOptions |
IntegerOptions |
ป้อนค่าที่เป็นตัวเลข | รองรับเฉพาะตัวเลขจำนวนเต็มเท่านั้น |
DateOptions |
เลือกวันที่ในปฏิทิน | (ไม่บังคับ) Date format สามารถตั้งค่าเป็น "แบบเต็ม: เดือน วว, ปปปป" หรือ "แบบย่อ: ดด/วว/ปป" |
TextOptions |
ป้อนข้อความในกล่องข้อความ | จํานวนอักขระสูงสุดที่รองรับคือ 100 ตัว |
UserOptions |
เลือกผู้ใช้อย่างน้อย 1 คนจากรายชื่อติดต่อ Google Workspace | จํานวนรายการผู้ใช้สูงสุดสําหรับไฟล์คือ 10 รายการตามที่กําหนดค่าไว้ใน ListOptions |
เผยแพร่ป้ายกำกับ
Labels API ช่วยให้คุณเผยแพร่ป้ายกำกับฉบับร่างได้เมื่อสร้างเสร็จแล้ว
หากต้องการเผยแพร่ป้ายกำกับ ให้ใช้เมธอด publish
แล้วระบุข้อมูลต่อไปนี้
ทรัพยากรป้ายกำกับที่แสดงป้ายกำกับทุกรายการ โดยจะมีทรัพยากร
Name
และID
ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันทั่วโลกสำหรับค่ายเพลงuseAdminAccess
มีสิทธิ์true
ในการเข้าถึงข้อมูลเข้าสู่ระบบของผู้ดูแลระบบ เซิร์ฟเวอร์จะยืนยันว่าผู้ใช้เป็นผู้ดูแลระบบที่มีสิทธิ์ "จัดการป้ายกํากับ" ก่อนอนุญาตให้เข้าถึง
ตัวอย่างนี้ใช้ ID
เพื่อระบุและเผยแพร่ป้ายกำกับที่ถูกต้อง
service.labels().publish(
name='labels/ID ',
body={
'use_admin_access': True
}).execute()
service.labels.publish({
'resource': {
'use_admin_access': true
},
'name': 'labels/ID '
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
เมื่อเผยแพร่ป้ายกำกับแล้ว ป้ายกำกับจะย้ายไปยัง PUBLISHED
State
และระบบจะเพิ่มรหัสการแก้ไขของป้ายกำกับ จากนั้นป้ายกำกับจะแสดงต่อผู้ใช้และนำไปใช้กับไฟล์ได้ ดูข้อมูลเพิ่มเติมได้ที่วงจรชีวิตของป้ายกำกับ
ข้อจำกัดเมื่อเผยแพร่ป้ายกำกับ
เมื่อเผยแพร่แล้ว ป้ายกำกับจะกลับไปยังสถานะร่างเดิมไม่ได้ ดูข้อมูลเพิ่มเติมได้ที่วงจรของป้ายกำกับ
การเผยแพร่ป้ายกำกับจะสร้างการแก้ไขที่เผยแพร่ใหม่ ระบบจะลบการแก้ไขฉบับร่างก่อนหน้านี้ทั้งหมด ระบบจะเก็บการแก้ไขที่เผยแพร่ก่อนหน้านี้ไว้ แต่อาจลบออกโดยอัตโนมัติตามความจำเป็น
เมื่อเผยแพร่แล้ว ระบบจะไม่อนุญาตให้ทำการเปลี่ยนแปลงบางอย่างอีก โดยทั่วไปแล้ว หมายความว่าระบบจะปฏิเสธการเปลี่ยนแปลงที่ลบล้างหรือทริกเกอร์ข้อจำกัดใหม่ในข้อมูลเมตาที่มีอยู่ซึ่งเกี่ยวข้องกับป้ายกำกับ ตัวอย่างเช่น เราไม่อนุญาตให้ทำการเปลี่ยนแปลงต่อไปนี้กับป้ายกำกับหลังจากเผยแพร่แล้ว
- ระบบจะลบป้ายกำกับโดยตรง (ต้องปิดใช้ก่อนแล้วจึงลบออก)
Field.FieldType
มีการเปลี่ยนแปลง- การอัปเดตตัวเลือกการตรวจสอบฟิลด์จะปฏิเสธสิ่งที่เคยยอมรับ
- การลดจํานวนรายการสูงสุด