สร้างและเผยแพร่ป้ายกำกับ

หน้านี้จะอธิบายวิธีสร้างและเผยแพร่ป้ายกำกับ

สร้างป้ายกำกับ

หากต้องการสร้างป้ายกำกับ ให้ใช้เมธอด create ในคอลเล็กชัน labels ป้ายกำกับมีFields ได้มากกว่า 1 รายการ

คุณยังต้องระบุสิ่งต่อไปนี้ด้วย

• LabelType

• ป้ายกำกับ title ผ่านเมธอด property

• useAdminAccess มีสถานะเป็น true เพื่อใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบของผู้ใช้ ซึ่งเซิร์ฟเวอร์จะยืนยันว่าผู้ใช้เป็นผู้ดูแลระบบที่มีสิทธิ์ "จัดการป้ายกำกับ" ก่อนอนุญาตการเข้าถึง

ตัวอย่างนี้สร้างป้ายกำกับผู้ดูแลระบบแบบมาตรฐานที่มีชื่อที่ระบุและอีกป้ายหนึ่ง SelectionOptions Field ที่มี 2 Choices

Python

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()

Node.js

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

เผยแพร่ป้ายกำกับ

API ป้ายกำกับช่วยให้คุณเผยแพร่ป้ายกำกับฉบับร่างได้เมื่อเสร็จสมบูรณ์แล้ว

หากต้องการเผยแพร่ป้ายกำกับ ให้ใช้เมธอด publish และระบุสิ่งต่อไปนี้

• ป้ายกำกับทรัพยากร ที่แสดงถึงป้ายกำกับทุกป้าย โดยมีทรัพยากร Name และ ID ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันทั่วโลกสำหรับป้ายกำกับ

• useAdminAccess มีสถานะเป็น true เพื่อใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบของผู้ใช้ ซึ่งเซิร์ฟเวอร์จะยืนยันว่าผู้ใช้เป็นผู้ดูแลระบบที่มีสิทธิ์ "จัดการป้ายกำกับ" ก่อนอนุญาตการเข้าถึง

ตัวอย่างนี้ใช้ ID เพื่อระบุและเผยแพร่ป้ายกำกับที่ถูกต้อง

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

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 มีการเปลี่ยนแปลง
  • การอัปเดตตัวเลือกการตรวจสอบช่องจะปฏิเสธรายการที่ยอมรับไปก่อนหน้านี้
  • จำนวนรายการสูงสุดลดลง