Membuat & memublikasikan label

Halaman ini menjelaskan cara membuat dan memublikasikan label.

Membuat label

Untuk membuat label, gunakan metode create pada koleksi labels. Label dapat secara opsional berisi satu atau beberapa Fields.

Anda juga harus menentukan:

  • LabelType.

  • Label title melalui metode property.

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

Contoh ini membuat label admin standar dengan judul tertentu dan satu 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 mengetahui informasi selengkapnya, lihat Siklus proses label.

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 Batasan dan pertimbangan format
SelectionOptions Pilih satu atau beberapa opsi dari daftar Jumlah maksimum opsi yang didukung adalah 200
Jumlah pilihan maksimum untuk satu 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 “Panjang: Bulan DD, YYYY”, atau “Singkat: MM/DD/YY“
TextOptions Memasukkan 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 merepresentasikan setiap label. Objek ini berisi Name dan ID resource, yang merupakan ID unik global untuk label.

  • useAdminAccess adalah true untuk menggunakan kredensial administrator pengguna. Server memverifikasi bahwa pengguna adalah admin dengan hak istimewa "Kelola Label" 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 dipublikasikan, label akan dipindahkan ke PUBLISHED State dan ID revisi label akan bertambah. Label tersebut kemudian dapat dilihat oleh pengguna dan dapat diterapkan ke file. Untuk mengetahui informasi selengkapnya, lihat Siklus proses label.

Batasan saat memublikasikan label

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

  • Mempublikasikan label akan membuat revisi yang baru dipublikasikan. Semua revisi draf sebelumnya akan dihapus. Revisi yang dipublikasikan sebelumnya akan disimpan, tetapi dapat dihapus secara otomatis jika diperlukan.

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

    • Label dihapus secara langsung. (Fitur ini harus dinonaktifkan terlebih dahulu, lalu dihapus.)
    • Field.FieldType telah diubah.
    • Pembaruan pada opsi Validasi kolom menolak sesuatu yang sebelumnya diterima.
    • Pengurangan entri maksimum.