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

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

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

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

นอกจากนี้ คุณต้องระบุข้อมูลต่อไปนี้ด้วย

  • A LabelType

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

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

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

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 เลือกผู้ใช้จากรายชื่อติดต่อของ Google Workspace จำนวนรายการผู้ใช้สูงสุดสำหรับไฟล์คือ 10 รายการตามที่กำหนดค่าไว้ใน ListOptions

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

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