REST Resource: labels

ทรัพยากร: ป้ายกำกับ

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

การแสดง JSON 
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของป้ายกำกับ ซึ่งจะอยู่ในรูปแบบ labels/{id} หรือ labels/{id}@{revisionId} ขึ้นอยู่กับคําขอ โปรดดู id และ revisionId ด้านล่าง
id

string

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันทั่วโลกของป้ายกำกับนี้ ID เป็นส่วนหนึ่งของป้ายกำกับ name แต่ ID จะสอดคล้องกันระหว่างการแก้ไขต่างๆ ซึ่งต่างจาก name ตรงกับนิพจน์ทั่วไป: ([a-zA-Z0-9])+
revisionId

string

เอาต์พุตเท่านั้น รหัสการแก้ไขของป้ายกำกับ รหัสการแก้ไขอาจเป็นส่วนหนึ่งของป้ายกำกับ name ขึ้นอยู่กับคำขอที่ออก ระบบจะสร้างการแก้ไขใหม่ทุกครั้งที่คุณสมบัติที่แก้ไขของป้ายกำกับมีการเปลี่ยนแปลง ตรงกับนิพจน์ทั่วไป: ([a-zA-Z0-9])+
labelType

enum (LabelType)

ต้องระบุ ประเภทของป้ายกำกับ
creator

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างป้ายกำกับนี้
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างป้ายกำกับนี้
revisionCreator

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างการแก้ไขป้ายกำกับนี้
revisionCreateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่แก้ไขป้ายกำกับนี้
publisher

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่เผยแพร่ป้ายกำกับนี้ ค่านี้ไม่มีความหมายเมื่อป้ายกำกับไม่ได้รับการเผยแพร่
publishTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เผยแพร่ป้ายกำกับนี้ ค่านี้ไม่มีความหมายเมื่อป้ายกำกับไม่ได้รับการเผยแพร่
disabler

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่ปิดใช้ป้ายกำกับนี้ ค่านี้ไม่มีความหมายเมื่อไม่ได้ปิดใช้ป้ายกำกับ
disableTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ปิดใช้ป้ายกำกับนี้ ค่านี้ไม่มีความหมายเมื่อไม่ได้ปิดใช้ป้ายกำกับ
customer

string

เอาต์พุตเท่านั้น ลูกค้าที่อยู่ในป้ายกำกับนี้ เช่น "customers/123abc789"
properties

object (Properties)

ต้องระบุ คุณสมบัติพื้นฐานของป้ายกำกับ
lifecycle

object (Lifecycle)

เอาต์พุตเท่านั้น สถานะวงจรของป้ายกํากับ ซึ่งรวมถึงสถานะเผยแพร่ เลิกใช้งาน และมีการเปลี่ยนแปลงฉบับร่าง
displayHints

object (DisplayHints)

เอาต์พุตเท่านั้น UI แสดงคำแนะนำสำหรับการแสดงผลป้ายกำกับ
appliedCapabilities

object (AppliedCapabilities)

เอาต์พุตเท่านั้น ความสามารถที่เกี่ยวข้องกับป้ายกํากับนี้ในข้อมูลเมตาที่ใช้
schemaCapabilities

object (SchemaCapabilities)

เอาต์พุตเท่านั้น ความสามารถของผู้ใช้ในป้ายกำกับนี้
appliedLabelPolicy

object (AppliedLabelPolicy)

เอาต์พุตเท่านั้น ลักษณะการทำงานของป้ายกำกับนี้เมื่อใช้กับรายการในไดรฟ์
fields[]

object (Field)

รายการช่องตามลำดับความสำคัญจากมากไปหาน้อย
learnMoreUri

string

URL ที่กำหนดเองเพื่อนำเสนอแก่ผู้ใช้เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับป้ายกำกับนี้และวิธีที่ควรใช้
lockStatus

object (LockStatus)

เอาต์พุตเท่านั้น สถานะการล็อกของป้ายกำกับนี้

LabelType

ประเภทของป้ายกำกับนี้

Enum
LABEL_TYPE_UNSPECIFIED ประเภทป้ายกำกับที่ไม่รู้จัก
SHARED และอาจแชร์ป้ายกำกับที่แชร์กับผู้ใช้เพื่อนำไปใช้กับรายการในไดรฟ์
ADMIN ป้ายกำกับที่ผู้ดูแลระบบเป็นเจ้าของ เฉพาะผู้ดูแลระบบเท่านั้นที่สามารถสร้างและแก้ไขได้ รองรับฟีเจอร์เพิ่มเติมบางอย่างสำหรับผู้ดูแลระบบเท่านั้น

