Tạo và xuất bản nhãn

Trang này mô tả cách tạo và xuất bản nhãn.

Tạo nhãn

Để tạo nhãn, hãy dùng phương thức create trên bộ sưu tập labels. Nhãn có thể tuỳ ý chứa một hoặc nhiều Fields.

Bạn cũng phải chỉ định:

• LabelType.

• Nhãn title thông qua phương thức property.

• useAdminAccess được true sử dụng thông tin đăng nhập quản trị viên của người dùng. Máy chủ xác minh rằng người dùng là quản trị viên có đặc quyền "Quản lý nhãn" trước khi cho phép truy cập.

Ví dụ này tạo một nhãn quản trị viên tiêu chuẩn có tiêu đề được chỉ định và một SelectionOptions Field với 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);
});

Nhãn này được tạo trong UNPUBLISHED_DRAFT State. Giá trị này phải là PUBLISHED để sử dụng trên tệp và người dùng có thể nhìn thấy. Để biết thêm thông tin, hãy xem phần Vòng đời của nhãn.

Giới hạn đối với nhãn

Các giới hạn sau đây áp dụng khi tạo và áp dụng nhãn:

• Nhãn tiêu chuẩn: 150
• Trường cho mỗi nhãn—10
• Số nhãn do người dùng áp dụng cho mỗi tệp – 5

Làm việc với các trường trong nhãn

Field Type	Những việc người dùng có thể làm	Những điều cần cân nhắc và giới hạn về định dạng
SelectionOptions	Chọn một hoặc nhiều lựa chọn trong một danh sách	Số lựa chọn tối đa được hỗ trợ là 200 Số lựa chọn tối đa cho một tệp là 10 như được định cấu hình trong ListOptions
IntegerOptions	Nhập một giá trị số	Chỉ hỗ trợ số nguyên
DateOptions	Chọn một ngày theo lịch	(Không bắt buộc) Bạn có thể đặt Date format thành "Dài: Tháng DD, YYYY" hoặc "Ngắn: MM/DD/YY"
TextOptions	Nhập văn bản vào hộp văn bản	Số ký tự tối đa được hỗ trợ là 100
UserOptions	Chọn một hoặc nhiều người dùng trong danh bạ Google Workspace.	Số mục tối đa của người dùng cho một tệp là 10 như đã định cấu hình trong ListOptions

Xuất bản nhãn

API Nhãn cho phép bạn xuất bản nhãn nháp sau khi hoàn tất.

Để phát hành nhãn, hãy sử dụng phương thức publish và chỉ định:

• Tài nguyên nhãn đại diện cho mọi nhãn. Gói này chứa tài nguyên Name và ID. Đây là giá trị nhận dạng duy nhất trên toàn hệ thống của nhãn.

• useAdminAccess được true sử dụng thông tin đăng nhập quản trị viên của người dùng. Máy chủ xác minh rằng người dùng là quản trị viên có đặc quyền "Quản lý nhãn" trước khi cho phép truy cập.

Ví dụ này sử dụng ID để xác định và phát hành đúng nhãn.

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);
});

Sau khi xuất bản nhãn, nhãn sẽ chuyển sang PUBLISHED State và mã sửa đổi của nhãn sẽ tăng lên. Sau đó, người dùng sẽ nhìn thấy nhãn và áp dụng nhãn cho các tệp. Để biết thêm thông tin, hãy xem phần Vòng đời của nhãn.

Các hạn chế khi xuất bản nhãn

• Sau khi xuất bản, nhãn không thể quay về trạng thái bản nháp ban đầu. Để biết thêm thông tin, hãy xem phần Vòng đời của nhãn.

• Việc xuất bản nhãn sẽ tạo ra một bản sửa đổi mới được xuất bản. Mọi bản sửa đổi nháp trước đó đều bị xoá. Các bản sửa đổi đã phát hành trước đây sẽ được giữ lại nhưng có thể bị xoá tự động nếu cần.

• Sau khi xuất bản, một số nội dung thay đổi sẽ không còn được cho phép nữa. Nhìn chung, điều này có nghĩa là mọi thay đổi làm mất hiệu lực hoặc kích hoạt các hạn chế mới đối với siêu dữ liệu hiện có liên quan đến nhãn đều bị từ chối. Ví dụ: bạn không được phép thực hiện các thay đổi sau đây đối với nhãn sau khi phát hành nhãn:

  • Nhãn bị xoá trực tiếp. (Trước tiên, phải tắt rồi xoá.)
  • Field.FieldType đã thay đổi.
  • Nội dung cập nhật đối với các tuỳ chọn xác thực trường sẽ từ chối nội dung được chấp nhận trước đó.
  • Số mục nhập giảm tối đa.