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 sử dụng phương thức create trên bộ sưu tập labels. Nhãn có thể chứa một hoặc nhiều Fields (không bắt buộc).

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

• Một LabelType.

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

• useAdminAccess là 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ị tiêu chuẩn có tiêu đề được chỉ định và một SelectionOptions Field có 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 được tạo trong UNPUBLISHED_DRAFT State. Bạn phải PUBLISHED để sử dụng trên các tệp và người dùng có thể thấy được. Để biết thêm thông tin, hãy xem bài viết Vòng đời của nhãn.

Hạn mức về 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
• Số trường trên 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ểm cần lưu ý và giới hạn về định dạng
SelectionOptions	Chọn một hoặc nhiều lựa chọn trong danh sách	Số lượng lựa chọn tối đa được hỗ trợ là 200 Số lượng 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ị bằng số	Hệ thống chỉ hỗ trợ số nguyên
DateOptions	Chọn một ngày trên lịch	(Không bắt buộc) Bạn có thể đặt Date format thành "Long: Month DD, YYYY" (Dài: Tháng DD, YYYY) hoặc "Short: MM/DD/YY" (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ố lượng mục nhập tối đa của người dùng cho một tệp là 10 như được định cấu hình trong ListOptions

Xuất bản nhãn

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

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

• Một Tài nguyên nhãn đại diện cho mọi nhãn. Nó chứa một tài nguyên Name và ID. Đây là giá trị nhận dạng riêng biệt trên toàn cầu cho nhãn.

• useAdminAccess là 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à xuất bản nhãn chính xác.

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 nhãn được xuất bản, nhãn sẽ chuyển sang PUBLISHED State và mã nhận dạng bản sửa đổi của nhãn sẽ tăng lên. Sau đó, người dùng sẽ thấy nhãn này và có thể áp dụng cho các tệp. Để biết thêm thông tin, hãy xem bài viết Vòng đời của nhãn.

Các ràng buộc khi xuất bản nhãn

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

• Khi bạn xuất bản một nhãn, hệ thống sẽ tạo ra một bản sửa đổi mới được xuất bản. Tất cả các bản sửa đổi nháp trước đó đều bị xoá. Các bản sửa đổi đã xuất bản trước đó vẫn được giữ lại nhưng có thể bị xoá tự động nếu cần.

• Sau khi xuất bản, bạn sẽ không được phép thực hiện một số thay đổi. Nói 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 quy định 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 những thay đổi sau đối với nhãn sau khi nhãn được xuất bản:

  • Nhãn sẽ bị xoá ngay lập tức. (Bạn phải tắt tính năng này trước rồi mới xoá được.)
  • Field.FieldType đã thay đổi.
  • Nội dung cập nhật đối với các lựa chọn Xác thực trường sẽ từ chối nội dung đã được chấp nhận trước đó.
  • Giảm số lượng mục nhập tối đa.