UserInfo

ข้อมูลเกี่ยวกับผู้ใช้

การแสดง JSON 
{
  "person": string
}
ช่อง
person

string

ตัวระบุสำหรับผู้ใช้รายนี้ที่สามารถใช้กับ People API เพื่อดูข้อมูลเพิ่มเติม เช่น people/12345678

พร็อพเพอร์ตี้

คุณสมบัติพื้นฐานของป้ายกำกับ

การแสดง JSON 
{
  "title": string,
  "description": string
}
ช่อง
title

string

ต้องระบุ ชื่อป้ายกำกับ
description

string

คำอธิบายของป้ายกำกับ

อายุการใช้งาน

สถานะวงจรของออบเจ็กต์ เช่น ป้ายกํากับ ฟิลด์ หรือตัวเลือก วงจรจะบังคับใช้การเปลี่ยนต่อไปนี้

  • UNPUBLISHED_DRAFT (สถานะเริ่มต้น)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (ลบแล้ว)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (ลบแล้ว)

สถานะ "เผยแพร่แล้ว" และ "ปิดใช้" มีลักษณะที่แตกต่างกัน ดังนี้

  • เผยแพร่แล้ว - อาจมีการเปลี่ยนแปลงบางอย่างเกิดขึ้นกับออบเจ็กต์ที่อยู่ในสถานะนี้ ซึ่งในกรณีนี้ hasUnpublishedChanges จะเป็นจริง นอกจากนี้ยังไม่อนุญาตให้ทำการเปลี่ยนแปลงบางประเภท โดยทั่วไป การเปลี่ยนแปลงใดๆ ที่อาจทำให้ใช้งานไม่ได้หรือทำให้เกิดข้อจำกัดใหม่ๆ สำหรับข้อมูลเมตาที่มีอยู่ซึ่งเกี่ยวข้องกับป้ายกำกับจะถูกปฏิเสธ
  • ปิดใช้ - เมื่อปิดใช้ DisabledPolicy ที่กำหนดค่าไว้จะมีผล
การแสดง JSON 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
ช่อง
state

enum (State)

เอาต์พุตเท่านั้น สถานะของออบเจ็กต์ที่เชื่อมโยงกับวงจรนี้
hasUnpublishedChanges

boolean

เอาต์พุตเท่านั้น ออบเจ็กต์ที่เชื่อมโยงกับวงจรนี้มีการเปลี่ยนแปลงที่ยังไม่ได้เผยแพร่หรือไม่
disabledPolicy

object (DisabledPolicy)

นโยบายที่ควบคุมวิธีแสดงป้ายกำกับ ช่อง หรือตัวเลือกการเลือกที่ปิดใช้

รัฐ

สถานะของออบเจ็กต์ที่เชื่อมโยงกับวงจรนี้

Enum
STATE_UNSPECIFIED สถานะที่ไม่รู้จัก
UNPUBLISHED_DRAFT สถานะเริ่มต้นของออบเจ็กต์ เมื่อเผยแพร่แล้ว ออบเจ็กต์จะไม่กลับสู่สถานะนี้อีก เมื่อเผยแพร่ออบเจ็กต์แล้ว การเปลี่ยนแปลงบางประเภทจะไม่ได้รับอนุญาตอีกต่อไป
PUBLISHED เผยแพร่ออบเจ็กต์แล้ว ออบเจ็กต์อาจมีการเปลี่ยนแปลงฉบับร่างที่ยังไม่ได้เผยแพร่ตามที่ hasUnpublishedChanges ระบุไว้
DISABLED ออบเจ็กต์ได้รับการเผยแพร่และปิดใช้ตั้งแต่นั้นเป็นต้นมา ออบเจ็กต์อาจมีการเปลี่ยนแปลงฉบับร่างที่ยังไม่ได้เผยแพร่ตามที่ hasUnpublishedChanges ระบุไว้
DELETED ลบออบเจ็กต์แล้ว

DisabledPolicy

นโยบายที่ควบคุมวิธีจัดการป้ายกำกับ ช่อง หรือตัวเลือกการเลือกที่ปิดใช้ในบริบทต่างๆ

