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 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à 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 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 câu trả lời trống. Thứ tự trả lời khớp với thứ tự của các yêu cầu.

Ví dụ: giả sử bạn gọilôUpdateUpdate với bốn 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 phản hồi trống, phản hồi cho yêu cầu thứ ba và một phản hồi trống khác, theo thứ tự đó.

Vì 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 những thay đổi của cộng tác viên. Nếu không có người cộng tác, tài liệu sẽ phản ánh những thay đổi của bạn. Trong mọi trường hợp, nội dung cập nhật trong yêu cầu của bạn đều được đảm bảo áp dụng cùng nhau.

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

Các tham số
documentId

string

Mã 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 với cấu trúc như sau:

Biểu diễn dưới dạng JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Các trường
requests[]

object (Request)

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

object (WriteControl)

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

Nội dung phản hồi

Tin nhắn 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)
  }
}
Các trường
documentId

string

Mã của tài liệu có thông tin cập nhật.
replies[]

object (Response)

Phản hồi về nội dung cập nhật. Thao tác này sẽ ánh xạ 1:1 với nội dung cập nhật, mặc dù các câu trả lời cho một số yêu cầu có thể trống.
writeControl

object (WriteControl)

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

Phạm vi ủy 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 ủy quyền.

Điều khiển ghi

Cung cấp quyền kiểm soát cách thực thi 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.
}
Các trường
Trường nhóm control. Xác định bản sửa đổi của tài liệu để gửi thư và cách xử lý yêu cầu nếu bản sửa đổi đó không phải là bản chỉnh sửa 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 loại sau đây:
requiredRevisionId

string

revision ID (không bắt buộc) của tài liệu được 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, thì yêu cầu sẽ không được xử lý và sẽ trả về lỗi yêu cầu 400.

Khi phản hồi được yêu cầu trả lại ID sửa đổi, điều này cho biết ID 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 không bắt buộc revision ID của tài liệu có yêu cầu ghi.

Nếu những thay đổi của cộng tác viên xảy ra sau khi tài liệu được đọc bằng API, những thay đổi do yêu cầu ghi này tạo sẽ được áp dụng cho những thay đổi của cộng tác viên. Điều này dẫn đế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, với máy chủ Documents giải quyết các thay đổi gây mâu thuẫn. Khi sử dụng ID 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.

ID sửa đổi mục tiêu chỉ có thể được sử dụng để 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 so với bản sửa đổi mới nhất, thì yêu cầu sẽ không được xử lý và sẽ trả về lỗi yêu cầu 400. Bạn nên yêu cầu lại sau khi truy xuất phiên bản mới nhất của tài liệu này. Thông thường ID bản xem lạ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 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.