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 đều đượ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 thành công và sẽ 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ả lại thông tin; mỗi kết quả trả về một câu trả lời trống. Thứ tự của câu trả lời khớp với thứ tự của yêu cầu.

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

Do những người dùng khác có thể đang chỉnh sửa tài liệu, tài liệu có thể không phản ánh chính xác những thay đổi của bạn: các thay đổi của bạn có thể bị thay đổi theo thay đổi của cộng tác viên. Nếu không có cộng tác viên nào, 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 áp dụng thật tỉ mỉ.

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 để áp dụng cho tài liệu.
writeControl

object (WriteControl)

Cho phép kiểm soát cách thực thi các yêu cầu ghi.

Nội dung phản hồi

Tin nhắn phản hồi từ mộ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 áp dụng nội dung cập nhật.
replies[]

object (Response)

Câu trả lời về thông tin cập nhật. Thao tác này liên kết 1:1 với nội dung cập nhật, mặc dù thư trả lời cho một số yêu cầu có thể bị trống.
writeControl

object (WriteControl)

Chế độ điều khiển ghi được 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

Cho phép 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 kết hợp control. Xác định bản sửa đổi 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 trạng thái sau đây:
requiredRevisionId

string

revision ID không bắt buộc của tài liệu sẽ áp dụng yêu cầu ghi. 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 yêu cầu không hợp lệ 400.

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

string

Mục tiêu revision ID (không bắt buộc) của tài liệu sẽ áp dụng yêu cầu ghi.

Nếu 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ì những thay đổi do yêu cầu ghi này tạo ra sẽ được áp dụng cho những thay đổi của cộng tác viên. Kết quả là trong một bản sửa đổi mới của tài liệu, kết hợp cả thay đổi của cộng tác viên và thay đổi trong yêu cầu, với máy chủ Tài liệu sẽ giải quyết các thay đổi gây mâu thuẫn. Khi sử dụng mã 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.

Mã bản sửa đổi đích chỉ có thể được dùng để ghi vào các phiên bản gần đây của một tài liệu. Nếu bản sửa đổi đích quá xa so với bản sửa đổi mới nhất, yêu cầu sẽ không được xử lý và trả về lỗi yêu cầu không hợp lệ 400. 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ã bản sửa đổi vẫn có hiệu lực để sử dụng dưới dạng bản sửa đổi đích trong vài phút sau khi được đọc, nhưng đối với các tài liệu được chỉnh sửa thường xuyên, thời lượng này có thể ngắn hơn.