การแสดง JSON 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
ช่อง
showInApply

boolean

แสดงออบเจ็กต์ที่ปิดใช้นี้ในเมนู "ใช้" บนรายการในไดรฟ์หรือไม่

  • เมื่อ true โดยทั่วไปออบเจ็กต์จะแสดงใน UI เป็นปิดใช้และจะเลือกไม่ได้
  • เมื่อ false โดยทั่วไปวัตถุจะซ่อนอยู่ใน UI

DisplayHints

UI แสดงคำแนะนำสำหรับการแสดงผลป้ายกำกับ

การแสดง JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
ช่อง
disabled

boolean

ต้องการให้ป้ายกำกับแสดงใน UI เป็นปิดใช้ไหม
shownInApply

boolean

ป้ายกำกับนี้ควรปรากฏในเมนู "นำไปใช้" เมื่อใช้ค่ากับรายการในไดรฟ์
priority

string (int64 format)

ลำดับเพื่อแสดงป้ายกำกับในรายการ

AppliedCapabilities

ความสามารถของผู้ใช้ในข้อมูลเมตาที่ใช้ของป้ายกำกับนี้

การแสดง JSON 
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
ช่อง
canRead

boolean

ผู้ใช้อ่านข้อมูลเมตาที่ใช้ซึ่งเกี่ยวข้องกับป้ายกํากับนี้ได้หรือไม่
canApply

boolean

ผู้ใช้สามารถใช้ป้ายกํากับนี้กับรายการได้หรือไม่
canRemove

boolean

ผู้ใช้นำป้ายกำกับนี้ออกจากรายการได้หรือไม่

SchemaCapabilities

ความสามารถที่เกี่ยวข้องกับป้ายกำกับนี้เมื่อแก้ไขป้ายกำกับ

การแสดง JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
ช่อง
canUpdate

boolean

ผู้ใช้เปลี่ยนป้ายกำกับได้หรือไม่
canDelete

boolean

ผู้ใช้ลบป้ายกำกับนี้หรือไม่ ผู้ใช้ต้องมีสิทธิ์และต้องปิดใช้ป้ายกำกับ
canDisable

boolean

ผู้ใช้ปิดใช้ป้ายกำกับนี้หรือไม่ ผู้ใช้ต้องมีสิทธิ์และป้ายกํากับนี้จะต้องไม่ปิดใช้อยู่แล้ว
canEnable

boolean

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

AppliedLabelPolicy

ลักษณะการทำงานของป้ายกำกับนี้เมื่อใช้กับรายการในไดรฟ์

การแสดง JSON 
{
  "copyMode": enum (CopyMode)
}
ช่อง
copyMode

enum (CopyMode)

ระบุวิธีการคัดลอกค่าป้ายกำกับและช่องที่ใช้เมื่อมีการคัดลอกรายการในไดรฟ์

CopyMode

ระบุวิธีการคัดลอกค่าป้ายกำกับและช่องที่ใช้เมื่อมีการคัดลอกรายการในไดรฟ์

Enum
COPY_MODE_UNSPECIFIED ไม่ได้ระบุโหมดคัดลอก
DO_NOT_COPY โดยค่าเริ่มต้น ระบบจะไม่คัดลอกป้ายกํากับและค่าในช่องที่ใช้เมื่อมีการคัดลอกรายการในไดรฟ์ที่ใช้
ALWAYS_COPY ระบบจะคัดลอกป้ายกํากับและค่าในช่องที่ใช้เสมอเมื่อมีการคัดลอกรายการในไดรฟ์ที่ใช้ มีเพียงผู้ดูแลระบบเท่านั้นที่ใช้โหมดนี้ได้
COPY_APPLIABLE ระบบจะคัดลอกค่าของป้ายกำกับและช่องที่ใช้หากผู้ใช้ที่ทําสําเนาสามารถใช้ป้ายกํากับได้

ฟิลด์

กำหนดฟิลด์ที่มีชื่อที่แสดง ประเภทข้อมูล และตัวเลือกการกำหนดค่าอื่นๆ ช่องนี้จะกำหนดประเภทข้อมูลเมตาที่อาจตั้งค่าในรายการในไดรฟ์

การแสดง JSON 
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
ช่อง
id

string

เอาต์พุตเท่านั้น คีย์ของช่อง ไม่ซ้ำกันภายในป้ายกำกับหรือไลบรารี

