REST Resource: labels

{
  "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)
  }
}

string

Hanya output. Nama resource label. Akan dalam bentuk: labels/{id} atau labels/{id}@{revisionId}, bergantung pada permintaannya. Lihat id dan revisionId di bawah.

string

Hanya output. ID unik global untuk label ini. ID merupakan bagian dari label name, tetapi tidak seperti name, ID bersifat konsisten di antara revisi. Cocok dengan ekspresi reguler: ([a-zA-Z0-9])+

string

Hanya output. ID Revisi label. ID Revisi mungkin merupakan bagian dari label name, bergantung pada permintaan yang diajukan. Revisi baru dibuat setiap kali properti revisi label diubah. Cocok dengan ekspresi reguler: ([a-zA-Z0-9])+

enum (LabelType)

Wajib. Jenis label.

object (UserInfo)

Hanya output. Pengguna yang membuat label ini.

string (Timestamp format)

Hanya output. Waktu label ini dibuat.

object (UserInfo)

Hanya output. Pengguna yang membuat revisi label ini.

string (Timestamp format)

Hanya output. Waktu revisi label ini dibuat.

object (UserInfo)

Hanya output. Pengguna yang memublikasikan label ini. Nilai ini tidak memiliki arti jika label tidak dipublikasikan.

string (Timestamp format)

Hanya output. Waktu label ini dipublikasikan. Nilai ini tidak memiliki arti jika label tidak dipublikasikan.

object (UserInfo)

Hanya output. Pengguna yang menonaktifkan label ini. Nilai ini tidak memiliki arti jika label tidak dinonaktifkan.

string (Timestamp format)

Hanya output. Waktu label ini dinonaktifkan. Nilai ini tidak memiliki arti jika label tidak dinonaktifkan.

string

Hanya output. Pelanggan yang memiliki label ini. Misalnya: "pelanggan/123abc789".

object (Properties)

Wajib. Properti dasar label.

object (Lifecycle)

Hanya output. Status siklus proses label, termasuk apakah label dipublikasikan, tidak digunakan lagi, dan memiliki perubahan draf.

object (DisplayHints)

Hanya output. UI menampilkan petunjuk untuk merender label.

object (AppliedCapabilities)

Hanya output. Kemampuan yang terkait dengan label ini pada metadata yang diterapkan.

object (SchemaCapabilities)

Hanya output. Kemampuan yang dimiliki pengguna pada label ini.

object (AppliedLabelPolicy)

Hanya output. Perilaku label ini saat diterapkan ke item Drive.

object (Field)

Daftar kolom dalam urutan prioritas menurun.

string

URL kustom yang akan ditampilkan kepada pengguna agar mereka dapat mempelajari lebih lanjut label ini dan cara penggunaannya.

object (LockStatus)

Hanya output. LockStatus label ini.

{
  "person": string
}

string

ID untuk pengguna ini yang dapat digunakan dengan People API untuk mendapatkan informasi lebih lanjut. Misalnya, orang/12345678.

{
  "title": string,
  "description": string
}

string

Wajib. Judul label.

string

Deskripsi label.

{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}

enum (State)

Hanya output. Status objek yang terkait dengan siklus proses ini.

boolean

Hanya output. Apakah objek yang terkait dengan siklus proses ini memiliki perubahan yang belum dipublikasikan.

object (DisabledPolicy)

Kebijakan yang mengatur cara menampilkan pilihan label, kolom, atau pilihan yang dinonaktifkan.

{
  "hideInSearch": boolean,
  "showInApply": boolean
}

boolean

Apakah akan menyembunyikan objek yang dinonaktifkan ini di menu penelusuran untuk item Drive.

• Saat false, objek umumnya ditampilkan di UI sebagai dinonaktifkan, tetapi muncul di hasil penelusuran saat menelusuri item Drive.
• Saat true, objek umumnya disembunyikan di UI saat menelusuri item Drive.

boolean

Apakah akan menampilkan objek yang dinonaktifkan ini dalam menu penerapan pada item Drive.

• Saat true, objek umumnya ditampilkan di UI sebagai dinonaktifkan dan tidak dapat dipilih.
• Saat false, objek umumnya disembunyikan di UI.

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}

boolean

Apakah label harus ditampilkan di UI sebagai dinonaktifkan.

boolean

Label ini harus disembunyikan di menu penelusuran saat menelusuri item Drive.

boolean

Label ini harus ditampilkan di menu terapkan saat menerapkan nilai ke item Drive.

string (int64 format)

Urutkan untuk menampilkan label dalam daftar.

{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}

boolean

Apakah pengguna dapat membaca metadata yang diterapkan terkait dengan label ini.

boolean

Apakah pengguna dapat menerapkan label ini ke item.

boolean

Apakah pengguna dapat menghapus label ini dari item.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

Apakah pengguna dapat mengubah label ini.

boolean

Apakah pengguna dapat menghapus label ini. Pengguna harus memiliki izin dan label harus dinonaktifkan.

