- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- Yêu cầu
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- Phản hồi
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- Hãy làm thử!
Cập nhật một Nhãn bằng cách áp dụng một nhóm yêu cầu cập nhật dẫn đến một bản sửa đổi nháp mới. Cập nhật theo lô là tất cả hay không có gì: Nếu bất kỳ yêu cầu cập nhật nào không hợp lệ, thì sẽ không có thay đổi nào được áp dụng. Bản sửa đổi nháp đã tạo phải được xuất bản trước khi có thể sử dụng các thay đổi với các mục trên Drive.
Yêu cầu HTTP
POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Thông số | |
---|---|
name |
Bắt buộc. Tên tài nguyên của Nhãn cần cập nhật. |
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "writeControl": { object ( |
Trường | |
---|---|
writeControl |
Cung cấp quyền kiểm soát cách thực thi các yêu cầu ghi. |
requests[] |
Danh sách các nội dung cập nhật để áp dụng cho Nhãn. Các yêu cầu sẽ được áp dụng theo thứ tự đã chỉ định. |
useAdminAccess |
Đặt thành |
view |
Khi được chỉ định, chỉ một số trường nhất định thuộc về khung hiển thị đã chỉ định mới được trả về. |
languageCode |
Mã ngôn ngữ BCP-47 dùng để đánh giá nhãn Trường đã bản địa hoá khi |
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Phản hồi cho nội dung cập nhật về Nhãn.
Biểu diễn dưới dạng JSON |
---|
{ "responses": [ { object ( |
Trường | |
---|---|
responses[] |
Nội dung trả lời của nội dung cập nhật. Quá trình này liên kết 1:1 với các bản cập nhật, mặc dù phản hồi cho một số yêu cầu có thể trống. |
updatedLabel |
Nhãn sau khi áp dụng nội dung cập nhật. Giá trị này chỉ được đặt nếu [BatchUpdateLabelResponse2.include_label_in_response] là |
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau đây:
https://www.googleapis.com/auth/drive.labels
https://www.googleapis.com/auth/drive.admin.labels
Để biết thêm thông tin, hãy xem bài viết Hướng dẫn uỷ quyền.
Yêu cầu
Một loại nội dung cập nhật duy nhất áp dụng cho Nhãn.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường hợp kind . Loại nội dung cập nhật. Bạn phải điền đúng một Trường. kind chỉ có thể là một trong những trạng thái sau: |
|
updateLabel |
Cập nhật các thuộc tính Nhãn. |
createField |
Tạo một Trường mới. |
updateField |
Cập nhật các thuộc tính cơ bản của một Trường. |
updateFieldType |
Cập nhật các lựa chọn về loại Trường và/hoặc loại. |
enableField |
Bật Trường. |
disableField |
Tắt Trường. |
deleteField |
Xoá một Trường khỏi nhãn. |
createSelectionChoice |
Tạo Lựa chọn trong trường Lựa chọn. |
updateSelectionChoiceProperties |
Cập nhật các thuộc tính Lựa chọn trong Trường lựa chọn. |
enableSelectionChoice |
Bật lựa chọn trong trường lựa chọn. |
disableSelectionChoice |
Tắt lựa chọn trong trường lựa chọn. |
deleteSelectionChoice |
Xoá một lựa chọn trong trường lựa chọn. |
UpdateLabelPropertiesRequest
Cập nhật các thuộc tính cơ bản của Nhãn.
Biểu diễn dưới dạng JSON |
---|
{
"updateMask": string,
"properties": {
object ( |
Trường | |
---|---|
updateMask |
Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. |
properties |
Bắt buộc. Gắn nhãn các thuộc tính cần cập nhật. |
CreateFieldRequest
Yêu cầu tạo một trường trong một Nhãn.
Biểu diễn dưới dạng JSON |
---|
{
"field": {
object ( |
Trường | |
---|---|
field |
Bắt buộc. Trường cần tạo. |
UpdateFieldPropertiesRequest
Yêu cầu cập nhật các thuộc tính của Trường.
Biểu diễn dưới dạng JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
Trường | |
---|---|
updateMask |
Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. |
id |
Bắt buộc. Trường cần cập nhật. |
properties |
Bắt buộc. Thuộc tính trường cơ bản. |
UpdateFieldTypeRequest
Yêu cầu thay đổi loại của một Trường.
Biểu diễn dưới dạng JSON |
---|
{ "updateMask": string, "id": string, // Union field |
Trường | |
---|---|
updateMask |
Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. Gốc của |
id |
Bắt buộc. Trường cần cập nhật. |
Trường hợp
|
|
textOptions |
Cập nhật trường thành Văn bản. |
longTextOptions |
Cập nhật trường thành Văn bản dài. |
integerOptions |
Cập nhật trường thành Số nguyên. |
dateOptions |
Cập nhật trường thành Ngày. |
selectionOptions |
Cập nhật trường thành Lựa chọn. |
userOptions |
Cập nhật trường thành Người dùng. |
LongTextOptions
Tuỳ chọn loại trường Văn bản dài.
Biểu diễn dưới dạng JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Trường | |
---|---|
minLength |
Chỉ có đầu ra. Độ dài hợp lệ tối thiểu của giá trị cho trường văn bản. |
maxLength |
Chỉ có đầu ra. Độ dài tối đa hợp lệ của giá trị cho trường văn bản. |
EnableFieldRequest
Yêu cầu bật Trường này.
Biểu diễn dưới dạng JSON |
---|
{ "id": string } |
Trường | |
---|---|
id |
Bắt buộc. Mã của Trường cần bật. |
DisableFieldRequest
Yêu cầu tắt Trường.
Biểu diễn dưới dạng JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
Trường | |
---|---|
updateMask |
Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. |
id |
Bắt buộc. Phím của Trường để tắt. |
disabledPolicy |
Bắt buộc. Chính sách đã vô hiệu hoá trường. |
DeleteFieldRequest
Yêu cầu xoá Trường.
Biểu diễn dưới dạng JSON |
---|
{ "id": string } |
Trường | |
---|---|
id |
Bắt buộc. Mã của Trường cần xoá. |
CreateSelectionChoiceRequest
Yêu cầu tạo một Lựa chọn.
Biểu diễn dưới dạng JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
Trường | |
---|---|
fieldId |
Bắt buộc. Trường lựa chọn để tạo một Lựa chọn. |
choice |
Bắt buộc. Lựa chọn sáng tạo. |
UpdateSelectionChoicePropertiesRequest
Yêu cầu cập nhật các thuộc tính Lựa chọn.
Biểu diễn dưới dạng JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
Trường | |
---|---|
updateMask |
Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. |
fieldId |
Bắt buộc. Trường lựa chọn để cập nhật. |
id |
Bắt buộc. Lựa chọn để cập nhật. |
properties |
Bắt buộc. Các thuộc tính Choice cần cập nhật. |
EnableSelectionChoiceRequest
Yêu cầu bật Lựa chọn.
Biểu diễn dưới dạng JSON |
---|
{ "fieldId": string, "id": string } |
Trường | |
---|---|
fieldId |
Bắt buộc. Trường lựa chọn, trong đó một Lựa chọn sẽ được bật. |
id |
Bắt buộc. Chọn bật. |
DisableSelectionChoiceRequest
Yêu cầu tắt Lựa chọn.
Biểu diễn dưới dạng JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
Trường | |
---|---|
updateMask |
Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. |
fieldId |
Bắt buộc. Trường lựa chọn, trong đó một Lựa chọn sẽ bị tắt. |
id |
Bắt buộc. Lựa chọn tắt. |
disabledPolicy |
Bắt buộc. Chính sách bị vô hiệu hoá cần cập nhật. |
DeleteSelectionChoiceRequest
Yêu cầu xoá một Lựa chọn.
Biểu diễn dưới dạng JSON |
---|
{ "fieldId": string, "id": string } |
Trường | |
---|---|
fieldId |
Bắt buộc. Trường lựa chọn mà từ đó một Lựa chọn sẽ bị xoá. |
id |
Bắt buộc. Lựa chọn xoá. |
Phản hồi
Một phản hồi từ một bản cập nhật.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường hợp response . Phản hồi cho yêu cầu tương ứng. response chỉ có thể là một trong những trạng thái sau: |
|
updateLabel |
Cập nhật các thuộc tính cơ bản của Nhãn. |
createField |
Tạo một Trường mới. |
updateField |
Cập nhật các thuộc tính cơ bản của một Trường. |
updateFieldType |
Cập nhật các lựa chọn về loại Trường và/hoặc loại. |
enableField |
Bật trường. |
disableField |
Tắt Trường. |
deleteField |
Xoá một Trường khỏi nhãn. |
createSelectionChoice |
Tạo một tuỳ chọn mới cho danh sách lựa chọn để thêm vào Trường lựa chọn. |
updateSelectionChoiceProperties |
Cập nhật một lựa chọn trong trường lựa chọn. |
enableSelectionChoice |
Bật lựa chọn trong trường lựa chọn. |
disableSelectionChoice |
Tắt lựa chọn trong một trường lựa chọn. |
deleteSelectionChoice |
Xoá một Lựa chọn khỏi trường lựa chọn. |
UpdateLabelPropertiesResponse
Phản hồi sau khi cập nhật các tài sản Nhãn.
CreateFieldResponse
Phản hồi sau khi tạo trường.
Biểu diễn dưới dạng JSON |
---|
{ "id": string, "priority": integer } |
Trường | |
---|---|
id |
Trường của trường đã tạo. Khi để trống trong yêu cầu tạo, một khoá sẽ được tạo tự động và có thể được xác định ở đây. |
priority |
Mức độ ưu tiên của trường được tạo. Mức độ ưu tiên có thể thay đổi so với mức độ ưu tiên được chỉ định để đảm bảo mức độ ưu tiên liền kề giữa các trường (1-n). |
UpdateFieldPropertiesResponse
Phản hồi sau khi cập nhật các thuộc tính của Trường.
Biểu diễn dưới dạng JSON |
---|
{ "priority": integer } |
Trường | |
---|---|
priority |
Mức độ ưu tiên của trường được cập nhật. Mức độ ưu tiên có thể thay đổi so với mức độ ưu tiên được chỉ định để đảm bảo mức độ ưu tiên liền kề giữa các trường (1-n). |
UpdateFieldTypeResponse
Phản hồi sau khi cập nhật loại trường.
EnableFieldResponse
Phản hồi sau khi bật Trường.
DisableFieldResponse
Phản hồi sau khi Tắt trường.
DeleteFieldResponse
Câu trả lời sau khi xoá trường.
CreateSelectionChoiceResponse
Câu trả lời sau khi "Lựa chọn" được tạo.
Biểu diễn dưới dạng JSON |
---|
{ "fieldId": string, "id": string } |
Trường | |
---|---|
fieldId |
Mã nhận dạng do máy chủ tạo của trường. |
id |
Mã do máy chủ tạo cho lựa chọn đã tạo trong Trường |
UpdateSelectionChoicePropertiesResponse
Phản hồi sau khi cập nhật các thuộc tính Lựa chọn.
Biểu diễn dưới dạng JSON |
---|
{ "priority": integer } |
Trường | |
---|---|
priority |
Mức độ ưu tiên của lựa chọn mới cập nhật. Mức độ ưu tiên có thể thay đổi so với mức được chỉ định để đảm bảo mức độ ưu tiên liền kề giữa các lựa chọn (1-n). |
EnableSelectionChoiceResponse
Trả lời sau khi bật lựa chọn.
DisableSelectionChoiceResponse
Phản hồi sau khi tắt Lựa chọn.
DeleteSelectionChoiceResponse
Câu trả lời sau khi lựa chọn bị xoá.