ค่านี้จะสร้างขึ้นโดยอัตโนมัติ ตรงกับนิพจน์ทั่วไป: ([a-zA-Z0-9])+
queryKey

string

เอาต์พุตเท่านั้น คีย์ที่จะใช้เมื่อสร้างคำค้นหาในไดรฟ์เพื่อค้นหาไฟล์ตามค่าที่กำหนดไว้ในช่องนี้ในไฟล์ เช่น "{queryKey} > 2001-01-01"
properties

object (Properties)

คุณสมบัติพื้นฐานของฟิลด์
lifecycle

object (Lifecycle)

เอาต์พุตเท่านั้น วงจรชีวิตของฟิลด์นี้
displayHints

object (DisplayHints)

เอาต์พุตเท่านั้น คำแนะนำในการแสดงผลฟิลด์ใน UI
schemaCapabilities

object (SchemaCapabilities)

เอาต์พุตเท่านั้น ความสามารถของผู้ใช้เมื่อแก้ไขช่องนี้
appliedCapabilities

object (AppliedCapabilities)

เอาต์พุตเท่านั้น ความสามารถที่ผู้ใช้รายนี้มีในช่องนี้และค่าเมื่อใช้ป้ายกำกับกับรายการในไดรฟ์
creator

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างช่องนี้
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างช่องนี้
updater

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่แก้ไขช่องนี้
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่มีการอัปเดตช่องนี้
publisher

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่เผยแพร่ช่องนี้ ค่านี้ไม่มีความหมายเมื่อไม่ได้เผยแพร่ช่องนี้
disabler

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่ปิดใช้ช่องนี้ ค่านี้ไม่มีความหมายเมื่อไม่ได้ปิดใช้ช่องนี้
disableTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ปิดใช้ช่องนี้ ค่านี้ไม่มีความหมายเมื่อไม่ได้ปิดใช้ช่องนี้
lockStatus

object (LockStatus)

เอาต์พุตเท่านั้น สถานะการล็อกของฟิลด์นี้
ฟิลด์การรวม type ประเภทข้อมูลและตัวเลือกของช่องนี้ เมื่อเผยแพร่แล้ว คุณจะเปลี่ยนประเภทข้อมูลไม่ได้ type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
textOptions

object (TextOptions)

ตัวเลือกช่องข้อความ
integerOptions

object (IntegerOptions)

ตัวเลือกช่องจำนวนเต็ม
dateOptions

object (DateOptions)

ตัวเลือกของช่องวันที่
selectionOptions

object (SelectionOptions)

ตัวเลือกของช่องสำหรับการเลือก
userOptions

object (UserOptions)

ตัวเลือกช่องผู้ใช้

TextOptions

ตัวเลือกสำหรับประเภทช่องข้อความ

การแสดง JSON 
{
  "minLength": integer,
  "maxLength": integer
}
ช่อง
minLength

integer

เอาต์พุตเท่านั้น ความยาวขั้นต่ำที่ถูกต้องของค่าในช่องข้อความ
maxLength

integer

เอาต์พุตเท่านั้น ความยาวสูงสุดของค่าที่ถูกต้องในช่องข้อความ

IntegerOptions

ตัวเลือกสำหรับประเภทฟิลด์จำนวนเต็ม

การแสดง JSON 
{
  "minValue": string,
  "maxValue": string
}
ช่อง
minValue

string (int64 format)

เอาต์พุตเท่านั้น ค่าต่ำสุดที่ถูกต้องของฟิลด์จำนวนเต็ม
maxValue

string (int64 format)

เอาต์พุตเท่านั้น ค่าสูงสุดที่ถูกต้องที่ถูกต้องในฟิลด์จำนวนเต็ม

DateOptions

ตัวเลือกสำหรับประเภทช่องวันที่

การแสดง JSON 
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
ช่อง
dateFormatType

enum (DateFormat)

ตัวเลือกการจัดรูปแบบวันที่ที่แปลแล้ว ค่าของช่องจะแสดงผลในรูปแบบนี้ตามประเทศ
dateFormat

string

เอาต์พุตเท่านั้น รูปแบบวันที่ ICU
minValue

object (Date)

เอาต์พุตเท่านั้น ค่าต่ำสุดที่ใช้ได้ (ปี เดือน วัน)
maxValue

object (Date)

เอาต์พุตเท่านั้น ค่าสูงสุดที่ถูกต้อง (ปี เดือน วัน)

