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

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ํากันทั่วโลกของป้ายกํากับนี้ รหัสเป็นส่วนหนึ่งของป้ายกํากับ name แต่ต่างจาก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)

เอาต์พุตเท่านั้น LockStatus ของป้ายกํากับนี้

ประเภทป้ายกํากับ

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

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

ข้อมูลผู้ใช้

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

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

string

ตัวระบุของผู้ใช้รายนี้เพื่อใช้กับ People API เพื่อดูข้อมูลเพิ่มเติม เช่น ผู้คน/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 ลบออบเจ็กต์แล้ว

นโยบายที่ปิดใช้อยู่

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

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

boolean

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

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

คําแนะนําเกี่ยวกับดิสเพลย์

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

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

boolean

ป้ายกํากับควรแสดงใน UI ว่าปิดใช้หรือไม่

shownInApply

boolean

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

priority

string (int64 format)

ลําดับที่จะแสดงป้ายกํากับในรายการ

ความสามารถในการประยุกต์ใช้

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

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

boolean

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

canApply

boolean

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

canRemove

boolean

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

ความสามารถของสคีมา

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

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

boolean

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

canDelete

boolean

ผู้ใช้จะลบป้ายกํากับนี้ได้หรือไม่ ผู้ใช้ต้องได้รับอนุญาตและต้องปิดใช้ป้ายกํากับ

canDisable

boolean

ผู้ใช้จะปิดใช้ป้ายกํากับนี้ได้หรือไม่ ผู้ใช้ต้องได้รับอนุญาตและต้องไม่ปิดใช้ป้ายกํากับนี้

canEnable

boolean

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

นโยบายป้ายกํากับที่ใช้

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

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

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

เอาต์พุตเท่านั้น LockStatus ของช่องนี้

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

object (TextOptions)

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

integerOptions

object (IntegerOptions)

ตัวเลือกช่องจํานวนเต็ม

dateOptions

object (DateOptions)

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

selectionOptions

object (SelectionOptions)

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

userOptions

object (UserOptions)

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

ตัวเลือกข้อความ

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

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

integer

เอาต์พุตเท่านั้น ความยาวขั้นต่ําของค่าที่ใช้ได้สําหรับช่องข้อความ

maxLength

integer

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

ตัวเลือกจํานวนเต็ม

ตัวเลือกประเภทช่องจํานวนเต็ม

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

string (int64 format)

เอาต์พุตเท่านั้น ค่าที่ถูกต้องขั้นต่ําสําหรับช่องจํานวนเต็ม

maxValue

string (int64 format)

เอาต์พุตเท่านั้น ค่าที่ถูกต้องสูงสุดสําหรับช่องจํานวนเต็ม

ตัวเลือกวันที่

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

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

enum (DateFormat)

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

dateFormat

string

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

minValue

object (Date)

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

maxValue

object (Date)

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

รูปแบบวันที่

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

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

ตัวเลือกการเลือก

ตัวเลือกประเภทช่องการเลือก

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

object (ListOptions)

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

choices[]

object (Choice)

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

ตัวเลือกรายการ

ตัวเลือกสําหรับตัวแปรที่มีค่าหลายค่าของประเภทช่องที่เชื่อมโยง

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

integer

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

Choice

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

การแสดง 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)

เอาต์พุตเท่านั้น LockStatus ของตัวเลือกนี้

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

พร็อพเพอร์ตี้พื้นฐานของตัวเลือก

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

string

ต้องระบุ ข้อความที่แสดงเพื่อแสดงใน UI ที่ระบุช่องนี้

description

string

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

badgeConfig

object (BadgeConfig)

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

insertBeforeChoice

string

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

การกําหนดค่าป้าย

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

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

object (Color)

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

priorityOverride

string (int64 format)

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

คําแนะนําเกี่ยวกับดิสเพลย์

คําแนะนําการแสดง UI สําหรับการแสดงผลตัวเลือก

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

boolean

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

shownInApply

boolean

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

badgeColors

object (BadgeColors)

สีที่จะใช้สําหรับป้าย เปลี่ยนเป็น Material ของ Google ตาม properties.badge_config.color ที่เลือก

darkBadgeColors

object (BadgeColors)

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

badgePriority

string (int64 format)

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

สีป้าย

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

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

object (Color)

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

foregroundColor

object (Color)

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

soloColor

object (Color)

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

ความสามารถของสคีมา

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

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

boolean

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

canDelete

boolean

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

canDisable

boolean

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

canEnable

boolean

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

ความสามารถในการประยุกต์ใช้

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

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

boolean

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

canSelect

boolean

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

สถานะการล็อก

มีข้อมูลเกี่ยวกับว่าคอมโพเนนต์ป้ายกํากับควรได้รับการพิจารณาหรือไม่

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

boolean

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

ตัวเลือกสําหรับผู้ใช้

ตัวเลือกประเภทช่องผู้ใช้

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

object (ListOptions)

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

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

พร็อพเพอร์ตี้พื้นฐานของช่อง

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

string

ต้องระบุ ข้อความที่แสดงเพื่อแสดงใน UI ที่ระบุช่องนี้

required

boolean

ช่องนี้ควรทําเครื่องหมายเป็นช่องที่ต้องกรอกหรือไม่

insertBeforeField

string

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

คําแนะนําเกี่ยวกับดิสเพลย์

คําแนะนําการแสดง UI สําหรับการแสดงผลช่อง

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

boolean

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

disabled

boolean

ช่องควรแสดงใน UI ว่าปิดใช้หรือไม่

shownInApply

boolean

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

ความสามารถของสคีมา

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

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

boolean

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

canDelete

boolean

ผู้ใช้จะลบช่องนี้ได้หรือไม่ ผู้ใช้ต้องได้รับอนุญาตและต้องเลิกใช้งานช่องนี้

canDisable

boolean

ผู้ใช้จะปิดใช้ช่องนี้ได้หรือไม่ ผู้ใช้ต้องได้รับอนุญาตและต้องไม่ปิดใช้ช่องนี้

canEnable

boolean

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

ความสามารถในการประยุกต์ใช้

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

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

boolean

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

canWrite

boolean

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

วิธีการ

create

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

delete

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

delta

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

disable

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

enable

เปิดใช้ป้ายกํากับที่ปิดใช้และกู้คืนไปยังสถานะที่เผยแพร่

get

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

list

รายการป้ายกํากับ

publish

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

updateLabelCopyMode

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

updatePermissions

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