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

เอกสารนี้อธิบายวิธีสร้างและเผยแพร่ป้ายกำกับโดยใช้ Google Drive Labels API

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

หากต้องการสร้างป้ายกำกับ ให้ใช้เมธอด create ใน ทรัพยากร labels ป้ายกำกับอาจมีออบเจ็กต์อย่างน้อย 1 รายการ Field

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

• ออบเจ็กต์ LabelType

• ป้ายกำกับ title ผ่านออบเจ็กต์Properties

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

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้เมธอด create เพื่อสร้างป้ายกำกับมาตรฐานของผู้ดูแลระบบที่มีชื่อที่ระบุและ SelectionOptions Field 1 รายการที่มีออบเจ็กต์ Choice 2 รายการ

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

แทนที่ค่าต่อไปนี้

• TITLE: ชื่อของป้ายกำกับ
• DISPLAY_NAME: ชื่อที่แสดงของช่อง
• CHOICE_1: ตัวเลือกแรกในช่อง SelectionOptions
• CHOICE_2: ตัวเลือกที่ 2 ในช่อง SelectionOptions

ระบบจะสร้างป้ายกำกับใน UNPUBLISHED_DRAFT State ป้ายกำกับต้องมีสถานะเป็น PUBLISHED จึงจะมองเห็นได้สำหรับผู้ใช้และใช้กับไฟล์ได้ ดูข้อมูลเพิ่มเติมได้ที่วงจรการใช้งานของป้ายกำกับ

ขีดจำกัดของป้ายกำกับ

ขีดจำกัดต่อไปนี้จะมีผลเมื่อสร้างและใช้ป้ายกำกับ

• ป้ายกำกับมาตรฐาน: 150 รายการ
• ช่องต่อป้ายกำกับ: 10 ช่อง

การทํางานกับช่องในป้ายกํากับ

ตารางต่อไปนี้อธิบายประเภทช่องที่คุณเพิ่มลงในป้ายกำกับได้ วิธีที่ผู้ใช้โต้ตอบกับช่อง และข้อควรพิจารณาและขีดจำกัดเกี่ยวกับรูปแบบของช่อง

Field Type	สิ่งที่ผู้ใช้ทำได้	ข้อควรพิจารณาและขีดจำกัดเกี่ยวกับรูปแบบ
SelectionOptions	เลือกตัวเลือกอย่างน้อย 1 รายการจากรายการ	จำนวนตัวเลือกสูงสุดที่รองรับคือ 200 จำนวนการเลือกสูงสุดสำหรับไฟล์คือ 10 รายการตามที่กำหนดค่าไว้ใน ListOptions
IntegerOptions	ป้อนค่าตัวเลข	รองรับเฉพาะจำนวนเต็ม
DateOptions	เลือกวันที่จากปฏิทิน	(ไม่บังคับ) คุณสามารถตั้งค่า DateFormat เป็น "Long: Month DD, YYYY" หรือ "Short: MM/DD/YY"
TextOptions	ป้อนข้อความในกล่องข้อความ	จำนวนอักขระสูงสุดที่รองรับคือ 100 ตัว
UserOptions	เลือกผู้ใช้ตั้งแต่ 1 คนขึ้นไปจากรายชื่อติดต่อของ Google Workspace	จำนวนรายการผู้ใช้สูงสุดสำหรับไฟล์คือ 10 รายการตามที่กำหนดค่าไว้ใน ListOptions

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

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

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

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

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

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้ id ของป้ายกำกับเพื่อระบุและเผยแพร่ป้ายกำกับที่ถูกต้อง

Python

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

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

แทนที่ ID ด้วยรหัสของป้ายกำกับที่จะเผยแพร่

เมื่อเผยแพร่แล้ว ป้ายกำกับจะย้ายไปยัง PUBLISHED State และระบบจะเพิ่มรหัสการแก้ไขของป้ายกำกับ จากนั้นผู้ใช้จะมองเห็นป้ายกำกับและนำไปใช้กับไฟล์ได้ ดูข้อมูลเพิ่มเติมได้ที่ วงจรการใช้งานของป้ายกำกับ

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

โปรดทราบข้อจำกัดต่อไปนี้ขณะเตรียมเผยแพร่ป้ายกำกับ

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

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

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

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