boolean

Apakah pengguna dapat menonaktifkan label ini. Pengguna harus memiliki izin dan label ini harus belum dinonaktifkan.

boolean

Apakah pengguna dapat mengaktifkan label ini atau tidak. Pengguna harus memiliki izin dan label ini harus dinonaktifkan.

{
  "copyMode": enum (CopyMode)
}

enum (CopyMode)

Menunjukkan cara label dan nilai kolom yang diterapkan harus disalin saat item Drive disalin.

{
  "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.
}

string

Hanya output. Kunci kolom, yang unik dalam label atau library.

Nilai ini dibuat secara otomatis. Cocok dengan ekspresi reguler: ([a-zA-Z0-9])+

string

Hanya output. Kunci yang digunakan saat membuat kueri penelusuran Drive untuk menemukan file berdasarkan nilai yang ditentukan untuk kolom ini pada file. Misalnya, "{queryKey} > 2001-01-01".

object (Properties)

Properti dasar kolom.

object (Lifecycle)

Hanya output. Siklus proses kolom ini.

object (DisplayHints)

Hanya output. Petunjuk tampilan UI untuk merender kolom.

object (SchemaCapabilities)

Hanya output. Kemampuan yang dimiliki pengguna ini saat mengedit kolom ini.

object (AppliedCapabilities)

Hanya output. Kemampuan yang dimiliki pengguna ini di kolom ini dan nilainya saat label diterapkan pada item Drive.

object (UserInfo)

Hanya output. Pengguna yang membuat kolom ini.

string (Timestamp format)

Hanya output. Waktu kolom ini dibuat.

object (UserInfo)

Hanya output. Pengguna yang mengubah kolom ini.

string (Timestamp format)

Hanya output. Waktu kolom ini diperbarui.

object (UserInfo)

Hanya output. Pengguna yang memublikasikan kolom ini. Nilai ini tidak memiliki arti jika kolom tidak dipublikasikan.

object (UserInfo)

Hanya output. Pengguna yang menonaktifkan kolom ini. Nilai ini tidak memiliki arti jika kolom tidak dinonaktifkan.

string (Timestamp format)

Hanya output. Waktu kolom ini dinonaktifkan. Nilai ini tidak memiliki arti jika kolom tidak dinonaktifkan.

object (LockStatus)

Hanya output. LockStatus kolom ini.

object (TextOptions)

Opsi kolom teks.

object (IntegerOptions)

Opsi kolom bilangan bulat.

object (DateOptions)

Opsi kolom tanggal.

object (SelectionOptions)

Opsi kolom pilihan.

object (UserOptions)

Opsi kolom pengguna.

{
  "minLength": integer,
  "maxLength": integer
}

integer

Hanya output. Panjang nilai minimum yang valid untuk kolom teks.

integer

Hanya output. Panjang nilai maksimum yang valid untuk kolom teks.

{
  "minValue": string,
  "maxValue": string
}

string (int64 format)

Hanya output. Nilai valid minimum untuk kolom bilangan bulat.

string (int64 format)

Hanya output. Nilai valid maksimum untuk kolom bilangan bulat.

{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}

enum (DateFormat)

Opsi pemformatan tanggal yang dilokalkan. Nilai kolom dirender dalam format ini sesuai dengan lokalnya.

string

Hanya output. Format tanggal ICU.

object (Date)

Hanya output. Nilai valid minimum (tahun, bulan, hari).

object (Date)

Hanya output. Nilai valid maksimum (tahun, bulan, hari).

{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}

object (ListOptions)

Jika ditentukan, menunjukkan bahwa kolom ini mendukung daftar nilai. Setelah kolom dipublikasikan, kolom ini tidak dapat diubah.

object (Choice)

Opsi yang tersedia untuk kolom pilihan ini. Urutan daftar konsisten, dan diubah dengan insertBeforeChoice.

{
  "maxEntries": integer
}

integer

Jumlah entri maksimum yang diizinkan.

{
  "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)
  }
}

string

Nilai unik pilihan. ID ini dibuat secara otomatis. Cocok dengan ekspresi reguler: ([a-zA-Z0-9_])+.

object (Properties)

Properti dasar pilihan.

object (Lifecycle)

Hanya output. Siklus proses pilihan.

object (DisplayHints)

Hanya output. UI menampilkan petunjuk untuk merender pilihan.

object (SchemaCapabilities)

Hanya output. Kemampuan yang terkait dengan opsi ini saat mengedit opsi ini.

object (AppliedCapabilities)

Hanya output. Kemampuan yang terkait dengan pilihan ini pada metadata yang diterapkan.

object (UserInfo)

Hanya output. Pengguna yang membuat pilihan ini.

string (Timestamp format)

Hanya output. Waktu pilihan ini dibuat.

object (UserInfo)

Hanya output. Pengguna yang memperbarui pilihan ini terakhir.

string (Timestamp format)

Hanya output. Waktu terakhir kali pilihan ini diperbarui.

