Method: labels.delta

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/v2beta/{name=labels/*}:delta

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
name

string

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 (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Trường
writeControl

object (WriteControl)

Cung cấp quyền kiểm soát cách thực thi các yêu cầu ghi.
requests[]

object (Request)

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

boolean

Đặt thành 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 người dùng là quản trị viên của Nhãn trước khi cho phép truy cập.
view

enum (LabelView)

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

string

Mã ngôn ngữ BCP-47 dùng để đánh giá nhãn Trường đã bản địa hoá khi include_label_in_response là true.

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 (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Trường
responses[]

object (Response)

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

object (Label)

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à true và không có lỗi.

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 kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
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

object (UpdateLabelPropertiesRequest)

Cập nhật các thuộc tính Nhãn.
createField

object (CreateFieldRequest)

Tạo một Trường mới.
updateField

object (UpdateFieldPropertiesRequest)

Cập nhật các thuộc tính cơ bản của một Trường.
updateFieldType

object (UpdateFieldTypeRequest)

Cập nhật các lựa chọn về loại Trường và/hoặc loại.
enableField

object (EnableFieldRequest)

Bật Trường.
disableField

object (DisableFieldRequest)

Tắt Trường.
deleteField

object (DeleteFieldRequest)

Xoá một Trường khỏi nhãn.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Tạo Lựa chọn trong trường Lựa chọn.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Cập nhật các thuộc tính Lựa chọn trong Trường lựa chọn.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

Bật lựa chọn trong trường lựa chọn.
disableSelectionChoice

object (DisableSelectionChoiceRequest)

Tắt lựa chọn trong trường lựa chọn.
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

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 (Properties)
  }
}
Trường
updateMask

string (FieldMask format)

Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. label_properties gốc đã được ngụ ý và không được chỉ định. Bạn có thể dùng một * duy nhất làm cú pháp viết tắt để cập nhật mọi trường.
properties

object (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 (Field)
  }
}
Trường
field

object (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 (Properties)
  }
}
Trường
updateMask

string (FieldMask format)

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 gốc đã được ngụ ý và không được chỉ định. Bạn có thể dùng một * duy nhất làm cú pháp viết tắt để cập nhật mọi trường.
id

string

Bắt buộc. Trường cần cập nhật.
properties

object (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 type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
Trường
updateMask

string (FieldMask format)

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 type_options được ngụ ý và không nên được chỉ định. Bạn có thể dùng một * duy nhất làm cú pháp viết tắt để cập nhật mọi trường.
id

string

Bắt buộc. Trường cần cập nhật.

Trường hợp type_options.

type_options chỉ có thể là một trong những trạng thái sau:
textOptions

object (TextOptions)

Cập nhật trường thành Văn bản.
longTextOptions

object (LongTextOptions)

Cập nhật trường thành Văn bản dài.
integerOptions

object (IntegerOptions)

Cập nhật trường thành Số nguyên.
dateOptions

object (DateOptions)

Cập nhật trường thành Ngày.
selectionOptions

object (SelectionOptions)

Cập nhật trường thành Lựa chọn.
userOptions

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

integer

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

integer

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

string

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 (DisabledPolicy)
  }
}
Trường
updateMask

string (FieldMask format)

Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. disabledPolicy gốc đã được ngụ ý và không được chỉ định. Bạn có thể dùng một * duy nhất làm cú pháp viết tắt để cập nhật mọi trường.
id

string

Bắt buộc. Phím của Trường để tắt.
disabledPolicy

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

string

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 (Choice)
  }
}
Trường
fieldId

string

Bắt buộc. Trường lựa chọn để tạo một Lựa chọn.
choice

object (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 (Properties)
  }
}
Trường
updateMask

string (FieldMask format)

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 gốc đã được ngụ ý và không được chỉ định. Bạn có thể dùng một * duy nhất làm cú pháp viết tắt để cập nhật mọi trường.
fieldId

string

Bắt buộc. Trường lựa chọn để cập nhật.
id

string

Bắt buộc. Lựa chọn để cập nhật.
properties

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

string

Bắt buộc. Trường lựa chọn, trong đó một Lựa chọn sẽ được bật.
id

string

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 (DisabledPolicy)
  }
}
Trường
updateMask

string (FieldMask format)

Các trường cần được cập nhật. Bạn phải chỉ định ít nhất một trường. disabledPolicy gốc đã được ngụ ý và không được chỉ định. Bạn có thể dùng một * duy nhất làm cú pháp viết tắt để cập nhật mọi trường.
fieldId

string

Bắt buộc. Trường lựa chọn, trong đó một Lựa chọn sẽ bị tắt.
id

string

Bắt buộc. Lựa chọn tắt.
disabledPolicy

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

string

Bắt buộc. Trường lựa chọn mà từ đó một Lựa chọn sẽ bị xoá.
id

string

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 response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
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

object (UpdateLabelPropertiesResponse)

Cập nhật các thuộc tính cơ bản của Nhãn.
createField

object (CreateFieldResponse)

Tạo một Trường mới.
updateField

object (UpdateFieldPropertiesResponse)

Cập nhật các thuộc tính cơ bản của một Trường.
updateFieldType

object (UpdateFieldTypeResponse)

Cập nhật các lựa chọn về loại Trường và/hoặc loại.
enableField

object (EnableFieldResponse)

Bật trường.
disableField

object (DisableFieldResponse)

Tắt Trường.
deleteField

object (DeleteFieldResponse)

Xoá một Trường khỏi nhãn.
createSelectionChoice

object (CreateSelectionChoiceResponse)

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

object (UpdateSelectionChoicePropertiesResponse)

Cập nhật một lựa chọn trong trường lựa chọn.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

Bật lựa chọn trong trường lựa chọn.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

Tắt lựa chọn trong một trường lựa chọn.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

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

string

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

integer

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

integer

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

string

Mã nhận dạng do máy chủ tạo của trường.
id

string

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

integer

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á.