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

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

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

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

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

  • LabelType

  • ป้ายกำกับ title ผ่าน property

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

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

ข้อจำกัดเมื่อเผยแพร่ป้ายกำกับ

  • เมื่อเผยแพร่แล้ว ป้ายกำกับจะเปลี่ยนกลับเป็นสถานะฉบับร่างเดิมไม่ได้ สำหรับข้อมูลเพิ่มเติม โปรดดูข้อมูลที่หัวข้อวงจรของป้ายกำกับ

  • การเผยแพร่ป้ายกำกับจะสร้างการแก้ไขที่เผยแพร่ใหม่ ฉบับร่างก่อนหน้าทั้งหมด การแก้ไขแล้ว การแก้ไขที่เผยแพร่ก่อนหน้านี้จะยังคงอยู่ แต่ อาจถูกลบโดยอัตโนมัติตามที่จำเป็น

  • เมื่อเผยแพร่แล้ว การเปลี่ยนแปลงบางอย่างจะไม่ได้รับอนุญาตอีกต่อไป โดยทั่วไป มีความหมายว่า การเปลี่ยนแปลงใดๆ ที่เป็นโมฆะหรือทำให้เกิดข้อจำกัดใหม่กับ ข้อมูลเมตาที่เกี่ยวข้องกับป้ายกำกับถูกปฏิเสธ ตัวอย่างเช่น URL ต่อไปนี้ ไม่อนุญาตให้เปลี่ยนแปลงป้ายกำกับหลังจากเผยแพร่ป้ายกำกับ:

    • ระบบจะลบป้ายกำกับโดยตรง (ต้องปิดใช้ก่อน จากนั้น deleted.)
    • Field.FieldType มีการเปลี่ยนแปลง
    • การอัปเดตตัวเลือกการตรวจสอบช่องจะมีการปฏิเสธบางอย่างก่อนหน้านี้ ยอมรับ
    • จำนวนรายการสูงสุดที่ลดลง