DateFormat

ตัวเลือกรูปแบบวันที่ที่แปลแล้ว

Enum
DATE_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบวันที่
LONG_DATE รวมชื่อเดือนแบบเต็ม เช่น 12 มกราคม 1999 (MMMM d, y)
SHORT_DATE สั้น ตัวเลข การนำเสนอ ตัวอย่างเช่น 12/13/99 (M/d/yy)

SelectionOptions

ตัวเลือกสำหรับประเภทฟิลด์การเลือก

การแสดง JSON 
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
ช่อง
listOptions

object (ListOptions)

เมื่อระบุแล้ว จะหมายความว่าช่องนี้รองรับรายการค่า เมื่อเผยแพร่ช่องนี้แล้วจะเปลี่ยนแปลงไม่ได้
choices[]

object (Choice)

ตัวเลือกที่มีให้สำหรับช่องตัวเลือกนี้ ลำดับรายการสอดคล้องกันและแก้ไขด้วย insertBeforeChoice แล้ว

ListOptions

ตัวเลือกสำหรับรูปแบบที่มีหลายค่าของประเภทฟิลด์ที่เกี่ยวข้อง

การแสดง JSON 
{
  "maxEntries": integer
}
ช่อง
maxEntries

integer

จำนวนรายการสูงสุดที่อนุญาต

ทางเลือก

ช่องตัวเลือก

การแสดง JSON 
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
ช่อง
id

string

ค่าที่ไม่ซ้ำกันของตัวเลือก รหัสนี้สร้างขึ้นโดยอัตโนมัติ จับคู่นิพจน์ทั่วไป: ([a-zA-Z0-9_])+
properties

object (Properties)

พร็อพเพอร์ตี้พื้นฐานที่ต้องการ
lifecycle

object (Lifecycle)

เอาต์พุตเท่านั้น อายุการใช้งานที่เลือก
displayHints

object (DisplayHints)

เอาต์พุตเท่านั้น คำแนะนำในการแสดง UI สำหรับการแสดงผลตัวเลือก
schemaCapabilities

object (SchemaCapabilities)

เอาต์พุตเท่านั้น ความสามารถที่เกี่ยวข้องกับตัวเลือกนี้เมื่อแก้ไขตัวเลือก
appliedCapabilities

object (AppliedCapabilities)

เอาต์พุตเท่านั้น ความสามารถที่เกี่ยวข้องกับตัวเลือกนี้ในข้อมูลเมตาที่ใช้
creator

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างตัวเลือกนี้
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างตัวเลือกนี้
updater

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่อัปเดตตัวเลือกนี้เป็นอันดับสุดท้าย
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตตัวเลือกนี้ครั้งล่าสุด
publisher

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่เผยแพร่ตัวเลือกนี้ ค่านี้ไม่มีความหมายเมื่อตัวเลือกไม่ได้รับการเผยแพร่
publishTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เผยแพร่ตัวเลือกนี้ ค่านี้ไม่มีความหมายเมื่อตัวเลือกไม่ได้รับการเผยแพร่
disabler

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ใช้ที่ปิดใช้ตัวเลือกนี้ ค่านี้ไม่มีความหมายหากไม่ได้ปิดใช้ตัวเลือก
disableTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาตัวเลือกนี้ถูกปิดใช้งาน ค่านี้จะไม่มีความหมายเมื่อไม่ได้ปิดใช้ตัวเลือก
lockStatus

object (LockStatus)

เอาต์พุตเท่านั้น สถานะการล็อกของตัวเลือกนี้

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้พื้นฐานที่ต้องการ

การแสดง JSON 
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
ช่อง
displayName

string

ต้องระบุ ข้อความที่แสดงซึ่งจะระบุช่องนี้ใน UI
description

string

คำอธิบายของป้ายกำกับนี้
badgeConfig

object (BadgeConfig)

การกำหนดค่าป้ายสำหรับตัวเลือกนี้ เมื่อตั้งค่าแล้ว ป้ายกำกับที่เป็นเจ้าของตัวเลือกนี้จะถือว่าเป็น "ป้ายกำกับที่มีตราสถานะ"
insertBeforeChoice

string

อินพุตเท่านั้น แทรกหรือย้ายตัวเลือกนี้ก่อนตัวเลือกที่ระบุ หากเว้นว่างไว้ ระบบจะวางตัวเลือกไว้ที่ท้ายรายการ

