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)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
ช่อง
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 ของป้ายกำกับนี้
enabledAppSettings

object (EnabledAppSettings)

ไม่บังคับ EnabledAppSettings สำหรับป้ายกำกับนี้

LabelType

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

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

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 (MMMM d, y)
SHORT_DATE การนำเสนอแบบตัวเลขสั้นๆ เช่น 12/13/99 (M/d/yy)

วันที่

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

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

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

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

integer

ปีของวันที่ ต้องอยู่ในช่วง 1 ถึง 9999 หรือ 0 เพื่อระบุวันที่โดยไม่มีปี
month

integer

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

integer

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

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

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

EnabledAppSettings

อธิบายแอป Workspace ที่ใช้ป้ายกำกับได้

การแสดง JSON 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
ช่อง
enabledApps[]

object (EnabledApp)

ไม่บังคับ รายการแอปที่ใช้ป้ายกำกับได้

EnabledApp

แอปที่ใช้ป้ายกำกับได้

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

enum (App)

ไม่บังคับ ชื่อแอป

แอป

ชุดแอป Workspace ที่เป็นไปได้ซึ่งใช้ป้ายกำกับได้

Enum
APP_UNSPECIFIED ไม่ระบุ
DRIVE ไดรฟ์
GMAIL Gmail

เมธอด

create

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

delete

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

delta

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

disable

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

enable

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

get

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

list

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

publish

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

updateLabelCopyMode

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

updateLabelEnabledAppSettings

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

updatePermissions

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