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 (không bắt buộc) Fields.

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

• LabelType.

• Nhãn title thông qua property.

• useAdminAccess true để sử dụng thông tin xác thực quản trị viên của người dùng. Chiến lược phát hành đĩa đơn máy chủ xác minh rằng người dùng là quản trị viên bằng tuỳ chọn "Quản lý nhãn" đặc quyền trước khi cho phép truy cập.

Ví dụ này sẽ tạo một nhãn tiêu chuẩn dành cho quản trị viên với một 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 được tạo trong UNPUBLISHED_DRAFT State. Phải là PUBLISHED để sử dụng trên tệp và hiển thị với người dùng. Để biết thêm thông tin, hãy xem phần Nhãn Lifecycle.

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
• Số trường cho mỗi nhãn—10
• 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 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ư đã đị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: 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 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 một nhãn nháp sau khi hoàn tất.

Để xuất bản nhãn, hãy sử dụng 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 là giá trị nhận dạng duy nhất trên toàn cầu cho nhãn.

• useAdminAccess true để sử dụng thông tin xác thực quản trị viên của người dùng. Chiến lược phát hành đĩa đơn máy chủ xác minh rằng người dùng là quản trị viên bằng tuỳ chọn "Quản lý nhãn" đặc quyề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 đú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à bản sửa đổi của nhãn Mã nhận dạng sẽ tăng lên. Sau đó, người dùng sẽ thấy nhãn này và họ có thể áp dụng nhãn này cho tệp. Để biết thêm thông tin, hãy xem phần Nhãn Lifecycle.

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

• Sau khi xuất bản, nhãn không thể trở về trạng thái nháp ban đầu. Để biết thêm 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. Tất cả bản nháp trước các bản sửa đổi bị xoá. Các bản sửa đổi đã xuất bản trước đây được giữ lại nhưng bị tự động xoá khi cần.

• Sau khi xuất bản, một số thay đổi sẽ không đượ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 quy định hạn chế mới đối với siêu dữ liệu liên quan đến nhãn bị từ chối. Ví dụ: như sau không được phép thay đổi nhãn sau khi đã xuất bản nhãn:

  • Nhãn sẽ bị xoá trực tiếp. (Bạn phải tắt ứng dụng này trước, sau đó deleted.)
  • 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 một số yêu cầu trước đó đã chấp nhận.
  • Giảm số mục nhập tối đa.