Bạn có thể cập nhật một nhãn duy nhất bằng cách áp dụng một tập hợp các yêu cầu cập nhật, từ đó tạo ra một bản sửa đổi nháp mới. Ví dụ: bạn có thể cập nhật thuộc tính nhãn hiện có (nội dung mô tả nhãn) hoặc thêm một Field
mới vào nhãn.
Việc cập nhật nhãn hoạt động như một bản cập nhật hàng loạt vì phương thức này lấy danh sách các đối tượng cập nhật Request
. Phương thức này cập nhật theo cùng một thứ tự được chỉ định trong yêu cầu hàng loạt. Các bản cập nhật trong bản cập nhật hàng loạt được áp dụng một cách nguyên tử. Tức là nếu có bất kỳ yêu cầu nào trong lô không thành công, thì toàn bộ quá trình cập nhật sẽ không thành công và không có thay đổi nào (có thể phụ thuộc) được áp dụng. Nhãn này không thay đổi.
Nếu quá trình cập nhật thành công, bạn phải xuất bản bản sửa đổi nháp thu được trước khi có thể sử dụng các thay đổi đó với bất kỳ mục nào trên Drive.
Cập nhật đối tượng nhãn
Nhãn bao gồm nhiều loại đối tượng khác có thể được cập nhật, chẳng hạn như:
- Thuộc tính nhãn
- Trường và loại trường
- Lựa chọn lựa chọn và Thuộc tính lựa chọn lựa chọn
Đây là một số trong số nhiều đối tượng kiểm soát giao diện và hoạt động của nhãn.
Danh mục hoạt động
Các thao tác sau đây được phương thức labels.delta
hỗ trợ có thể được nhóm thành các danh mục lớn sau:
Danh mục | Mô tả |
---|---|
Tạo | Thêm đối tượng. |
Cập nhật | Cập nhật một số thuộc tính nhất định của đối tượng. |
Bật | Bật đối tượng. |
Tắt | Tắt đối tượng. |
Xóa | Xoá đối tượng. |
Các danh mục này được sử dụng trong phần tiếp theo để mô tả hành vi của các thao tác cụ thể.
Yêu cầu cập nhật
Phương thức labels.delta
hoạt động bằng cách lấy một hoặc nhiều đối tượng Yêu cầu, mỗi đối tượng chỉ định một loại yêu cầu để thực hiện. Có nhiều loại yêu cầu. Dưới đây là thông tin chi tiết về các loại yêu cầu, được nhóm thành nhiều danh mục.
Loại yêu cầu | |||
---|---|---|---|
Thuộc tính nhãn |
|
||
Trường | |||
Lựa chọn lựa chọn |
Mặt nạ trường
Nhiều yêu cầu loại "Cập nhật" và "Tắt" yêu cầu FieldMask
.
Đây là danh sách các trường được phân tách bằng dấu phẩy mà bạn muốn cập nhật trong khi giữ nguyên các trường khác. Bạn phải sử dụng mặt nạ để đảm bảo chỉ cập nhật những trường mà bạn muốn chỉnh sửa. Bạn phải chỉ định ít nhất một trường.
Ví dụ:
Để cập nhật nhãn, hãy sử dụng phương thức delta
trên tập hợp labels
.
Bạn cũng phải chỉ định:
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ủa nhãn trước khi cho phép truy cập.Request
chỉ định các nội dung cập nhật hiện hành cho nhãn.Nhãn
title
thông qua phương thứcproperty
.Một hoặc nhiều
Field
.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.LabelView
làLABEL_VIEW_FULL
để đặt chế độ xem Tài nguyên áp dụng cho các phản hồi nhãn.LABEL_VIEW_FULL
trả về tất cả các trường có thể.
Ví dụ này sử dụng ID
để cập nhật nhãn chính xác.
body = {
'use_admin_access': True,
'requests': [{
'update_label': {
'properties': {
'title': 'TITLE '
},
'update_mask': {
'paths': ['title']
}
},
}, {
'create_field': {
'field': {
'properties': {
'display_name': 'DISPLAY_NAME '
},
'text_options': {}
}
}
}],
'view': 'LABEL_VIEW_FULL'
}
response = service.labels().delta(
body=body,
name='labels/ID ').execute()
var body = {
'use_admin_access': true,
'requests': [{
'update_label': {
'properties': {
'title': 'TITLE '
},
'update_mask': {
'paths': ['title']
}
},
}, {
'create_field': {
'field': {
'properties': {
'display_name': 'DISPLAY_NAME '
},
'text_options': {}
}
}
}],
'view': 'LABEL_VIEW_FULL'
};
service.labels.delta({
'resource': body,
'name': 'labels/ID '
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
Nhãn, trường hoặc lựa chọn được cập nhật, mã sửa đổi của nhãn được tăng lên và nhãn được lưu trữ trong cơ sở dữ liệu dưới dạng nhãn nháp. Nhãn có State
của PUBLISHED
với hasUnpublishedChanges=true
có nghĩa là có các thay đổi về bản nháp, nhưng người dùng không thể sử dụng các thay đổi đó. Nhãn đã cập nhật phải là PUBLISHED
thì người dùng mới thấy được các thay đổi. Để biết thêm thông tin, hãy xem phần Vòng đời của nhãn.