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 ของป้ายกำกับนี้

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)

เอาต์พุตเท่านั้น 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 (d MMMM y)
SHORT_DATE สั้น ตัวเลข เป็นตัวแทน เช่น 12/13/99 (M/d/yy)

วันที่

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

  • วันที่แบบเต็ม โดยมีค่าปี เดือน และวันที่ไม่ใช่ 0
  • 1 เดือนและวัน โดยมี 0 ปี (เช่น วันครบรอบ)
  • ปีหนึ่งๆ มี 0 เดือนและมี 0 วัน
  • 1 ปีและเดือน โดยมี 0 วัน (เช่น วันที่หมดอายุของบัตรเครดิต)

ประเภทที่เกี่ยวข้อง:

การแสดง JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
ช่อง
year

integer

ปีของวันที่ ต้องเป็นตัวเลขตั้งแต่ 1 ถึง 9999 หรือ 0 เพื่อระบุวันที่ที่ไม่มีปี
month

integer

เดือนของปี ต้องมีค่าตั้งแต่ 1 ถึง 12 หรือ 0 เพื่อระบุปีที่ไม่มีเดือนและวัน
day

integer

วันของเดือน ต้องมีค่าตั้งแต่ 1 ถึง 31 และจะใช้ได้สำหรับปีและเดือน หรือ 0 เพื่อระบุปีเพียงอย่างเดียว หรือ 1 ปีและเดือนที่วันไม่มีนัยสำคัญ

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)

เอาต์พุตเท่านั้น 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 ระบบจะใช้การเรียนรู้ที่มีลำดับความสำคัญเริ่มต้น

สี

แสดงสีในพื้นที่สี RGBA การนำเสนอนี้ออกแบบมาให้ง่ายต่อการแปลงเป็นและจากการแสดงสีในภาษาต่างๆ ที่กระชับได้ใจความ ตัวอย่างเช่น ช่องของการนำเสนอนี้สามารถใส่เล็กน้อยให้กับเครื่องมือสร้าง java.awt.Color ใน Java สามารถระบุเมธอด +colorWithRed:green:blue:alpha ของ UIColor ใน iOS ได้เพียงเล็กน้อย เพียงทำเล็กน้อยเท่านั้น คุณก็สามารถจัดรูปแบบเป็นสตริง CSS rgba() ใน JavaScript ได้อย่างง่ายดาย

หน้าอ้างอิงนี้ไม่มีข้อมูลเกี่ยวกับพื้นที่สีสัมบูรณ์ที่ควรใช้ในการตีความค่า RGB เช่น sRGB, Adobe RGB, DCI-P3 และ BT.2020 โดยค่าเริ่มต้น แอปพลิเคชันควรใช้พื้นที่สี sRGB

เมื่อต้องตัดสินใจเลือกความเท่าเทียมกันของสี การติดตั้งใช้งานจะถือว่าสี 2 สีเท่ากัน เว้นแต่จะระบุไว้เป็นอย่างอื่น โดยค่าสีแดง เขียว น้ำเงิน และอัลฟ่าทั้งหมดต่างกันไม่เกิน 1e-5

ตัวอย่าง (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

ตัวอย่างเช่น (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

ตัวอย่าง (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
การแสดง JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
ช่อง
red

number

ปริมาณสีแดงของสีเป็นค่าในช่วง [0, 1]
green

number

ปริมาณสีเขียวของสีเป็นค่าในช่วง [0, 1]
blue

number

ปริมาณของสีน้ำเงินเป็นค่าในช่วง [0, 1]
alpha

number

เศษส่วนของสีนี้ที่ควรใช้กับพิกเซล กล่าวคือ สีของพิกเซลสุดท้ายจะกำหนดโดยสมการต่อไปนี้

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

หมายความว่าค่า 1.0 จะเท่ากับสีทึบ ในขณะที่ค่า 0.0 คือสีที่โปร่งใสทั้งหมด การดำเนินการนี้จะใช้ข้อความ Wrapper แทนสเกลาร์ Float แบบง่ายเพื่อให้แยกความแตกต่างระหว่างค่าเริ่มต้นกับค่าที่ไม่ได้ตั้งค่าได้ หากละเว้น วัตถุสีนี้จะแสดงเป็นสีทึบ (เสมือนว่าค่าอัลฟ่าได้รับค่าเป็น 1.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 Material ตาม properties.badge_config.color ที่เลือกแล้ว
darkBadgeColors

object (BadgeColors)

สีในโหมดมืดที่จะใช้กับป้าย เปลี่ยนเป็นสี Google Material ตาม 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

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