object (UserInfo)

Hanya output. Pengguna yang memublikasikan pilihan ini. Nilai ini tidak memiliki arti jika pilihan tidak dipublikasikan.

string (Timestamp format)

Hanya output. Waktu pilihan ini dipublikasikan. Nilai ini tidak memiliki arti jika pilihan tidak dipublikasikan.

object (UserInfo)

Hanya output. Pengguna yang menonaktifkan pilihan ini. Nilai ini tidak memiliki arti jika opsi tidak dinonaktifkan.

string (Timestamp format)

Hanya output. Waktu pilihan ini dinonaktifkan. Nilai ini tidak memiliki arti jika pilihan tidak dinonaktifkan.

object (LockStatus)

Hanya output. LockStatus pilihan ini.

{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}

string

Wajib. Teks tampilan yang akan ditampilkan di UI yang mengidentifikasi kolom ini.

string

Deskripsi label ini.

object (BadgeConfig)

Konfigurasi badge untuk pilihan ini. Jika ditetapkan, label yang memiliki pilihan ini dianggap sebagai "label dengan badge".

string

Hanya input. Sisipkan atau pindahkan pilihan ini sebelum pilihan yang ditunjukkan. Jika kosong, pilihan akan ditempatkan di akhir daftar.

{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}

object (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.

string (int64 format)

Ganti prioritas global default badge ini. Jika disetel ke 0, heuristik prioritas default akan digunakan.

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}

boolean

Apakah opsi harus ditampilkan di UI sebagai dinonaktifkan.

boolean

Opsi ini akan disembunyikan di menu penelusuran saat menelusuri item Drive.

boolean

Opsi ini akan ditampilkan di menu terapkan saat menerapkan nilai ke item Drive.

object (BadgeColors)

Warna yang akan digunakan untuk badge. Diubah menjadi warna Material Google berdasarkan properties.badge_config.color yang dipilih.

object (BadgeColors)

Warna mode gelap yang akan digunakan untuk badge. Diubah menjadi warna Material Google berdasarkan properties.badge_config.color yang dipilih.

string (int64 format)

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 BadgeConfig.priority_override atau heuristik default yang lebih memilih tanggal pembuatan label, serta prioritas kolom dan opsi.

{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}

object (Color)

Hanya output. Latar belakang badge yang berpasangan dengan latar depan.

object (Color)

Hanya output. Latar depan badge yang berpasangan dengan latar belakang.

object (Color)

Hanya output. Warna yang dapat digunakan untuk teks tanpa latar belakang.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

Apakah pengguna dapat memperbarui pilihan ini.

boolean

Apakah pengguna dapat menghapus pilihan ini atau tidak.

boolean

Apakah pengguna dapat menonaktifkan pilihan ini atau tidak.

boolean

Apakah pengguna dapat mengaktifkan pilihan ini atau tidak.

{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}

boolean

Apakah pengguna dapat membaca metadata terkait yang diterapkan pada item.

boolean

Apakah pengguna dapat menggunakan pilihan ini dalam kueri penelusuran atau tidak.

boolean

Apakah pengguna dapat memilih pilihan ini pada item.

{
  "locked": boolean
}

boolean

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).

{
  "listOptions": {
    object (ListOptions)
  }
}

object (ListOptions)

Jika ditentukan, menunjukkan bahwa kolom ini mendukung daftar nilai. Setelah kolom dipublikasikan, kolom ini tidak dapat diubah.

{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}

string

Wajib. Teks tampilan yang akan ditampilkan di UI yang mengidentifikasi kolom ini.

boolean

Apakah kolom harus ditandai sebagai wajib diisi atau tidak.

string

Hanya input. Masukkan atau pindahkan kolom ini sebelum kolom yang ditunjukkan. Jika kosong, kolom ini akan ditempatkan di akhir daftar.

{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}

boolean

Apakah kolom harus ditampilkan sebagaimana diperlukan di UI.

boolean

Apakah kolom harus ditampilkan di UI sebagai dinonaktifkan.

boolean

Kolom ini harus disembunyikan di menu penelusuran saat menelusuri item Drive.

boolean

Kolom ini harus ditampilkan di menu terapkan saat menerapkan nilai ke item Drive.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

Apakah pengguna dapat mengubah kolom ini.

boolean

Apakah pengguna dapat menghapus kolom ini. Pengguna harus memiliki izin dan kolom harus tidak digunakan lagi.

boolean

Apakah pengguna dapat menonaktifkan kolom ini. Pengguna harus memiliki izin dan kolom ini harus belum dinonaktifkan.

boolean

Apakah pengguna dapat mengaktifkan kolom ini. Pengguna harus memiliki izin dan kolom ini harus dinonaktifkan.

{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}

boolean

Apakah pengguna dapat membaca metadata terkait yang diterapkan pada item.

boolean

Apakah pengguna dapat menelusuri item Drive yang merujuk kolom ini.

boolean

Apakah pengguna dapat menetapkan kolom ini pada item Drive.