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

Trang này mô tả cách tạo và phát hành 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ị 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 có 2 Choices.

PythonNode.js

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

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. Tên phải là PUBLISHED để sử dụng trên các tệp và để người dùng nhìn thấy. Để biết thêm thông tin, hãy xem phần 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 mục trong danh sách	Số lượng tuỳ 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 giá trị dạng số	Chỉ hỗ trợ số nguyên
DateOptions	Chọn ngày trong lịch	(Không bắt buộc) Bạn có thể đặt Date format thành "Dài: Ngày 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 nhập người dùng tối đa 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.

Để phát hành một 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. Tệp 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 cầu cho nhãn.

• useAdminAccess là true để sử dụng thông tin đăng nhập quản trị 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 nhãn chính xác.

PythonNode.js

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

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 được phát hành, nhãn sẽ chuyển sang PUBLISHED State và mã bản sửa đổi của nhãn sẽ được tăng lên. Sau đó, người dùng sẽ thấy nhãn và có thể á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.

Quy tắc ràng buộc khi xuất bản nhãn

• Sau khi xuất bản, nhãn không thể quay lại 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.

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

• Sau khi xuất bản, bạn 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 sẽ bị từ chối. Ví dụ: Sau khi nhãn được xuất bản, bạn không được phép thực hiện những thay đổi sau đây đối với nhãn:

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