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 -> (ลบแล้ว)

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

  • Published: อาจมีการเปลี่ยนแปลงบางอย่างในออบเจ็กต์ในสถานะนี้ ในกรณีนี้ hasUnpublishedChanges จะเป็นจริง นอกจากนี้ เราไม่อนุญาตให้ทำการเปลี่ยนแปลงบางประเภท โดยทั่วไปแล้ว การเปลี่ยนแปลงใดๆ ที่จะทำให้ข้อมูลเมตาที่มีอยู่ซึ่งเกี่ยวข้องกับป้ายกำกับไม่ถูกต้องหรือทำให้เกิดข้อจำกัดใหม่จะถูกปฏิเสธ
  • Disabled: เมื่อปิดใช้ 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ของฟิลด์นี้
ฟิลด์ Union 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 (ด/ว/ป)

วันที่

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

  • วันที่แบบเต็ม โดยมีค่าปี เดือน และวันที่ที่ไม่ใช่ 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 ได้อย่างง่ายดาย และด้วยการทำงานเพียงเล็กน้อย ก็สามารถจัดรูปแบบให้เป็นสตริง rgba() ของ CSS ใน 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 แทนสเกลาร์แบบลอยตัวอย่างง่ายเพื่อให้แยกความแตกต่างระหว่างค่าเริ่มต้นกับค่าที่ไม่ได้ตั้งค่าได้ หากละเว้นไว้ ระบบจะแสดงออบเจ็กต์สีนี้เป็นสีทึบ (ราวกับว่าค่าอัลฟ่ามีค่าเป็น 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)

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

object (BadgeColors)

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

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

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

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

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

object (EnabledApp)

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

EnabledApp

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

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

enum (App)

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

แอป

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

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

เมธอด

create

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

delete

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

delta

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

disable

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

enable

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

get

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

list

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

publish

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

updateLabelCopyMode

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

updateLabelEnabledAppSettings

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

updatePermissions

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