BadgeConfig

สถานะป้ายของป้ายกำกับ

การแสดง JSON 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
ช่อง
color

object (Color)

สีของป้าย เมื่อไม่ได้ระบุ จะไม่มีการแสดงป้าย ระบบจะเปลี่ยนสีพื้นหลัง เบื้องหน้า และเดี่ยว (โหมดสว่างและมืด) ที่ตั้งค่าไว้ที่นี่ใน UI ของไดรฟ์ให้เป็นสีที่รองรับซึ่งใกล้เคียงที่สุด
priorityOverride

string (int64 format)

ลบล้างลำดับความสำคัญทั่วโลกเริ่มต้นของป้ายนี้ เมื่อกำหนดค่าเป็น 0 ระบบจะใช้การเรียนรู้ลำดับความสำคัญเริ่มต้น

DisplayHints

คำแนะนำในการแสดงตัวเลือก UI

การแสดง JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
ช่อง
disabled

boolean

ตัวเลือกควรแสดงใน UI เป็นปิดใช้หรือไม่
shownInApply

boolean

ตัวเลือกนี้ควรปรากฏในเมนู "นำไปใช้" เมื่อใช้ค่ากับรายการในไดรฟ์
badgeColors

object (BadgeColors)

สีที่ใช้สำหรับป้าย เปลี่ยนเป็นสีวัสดุของ Google ตาม properties.badge_config.color ที่เลือก
darkBadgeColors

object (BadgeColors)

โหมดมืดที่ใช้สำหรับป้าย เปลี่ยนเป็นสีวัสดุของ Google ตาม properties.badge_config.color ที่เลือก
badgePriority

string (int64 format)

ลำดับความสำคัญของป้ายนี้ ใช้เพื่อเปรียบเทียบและจัดเรียงป้ายต่างๆ ตัวเลขที่ต่ำกว่าหมายความว่าระบบควรแสดงป้ายก่อน เมื่อไม่มีการกำหนดค่าป้าย ค่านี้จะเป็น 0 มิเช่นนั้นจะตั้งค่าเป็น BadgeConfig.priority_override หรือการเรียนรู้เริ่มต้นซึ่งต้องการวันที่สร้างป้ายกำกับ และลำดับความสำคัญของช่องและตัวเลือก

BadgeColors

สีที่ได้จาก BadgeConfig และเปลี่ยนเป็นสีที่สนับสนุนซึ่งใกล้เคียงที่สุดที่แนะนำ

การแสดง JSON 
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
ช่อง
backgroundColor

object (Color)

เอาต์พุตเท่านั้น พื้นหลังป้ายที่จับคู่กับพื้นหน้า
foregroundColor

object (Color)

เอาต์พุตเท่านั้น ติดป้ายพื้นหน้าที่จับคู่กับพื้นหลัง
soloColor

object (Color)

เอาต์พุตเท่านั้น สีที่สามารถใช้สำหรับข้อความที่ไม่มีพื้นหลัง

SchemaCapabilities

ความสามารถที่เกี่ยวข้องกับตัวเลือกนี้เมื่อแก้ไขตัวเลือก

การแสดง JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
ช่อง
canUpdate

boolean

ผู้ใช้อัปเดตตัวเลือกนี้ได้หรือไม่
canDelete

boolean

ผู้ใช้ลบตัวเลือกนี้ได้หรือไม่
canDisable

boolean

ผู้ใช้ปิดใช้ตัวเลือกนี้ได้หรือไม่
canEnable

boolean

ผู้ใช้เปิดใช้ตัวเลือกนี้ได้หรือไม่

AppliedCapabilities

ความสามารถที่เกี่ยวข้องกับตัวเลือกนี้ในข้อมูลเมตาที่ใช้

การแสดง JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
ช่อง
canRead

boolean

ผู้ใช้อ่านข้อมูลเมตาที่เกี่ยวข้องที่ใช้ในรายการได้หรือไม่
canSelect

boolean

ผู้ใช้เลือกตัวเลือกนี้ในรายการได้หรือไม่

LockStatus

มีข้อมูลเกี่ยวกับว่าควรถือว่าคอมโพเนนต์ป้ายกำกับถูกล็อกหรือไม่

การแสดง JSON 
{
  "locked": boolean
}
ช่อง
locked

boolean

