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 tập hợp labels. Nhãn có thể tuỳ ý chứa một hoặc nhiều Fields.

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

• A LabelType.

• `title` của nhãn thông qua phương thức ` property`.

• useAdminAccess là true để sử dụng thông tin đăng nhập của quản trị viên của người dùng. Máy chủ sẽ 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 ở UNPUBLISHED_DRAFT State. Nhãn phải ở trạng thái PUBLISHED để sử dụng trên các tệp và hiển thị cho người dùng. Để biết thêm thông tin, hãy xem Vòng đời của nhãn.

Giới hạn 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 trên 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	Các đ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ự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 theo cấu hình trong ListOptions
IntegerOptions	Nhập giá trị số	Chỉ hỗ trợ số nguyên
DateOptions	Chọn ngày trên lịch	(Không bắt buộc) Date format có thể được đặt 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ố mục nhập người dùng tối đa cho một tệp là 10 theo 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:

• Tài nguyên Nhãn đại diện cho mọi nhãn. Tài nguyên này chứa Name và ID của tài nguyên. Đâ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 của quản trị viên của người dùng. Máy chủ sẽ 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 xuất bả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 có thể 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 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 lại trạng thái nháp ban đầu. Để biết thêm thông tin, hãy xem bài viết 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. Tất cả cá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 đề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 xuất bản nhãn:

  • Nhãn bị xoá trực tiếp. (Bạn phải tắt nhãn trước, sau đó mới xoá được.)
  • Field.FieldType bị 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 một nội dung đã được chấp nhận trước đó.
  • Giảm số mục nhập tối đa.