Method: documents.batchUpdate

Áp dụng một hoặc nhiều nội dung cập nhật cho tài liệu.

Mỗi request được xác thực trước khi áp dụng. Nếu có bất kỳ yêu cầu nào không hợp lệ, thì toàn bộ yêu cầu sẽ không được thực hiện và không có yêu cầu nào được áp dụng.

Một số yêu cầu có replies để cung cấp cho bạn một số thông tin về cách áp dụng các yêu cầu đó. Các yêu cầu khác không cần trả về thông tin; mỗi yêu cầu trả về một phản hồi trống. Thứ tự của các thư trả lời khớp với thứ tự của các yêu cầu.

Ví dụ: giả sử bạn gọi batchUpdate với 4 nội dung cập nhật và chỉ nội dung cập nhật thứ ba trả về thông tin. Phản hồi sẽ có hai câu trả lời trống, câu trả lời cho yêu cầu thứ ba và một câu trả lời trống khác, theo thứ tự đó.

Vì những người dùng khác có thể đang chỉnh sửa tài liệu, nên tài liệu đó có thể không phản ánh chính xác các thay đổi của bạn: các thay đổi của bạn có thể bị thay đổi theo các thay đổi của cộng tác viên. Nếu không có cộng tác viên, tài liệu sẽ phản ánh các thay đổi của bạn. Trong mọi trường hợp, các nội dung cập nhật trong yêu cầu của bạn đều được đảm bảo được áp dụng cùng nhau một cách nguyên tử.

Yêu cầu HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

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

Tham số đường dẫn

Tham số
documentId

string

Mã của tài liệu 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 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Trường
requests[]

object (Request)

Danh sách nội dung cập nhật cần áp dụng cho tài liệu.
writeControl

object (WriteControl)

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

Nội dung phản hồi

Thông báo phản hồi từ yêu cầu documents.batchUpdate.

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:

Biểu diễn dưới dạng JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Trường
documentId

string

Mã của tài liệu mà bạn đã áp dụng nội dung cập nhật.
replies[]

object (Response)

Nội dung trả lời về nội dung cập nhật. Việc này sẽ liên kết 1:1 với nội dung cập nhật, mặc dù câu trả lời cho một số yêu cầu có thể trống.
writeControl

object (WriteControl)

Chế độ kiểm soát quyền ghi đã cập nhật sau khi áp dụng yêu cầu.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

WriteControl

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

Biểu diễn dưới dạng JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Trường
Trường hợp hợp nhất control. Xác định bản sửa đổi của tài liệu cần ghi và cách yêu cầu hoạt động nếu bản sửa đổi đó không phải là bản sửa đổi hiện tại của tài liệu. Nếu bạn không chỉ định trường nào, thì nội dung cập nhật sẽ được áp dụng cho bản sửa đổi mới nhất. control chỉ có thể là một trong những giá trị sau:
requiredRevisionId

string

revision ID không bắt buộc của tài liệu mà yêu cầu ghi được áp dụng. Nếu đây không phải là bản sửa đổi mới nhất của tài liệu, yêu cầu sẽ không được xử lý và trả về lỗi 400 yêu cầu không hợp lệ.

Khi một mã sửa đổi bắt buộc được trả về trong phản hồi, mã này sẽ cho biết mã sửa đổi của tài liệu sau khi yêu cầu được áp dụng.
targetRevisionId

string

Mục tiêu revision ID không bắt buộc của tài liệu mà yêu cầu ghi được áp dụng.

Nếu các thay đổi của cộng tác viên đã xảy ra sau khi tài liệu được đọc bằng API, thì các thay đổi do yêu cầu ghi này tạo ra sẽ được áp dụng cho các thay đổi của cộng tác viên. Thao tác này sẽ tạo ra một bản sửa đổi mới của tài liệu, kết hợp cả các thay đổi của cộng tác viên và các thay đổi trong yêu cầu, trong đó máy chủ Tài liệu sẽ giải quyết các thay đổi xung đột. Khi sử dụng mã nhận dạng bản sửa đổi mục tiêu, ứng dụng API có thể được coi là một cộng tác viên khác của tài liệu.

Bạn chỉ có thể dùng mã nhận dạng bản sửa đổi mục tiêu để ghi vào các phiên bản gần đây của tài liệu. Nếu bản sửa đổi mục tiêu quá xa bản sửa đổi mới nhất, yêu cầu sẽ không được xử lý và trả về lỗi 400 yêu cầu không hợp lệ. Bạn nên thử lại yêu cầu sau khi truy xuất phiên bản mới nhất của tài liệu. Thông thường, mã sửa đổi vẫn hợp lệ để sử dụng làm bản sửa đổi mục tiêu trong vài phút sau khi được đọc, nhưng đối với các tài liệu thường xuyên được chỉnh sửa, khoảng thời gian này có thể ngắn hơn.