เอาต์พุตเท่านั้น ระบุว่าคอมโพเนนต์ป้ายกำกับนี้เป็นเป้าหมาย (โดยตรง) ของ LabelLock หรือไม่ คอมโพเนนต์ป้ายกำกับอาจล็อกโดยปริยาย แม้ว่าจะไม่ใช่เป้าหมายโดยตรงของ LabelLock ก็ตาม ซึ่งในกรณีนี้ช่องนี้จะตั้งค่าเป็น "เท็จ"

UserOptions

ตัวเลือกสำหรับประเภทฟิลด์ของผู้ใช้

การแสดง JSON 
{
  "listOptions": {
    object (ListOptions)
  }
}
ช่อง
listOptions

object (ListOptions)

เมื่อระบุแล้ว จะหมายความว่าฟิลด์นี้สนับสนุนรายการค่า เมื่อเผยแพร่ช่องนี้แล้วจะเปลี่ยนแปลงไม่ได้

พร็อพเพอร์ตี้

คุณสมบัติพื้นฐานของฟิลด์

การแสดง JSON 
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
ช่อง
displayName

string

ต้องระบุ ข้อความที่แสดงซึ่งจะระบุช่องนี้ใน UI
required

boolean

ช่องควรทำเครื่องหมายเป็นต้องระบุหรือไม่
insertBeforeField

string

อินพุตเท่านั้น แทรกหรือย้ายช่องนี้ก่อนช่องที่ระบุ หากเว้นว่างไว้ ระบบจะใส่ฟิลด์นี้ไว้ที่ท้ายรายการ

DisplayHints

คำแนะนำในการแสดงผลฟิลด์ใน UI

การแสดง JSON 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
ช่อง
required

boolean

ช่องควรแสดงตามที่จำเป็นใน UI ไหม
disabled

boolean

ช่องนี้ควรแสดงใน UI เป็นปิดใช้ไหม
shownInApply

boolean

ช่องนี้ควรแสดงในเมนู "นำไปใช้" เมื่อใช้ค่ากับรายการในไดรฟ์

SchemaCapabilities

ความสามารถที่เกี่ยวข้องกับฟิลด์นี้เมื่อแก้ไขฟิลด์

การแสดง JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
ช่อง
canUpdate

boolean

ผู้ใช้เปลี่ยนค่าในช่องนี้ได้หรือไม่
canDelete

boolean

ผู้ใช้ลบช่องนี้ได้หรือไม่ ผู้ใช้ต้องมีสิทธิ์และช่องนี้จะต้องเลิกใช้งานแล้ว
canDisable

boolean

ผู้ใช้ปิดใช้ช่องนี้ได้หรือไม่ ผู้ใช้ต้องมีสิทธิ์และช่องนี้จะต้องไม่ปิดใช้อยู่แล้ว
canEnable

boolean

ผู้ใช้เปิดใช้ช่องนี้ได้หรือไม่ ผู้ใช้ต้องมีสิทธิ์และต้องปิดใช้ช่องนี้

AppliedCapabilities

ความสามารถที่เกี่ยวข้องกับฟิลด์นี้ในข้อมูลเมตาที่ใช้

การแสดง JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
ช่อง
canRead

boolean

ผู้ใช้อ่านข้อมูลเมตาที่เกี่ยวข้องที่ใช้ในรายการได้หรือไม่
canWrite

boolean

ผู้ใช้ตั้งค่าช่องนี้ในรายการในไดรฟ์ได้หรือไม่

วิธีการ

create

 สร้างป้ายกำกับใหม่

delete

 ลบป้ายกำกับและข้อมูลเมตาที่เกี่ยวข้องในรายการในไดรฟ์อย่างถาวร

delta

 อัปเดตป้ายกำกับเดียวโดยใช้ชุดคำขออัปเดตซึ่งจะทำให้มีการแก้ไขฉบับร่างใหม่

disable

 ปิดใช้ป้ายกำกับที่เผยแพร่แล้ว

enable

 เปิดใช้ป้ายกำกับที่ปิดใช้และคืนค่าเป็นสถานะเผยแพร่แล้ว

get

 รับป้ายกำกับตามชื่อทรัพยากร

list

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

publish

 เผยแพร่การเปลี่ยนแปลงฉบับร่างทั้งหมดไปยังป้ายกำกับ

updateLabelCopyMode

 อัปเดตCopyModeของป้ายกำกับ

updatePermissions

 อัปเดตสิทธิ์ของป้ายกำกับ