- Resource: Label
- LabelType
- UserInfo
- Properti
- Siklus proses
- Status
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- Kolom
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- SelectionOptions
- ListOptions
- Pilihan
- Properti
- BadgeConfig
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus
- UserOptions
- Properti
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- Metode
Resource: Label
Label menentukan taksonomi yang dapat diterapkan ke item Drive untuk mengatur dan menelusuri seluruh item. Label dapat berupa string sederhana atau dapat berisi kolom yang mendeskripsikan metadata tambahan yang dapat digunakan lebih lanjut untuk mengatur dan menelusuri item Drive.
Representasi JSON |
---|
{ "name": string, "id": string, "revisionId": string, "labelType": enum ( |
Kolom | |
---|---|
name |
Hanya output. Nama resource label. Akan dalam bentuk: |
id |
Hanya output. ID unik global untuk label ini. ID merupakan bagian dari label |
revisionId |
Hanya output. ID Revisi label. ID Revisi mungkin merupakan bagian dari label |
labelType |
Wajib. Jenis label. |
creator |
Hanya output. Pengguna yang membuat label ini. |
createTime |
Hanya output. Waktu label ini dibuat. |
revisionCreator |
Hanya output. Pengguna yang membuat revisi label ini. |
revisionCreateTime |
Hanya output. Waktu revisi label ini dibuat. |
publisher |
Hanya output. Pengguna yang memublikasikan label ini. Nilai ini tidak memiliki arti jika label tidak dipublikasikan. |
publishTime |
Hanya output. Waktu label ini dipublikasikan. Nilai ini tidak memiliki arti jika label tidak dipublikasikan. |
disabler |
Hanya output. Pengguna yang menonaktifkan label ini. Nilai ini tidak memiliki arti jika label tidak dinonaktifkan. |
disableTime |
Hanya output. Waktu label ini dinonaktifkan. Nilai ini tidak memiliki arti jika label tidak dinonaktifkan. |
customer |
Hanya output. Pelanggan yang memiliki label ini. Misalnya: "pelanggan/123abc789". |
properties |
Wajib. Properti dasar label. |
lifecycle |
Hanya output. Status siklus proses label, termasuk apakah label dipublikasikan, tidak digunakan lagi, dan memiliki perubahan draf. |
displayHints |
Hanya output. UI menampilkan petunjuk untuk merender label. |
appliedCapabilities |
Hanya output. Kemampuan yang terkait dengan label ini pada metadata yang diterapkan. |
schemaCapabilities |
Hanya output. Kemampuan yang dimiliki pengguna pada label ini. |
appliedLabelPolicy |
Hanya output. Perilaku label ini saat diterapkan ke item Drive. |
fields[] |
Daftar kolom dalam urutan prioritas menurun. |
learnMoreUri |
URL kustom yang akan ditampilkan kepada pengguna agar mereka dapat mempelajari lebih lanjut label ini dan cara penggunaannya. |
lockStatus |
Hanya output. LockStatus label ini. |
LabelType
Jenis label ini.
Enum | |
---|---|
LABEL_TYPE_UNSPECIFIED |
Jenis label tidak diketahui. |
SHARED |
Label bersama dapat dibagikan kepada pengguna untuk diterapkan ke item Drive. |
ADMIN |
Label milik admin. Hanya dapat dibuat dan diedit oleh admin. Mendukung beberapa fitur tambahan khusus admin. |
UserInfo
Informasi tentang pengguna.
Representasi JSON |
---|
{ "person": string } |
Kolom | |
---|---|
person |
ID untuk pengguna ini yang dapat digunakan dengan People API untuk mendapatkan informasi lebih lanjut. Misalnya, orang/12345678. |
Properti
Properti dasar label.
Representasi JSON |
---|
{ "title": string, "description": string } |
Kolom | |
---|---|
title |
Wajib. Judul label. |
description |
Deskripsi label. |
Siklus Proses
Status siklus proses suatu objek, seperti label, kolom, atau pilihan. Siklus proses menerapkan transisi berikut:
UNPUBLISHED_DRAFT
(status awal)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
-> (Dihapus)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
-> (Dihapus)
Status yang dipublikasikan dan dinonaktifkan memiliki beberapa karakteristik yang berbeda:
- Dipublikasikan—Beberapa jenis perubahan mungkin dilakukan pada objek dalam status ini, dalam hal ini
hasUnpublishedChanges
akan bernilai benar (true). Selain itu, beberapa jenis perubahan tidak diizinkan. Umumnya, setiap perubahan yang akan membatalkan atau menyebabkan batasan baru pada metadata yang sudah ada yang terkait dengan label akan ditolak. - Dinonaktifkan—Jika dinonaktifkan,
DisabledPolicy
yang dikonfigurasi akan diterapkan.
Representasi JSON |
---|
{ "state": enum ( |
Kolom | |
---|---|
state |
Hanya output. Status objek yang terkait dengan siklus proses ini. |
hasUnpublishedChanges |
Hanya output. Apakah objek yang terkait dengan siklus proses ini memiliki perubahan yang belum dipublikasikan. |
disabledPolicy |
Kebijakan yang mengatur cara menampilkan pilihan label, kolom, atau pilihan yang dinonaktifkan. |
Negara Bagian
Status objek yang terkait dengan siklus proses ini.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status Tidak Diketahui. |
UNPUBLISHED_DRAFT |
Status awal suatu objek. Setelah dipublikasikan, objek tidak dapat dikembalikan ke status ini. Setelah objek dipublikasikan, jenis perubahan tertentu tidak lagi diizinkan. |
PUBLISHED |
Objek telah dipublikasikan. Objek mungkin memiliki perubahan draf yang belum dipublikasikan seperti yang ditunjukkan oleh hasUnpublishedChanges . |
DISABLED |
Objek telah dipublikasikan dan telah dinonaktifkan. Objek mungkin memiliki perubahan draf yang belum dipublikasikan seperti yang ditunjukkan oleh hasUnpublishedChanges . |
DELETED |
Objek telah dihapus. |
DisabledPolicy
Kebijakan yang mengatur cara menangani pilihan label, kolom, atau pilihan yang dinonaktifkan dalam berbagai konteks.
Representasi JSON |
---|
{ "hideInSearch": boolean, "showInApply": boolean } |
Kolom | |
---|---|
hideInSearch |
Apakah akan menyembunyikan objek yang dinonaktifkan ini di menu penelusuran untuk item Drive.
|
showInApply |
Apakah akan menampilkan objek yang dinonaktifkan ini dalam menu penerapan pada item Drive.
|
DisplayHints
UI menampilkan petunjuk untuk merender label.
Representasi JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "priority": string } |
Kolom | |
---|---|
disabled |
Apakah label harus ditampilkan di UI sebagai dinonaktifkan. |
shownInApply |
Label ini harus ditampilkan di menu terapkan saat menerapkan nilai ke item Drive. |
priority |
Urutkan untuk menampilkan label dalam daftar. |
AppliedCapabilities
Kemampuan yang dimiliki pengguna pada metadata yang diterapkan label ini.
Representasi JSON |
---|
{ "canRead": boolean, "canApply": boolean, "canRemove": boolean } |
Kolom | |
---|---|
canRead |
Apakah pengguna dapat membaca metadata yang diterapkan terkait dengan label ini. |
canApply |
Apakah pengguna dapat menerapkan label ini ke item. |
canRemove |
Apakah pengguna dapat menghapus label ini dari item. |
SchemaCapabilities
Kemampuan yang terkait dengan label ini saat mengedit label.
Representasi JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Kolom | |
---|---|
canUpdate |
Apakah pengguna dapat mengubah label ini. |
canDelete |
Apakah pengguna dapat menghapus label ini. Pengguna harus memiliki izin dan label harus dinonaktifkan. |
canDisable |
Apakah pengguna dapat menonaktifkan label ini. Pengguna harus memiliki izin dan label ini harus belum dinonaktifkan. |
canEnable |
Apakah pengguna dapat mengaktifkan label ini atau tidak. Pengguna harus memiliki izin dan label ini harus dinonaktifkan. |
AppliedLabelPolicy
Perilaku label ini saat diterapkan ke item Drive.
Representasi JSON |
---|
{
"copyMode": enum ( |
Kolom | |
---|---|
copyMode |
Menunjukkan cara label dan nilai kolom yang diterapkan harus disalin saat item Drive disalin. |
CopyMode
Menunjukkan cara label dan nilai kolom yang diterapkan harus disalin saat item Drive disalin.
Enum | |
---|---|
COPY_MODE_UNSPECIFIED |
Mode penyalinan tidak ditentukan. |
DO_NOT_COPY |
Label dan nilai kolom yang diterapkan tidak disalin secara default saat item Drive yang menerapkannya disalin. |
ALWAYS_COPY |
Label dan nilai kolom yang diterapkan selalu disalin saat item Drive yang menerapkannya disalin. Hanya admin yang dapat menggunakan mode ini. |
COPY_APPLIABLE |
Label dan nilai kolom yang diterapkan akan disalin jika label dapat diterapkan oleh pengguna yang membuat salinan. |
Kolom
Menentukan kolom yang memiliki nama tampilan, jenis data, dan opsi konfigurasi lainnya. Kolom ini menentukan jenis metadata yang dapat ditetapkan pada item Drive.
Representasi JSON |
---|
{ "id": string, "queryKey": string, "properties": { object ( |
Kolom | |
---|---|
id |
Hanya output. Kunci kolom, yang unik dalam label atau library. Nilai ini dibuat secara otomatis. Cocok dengan ekspresi reguler: |
queryKey |
Hanya output. Kunci yang digunakan saat membuat kueri penelusuran Drive untuk menemukan file berdasarkan nilai yang ditentukan untuk kolom ini pada file. Misalnya, " |
properties |
Properti dasar kolom. |
lifecycle |
Hanya output. Siklus proses kolom ini. |
displayHints |
Hanya output. Petunjuk tampilan UI untuk merender kolom. |
schemaCapabilities |
Hanya output. Kemampuan yang dimiliki pengguna ini saat mengedit kolom ini. |
appliedCapabilities |
Hanya output. Kemampuan yang dimiliki pengguna ini di kolom ini dan nilainya saat label diterapkan pada item Drive. |
creator |
Hanya output. Pengguna yang membuat kolom ini. |
createTime |
Hanya output. Waktu kolom ini dibuat. |
updater |
Hanya output. Pengguna yang mengubah kolom ini. |
updateTime |
Hanya output. Waktu kolom ini diperbarui. |
publisher |
Hanya output. Pengguna yang memublikasikan kolom ini. Nilai ini tidak memiliki arti jika kolom tidak dipublikasikan. |
disabler |
Hanya output. Pengguna yang menonaktifkan kolom ini. Nilai ini tidak memiliki arti jika kolom tidak dinonaktifkan. |
disableTime |
Hanya output. Waktu kolom ini dinonaktifkan. Nilai ini tidak memiliki arti jika kolom tidak dinonaktifkan. |
lockStatus |
Hanya output. LockStatus kolom ini. |
Kolom union type . Jenis data dan opsi kolom ini. Setelah dipublikasikan, jenis data tidak dapat diubah. type hanya ada berupa salah satu diantara berikut: |
|
textOptions |
Opsi kolom teks. |
integerOptions |
Opsi kolom bilangan bulat. |
dateOptions |
Opsi kolom tanggal. |
selectionOptions |
Opsi kolom pilihan. |
userOptions |
Opsi kolom pengguna. |
TextOptions
Opsi untuk jenis kolom Teks.
Representasi JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Kolom | |
---|---|
minLength |
Hanya output. Panjang nilai minimum yang valid untuk kolom teks. |
maxLength |
Hanya output. Panjang nilai maksimum yang valid untuk kolom teks. |
IntegerOptions
Opsi untuk jenis kolom Integer.
Representasi JSON |
---|
{ "minValue": string, "maxValue": string } |
Kolom | |
---|---|
minValue |
Hanya output. Nilai valid minimum untuk kolom bilangan bulat. |
maxValue |
Hanya output. Nilai valid maksimum untuk kolom bilangan bulat. |
DateOptions
Opsi untuk jenis kolom tanggal.
Representasi JSON |
---|
{ "dateFormatType": enum ( |
Kolom | |
---|---|
dateFormatType |
Opsi pemformatan tanggal yang dilokalkan. Nilai kolom dirender dalam format ini sesuai dengan lokalnya. |
dateFormat |
Hanya output. Format tanggal ICU. |
minValue |
Hanya output. Nilai valid minimum (tahun, bulan, hari). |
maxValue |
Hanya output. Nilai valid maksimum (tahun, bulan, hari). |
DateFormat
Opsi format tanggal yang dilokalkan.
Enum | |
---|---|
DATE_FORMAT_UNSPECIFIED |
Format tanggal tidak ditentukan. |
LONG_DATE |
Menyertakan nama bulan lengkap. Misalnya, 12 Januari 1999 (MMMM d, y) |
SHORT_DATE |
Singkat, numerik, representasi. Misalnya, 12/13/99 (M/d/yy) |
SelectionOptions
Opsi untuk jenis kolom pilihan.
Representasi JSON |
---|
{ "listOptions": { object ( |
Kolom | |
---|---|
listOptions |
Jika ditentukan, menunjukkan bahwa kolom ini mendukung daftar nilai. Setelah kolom dipublikasikan, kolom ini tidak dapat diubah. |
choices[] |
Opsi yang tersedia untuk kolom pilihan ini. Urutan daftar konsisten, dan diubah dengan |
ListOptions
Opsi untuk varian multi-nilai dari jenis kolom terkait.
Representasi JSON |
---|
{ "maxEntries": integer } |
Kolom | |
---|---|
maxEntries |
Jumlah entri maksimum yang diizinkan. |
Pilihan
Pilihan kolom pilihan.
Representasi JSON |
---|
{ "id": string, "properties": { object ( |
Kolom | |
---|---|
id |
Nilai unik pilihan. ID ini dibuat secara otomatis. Cocok dengan ekspresi reguler: |
properties |
Properti dasar pilihan. |
lifecycle |
Hanya output. Siklus proses pilihan. |
displayHints |
Hanya output. UI menampilkan petunjuk untuk merender pilihan. |
schemaCapabilities |
Hanya output. Kemampuan yang terkait dengan opsi ini saat mengedit opsi ini. |
appliedCapabilities |
Hanya output. Kemampuan yang terkait dengan pilihan ini pada metadata yang diterapkan. |
creator |
Hanya output. Pengguna yang membuat pilihan ini. |
createTime |
Hanya output. Waktu pilihan ini dibuat. |
updater |
Hanya output. Pengguna yang memperbarui pilihan ini terakhir. |
updateTime |
Hanya output. Waktu terakhir kali pilihan ini diperbarui. |
publisher |
Hanya output. Pengguna yang memublikasikan pilihan ini. Nilai ini tidak memiliki arti jika pilihan tidak dipublikasikan. |
publishTime |
Hanya output. Waktu pilihan ini dipublikasikan. Nilai ini tidak memiliki arti jika pilihan tidak dipublikasikan. |
disabler |
Hanya output. Pengguna yang menonaktifkan pilihan ini. Nilai ini tidak memiliki arti jika opsi tidak dinonaktifkan. |
disableTime |
Hanya output. Waktu pilihan ini dinonaktifkan. Nilai ini tidak memiliki arti jika pilihan tidak dinonaktifkan. |
lockStatus |
Hanya output. LockStatus pilihan ini. |
Properti
Properti dasar pilihan.
Representasi JSON |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
Kolom | |
---|---|
displayName |
Wajib. Teks tampilan yang akan ditampilkan di UI yang mengidentifikasi kolom ini. |
description |
Deskripsi label ini. |
badgeConfig |
Konfigurasi badge untuk pilihan ini. Jika ditetapkan, label yang memiliki pilihan ini dianggap sebagai "label dengan badge". |
insertBeforeChoice |
Hanya input. Sisipkan atau pindahkan pilihan ini sebelum pilihan yang ditunjukkan. Jika kosong, pilihan akan ditempatkan di akhir daftar. |
BadgeConfig
Status badge label.
Representasi JSON |
---|
{
"color": {
object ( |
Kolom | |
---|---|
color |
Warna badge. Jika tidak ditentukan, tidak ada badge yang dirender. Warna latar belakang, latar depan, dan tunggal (mode terang dan gelap) yang ditetapkan di sini diubah di UI Drive menjadi warna terdekat yang didukung. |
priorityOverride |
Ganti prioritas global default badge ini. Jika disetel ke 0, heuristik prioritas default akan digunakan. |
DisplayHints
UI menampilkan petunjuk untuk merender opsi.
Representasi JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "badgeColors": { object ( |
Kolom | |
---|---|
disabled |
Apakah opsi harus ditampilkan di UI sebagai dinonaktifkan. |
shownInApply |
Opsi ini akan ditampilkan di menu terapkan saat menerapkan nilai ke item Drive. |
badgeColors |
Warna yang akan digunakan untuk badge. Diubah menjadi warna Material Google berdasarkan |
darkBadgeColors |
Warna mode gelap yang akan digunakan untuk badge. Diubah menjadi warna Material Google berdasarkan |
badgePriority |
Prioritas badge ini. Digunakan untuk membandingkan dan mengurutkan antara beberapa badge. Angka yang lebih rendah berarti badge harus ditampilkan terlebih dahulu. Jika konfigurasi badge tidak ada, nilainya akan menjadi 0. Jika tidak, atribut ini akan ditetapkan ke |
BadgeColors
Warna yang berasal dari BadgeConfig dan diubah ke warna terdekat yang didukung dan direkomendasikan.
Representasi JSON |
---|
{ "backgroundColor": { object ( |
Kolom | |
---|---|
backgroundColor |
Hanya output. Latar belakang badge yang berpasangan dengan latar depan. |
foregroundColor |
Hanya output. Latar depan badge yang berpasangan dengan latar belakang. |
soloColor |
Hanya output. Warna yang dapat digunakan untuk teks tanpa latar belakang. |
SchemaCapabilities
Kemampuan yang terkait dengan pilihan ini saat mengedit pilihan.
Representasi JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Kolom | |
---|---|
canUpdate |
Apakah pengguna dapat memperbarui pilihan ini. |
canDelete |
Apakah pengguna dapat menghapus pilihan ini atau tidak. |
canDisable |
Apakah pengguna dapat menonaktifkan pilihan ini atau tidak. |
canEnable |
Apakah pengguna dapat mengaktifkan pilihan ini atau tidak. |
AppliedCapabilities
Kemampuan yang terkait dengan pilihan ini pada metadata yang diterapkan.
Representasi JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canSelect": boolean } |
Kolom | |
---|---|
canRead |
Apakah pengguna dapat membaca metadata terkait yang diterapkan pada item. |
canSearch |
Apakah pengguna dapat menggunakan pilihan ini dalam kueri penelusuran atau tidak. |
canSelect |
Apakah pengguna dapat memilih pilihan ini pada item. |
LockStatus
Berisi informasi tentang apakah komponen label harus dianggap terkunci.
Representasi JSON |
---|
{ "locked": boolean } |
Kolom | |
---|---|
locked |
Hanya output. Menunjukkan apakah komponen label ini adalah target (langsung) LabelLock. Komponen label dapat dikunci secara implisit meskipun komponen tersebut bukan target langsung LabelLock, dalam hal ini kolom ini disetel ke salah (false). |
UserOptions
Opsi untuk jenis kolom pengguna.
Representasi JSON |
---|
{
"listOptions": {
object ( |
Kolom | |
---|---|
listOptions |
Jika ditentukan, menunjukkan bahwa kolom ini mendukung daftar nilai. Setelah kolom dipublikasikan, kolom ini tidak dapat diubah. |
Properti
Properti dasar kolom.
Representasi JSON |
---|
{ "displayName": string, "required": boolean, "insertBeforeField": string } |
Kolom | |
---|---|
displayName |
Wajib. Teks tampilan yang akan ditampilkan di UI yang mengidentifikasi kolom ini. |
required |
Apakah kolom harus ditandai sebagai wajib diisi atau tidak. |
insertBeforeField |
Hanya input. Masukkan atau pindahkan kolom ini sebelum kolom yang ditunjukkan. Jika kosong, kolom ini akan ditempatkan di akhir daftar. |
DisplayHints
Petunjuk tampilan UI untuk merender kolom.
Representasi JSON |
---|
{ "required": boolean, "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean } |
Kolom | |
---|---|
required |
Apakah kolom harus ditampilkan sebagaimana diperlukan di UI. |
disabled |
Apakah kolom harus ditampilkan di UI sebagai dinonaktifkan. |
shownInApply |
Kolom ini harus ditampilkan di menu terapkan saat menerapkan nilai ke item Drive. |
SchemaCapabilities
Kemampuan yang terkait dengan kolom ini saat mengedit kolom.
Representasi JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Kolom | |
---|---|
canUpdate |
Apakah pengguna dapat mengubah kolom ini. |
canDelete |
Apakah pengguna dapat menghapus kolom ini. Pengguna harus memiliki izin dan kolom harus tidak digunakan lagi. |
canDisable |
Apakah pengguna dapat menonaktifkan kolom ini. Pengguna harus memiliki izin dan kolom ini harus belum dinonaktifkan. |
canEnable |
Apakah pengguna dapat mengaktifkan kolom ini. Pengguna harus memiliki izin dan kolom ini harus dinonaktifkan. |
AppliedCapabilities
Kemampuan yang terkait dengan kolom ini pada metadata yang diterapkan.
Representasi JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canWrite": boolean } |
Kolom | |
---|---|
canRead |
Apakah pengguna dapat membaca metadata terkait yang diterapkan pada item. |
canSearch |
Apakah pengguna dapat menelusuri item Drive yang merujuk kolom ini. |
canWrite |
Apakah pengguna dapat menetapkan kolom ini pada item Drive. |
Metode |
|
---|---|
|
Membuat Label baru. |
|
Menghapus Label dan metadata terkait secara permanen di Item Drive. |
|
Memperbarui Label tunggal dengan menerapkan kumpulan permintaan pembaruan yang menghasilkan revisi draf baru. |
|
Menonaktifkan Label yang dipublikasikan. |
|
Mengaktifkan Label yang dinonaktifkan dan memulihkannya ke status dipublikasikan. |
|
Mendapatkan label berdasarkan nama resource-nya. |
|
Mencantumkan label. |
|
Publikasikan semua perubahan draf ke Label. |
|
Memperbarui CopyMode Label. |
|
Memperbarui izin Label. |