Membuat & memublikasikan label

Halaman ini menjelaskan cara membuat dan memublikasikan label.

Membuat label

Untuk membuat label, gunakan metode Metode create di Koleksi labels. Label dapat secara opsional berisi satu atau lebih Fields

Anda juga harus menentukan:

  • LabelType.

  • Label title melalui Metode property.

  • useAdminAccess adalah true untuk menggunakan kredensial administrator pengguna. Tujuan server memverifikasi bahwa pengguna adalah admin dengan opsi "Kelola Label" hak istimewa sebelum mengizinkan akses.

Contoh ini membuat label admin standar dengan judul tertentu dan satu lagi SelectionOptions Field dengan 2 Choices.

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

service.labels.create({
  'resource': label,
  'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Label dibuat di UNPUBLISHED_DRAFT State. Harus PUBLISHED untuk digunakan pada file dan dapat dilihat oleh pengguna. Untuk informasi selengkapnya, lihat Label siklus proses.

Batas label

Batas berikut berlaku saat membuat dan menerapkan label:

  • Label standar—150
  • Kolom per label—10
  • Label yang diterapkan pengguna per file—5

Bekerja dengan kolom dalam label

Field Type Yang dapat dilakukan pengguna Pertimbangan dan batas format
SelectionOptions Memilih satu atau beberapa opsi dari daftar Jumlah opsi maksimum yang didukung adalah 200
Jumlah maksimum pilihan untuk file adalah 10, seperti yang dikonfigurasi di ListOptions
IntegerOptions Masukkan nilai numerik Hanya bilangan bulat yang didukung
DateOptions Pilih tanggal kalender (Opsional) Date format dapat disetel ke “Long: Month DD, YYYY”, atau “Singkat: MM/DD/YY“
TextOptions Masukkan teks dalam kotak teks Jumlah karakter maksimum yang didukung adalah 100
UserOptions Pilih satu atau beberapa pengguna dari kontak Google Workspace. Jumlah maksimum entri pengguna untuk file adalah 10, seperti yang dikonfigurasi di ListOptions

Memublikasikan label

Labels API memungkinkan Anda memublikasikan label draf setelah selesai.

Untuk memublikasikan label, gunakan metode publish dan tentukan:

  • Resource label yang mewakili setiap label. Class ini berisi resource Name dan ID, yang adalah ID unik global untuk label.

  • useAdminAccess adalah true untuk menggunakan kredensial administrator pengguna. Tujuan server memverifikasi bahwa pengguna adalah admin dengan opsi "Kelola Label" hak istimewa sebelum mengizinkan akses.

Contoh ini menggunakan ID untuk mengidentifikasi dan memublikasikan label yang benar.

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.publish({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Setelah label dipublikasikan, label akan dipindahkan ke PUBLISHED State dan revisi label ID bertambah. Label kemudian dapat dilihat oleh pengguna dan dapat diterapkan ke . Untuk informasi selengkapnya, lihat Label siklus proses.

Batasan saat memublikasikan label

  • Setelah dipublikasikan, label tidak dapat dikembalikan ke status draf aslinya. Untuk selengkapnya informasi, lihat Siklus proses label.

  • Memublikasikan label akan membuat revisi yang baru diterbitkan. Semua draf sebelumnya revisi dihapus. Revisi yang telah dipublikasikan sebelumnya akan tetap disimpan tetapi tunduk pada penghapusan otomatis sesuai kebutuhan.

  • Setelah dipublikasikan, beberapa perubahan tidak lagi diizinkan. Umumnya, ini berarti setiap perubahan yang membatalkan atau memicu pembatasan baru pada metadata yang terkait dengan label ditolak. Misalnya, perubahan pada label tidak diizinkan setelah label dipublikasikan:

    • Label tersebut langsung dihapus. (Ini harus dinonaktifkan terlebih dahulu, lalu deleted.)
    • Field.FieldType diubah.
    • Pembaruan pada opsi Validasi kolom menolak sesuatu sebelumnya diterima.
    • Pengurangan entri maksimum.