Method: projects.databases.documents.patch

Cập nhật hoặc chèn một tài liệu.

Yêu cầu HTTP

PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}

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

Tham số đường dẫn

Tham số
document.name

string

Tên tài nguyên của tài liệu, ví dụ: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Tham số truy vấn

Tham số
updateMask

object (DocumentMask)

Các trường cần cập nhật. Không có đường dẫn trường nào trong mặt nạ có thể chứa tên dành riêng.

Nếu tài liệu tồn tại trên máy chủ và có các trường không được tham chiếu trong mặt nạ, thì các trường đó sẽ không thay đổi. Các trường được tham chiếu trong mặt nạ nhưng không xuất hiện trong tài liệu nhập sẽ bị xoá khỏi tài liệu trên máy chủ.
mask

object (DocumentMask)

Các trường cần trả về. Nếu không được đặt, hàm sẽ trả về tất cả các trường.

Nếu tài liệu có một trường không xuất hiện trong mặt nạ này, thì trường đó sẽ không được trả về trong phản hồi.
currentDocument

object (Precondition)

Điều kiện tiên quyết (không bắt buộc) trên tài liệu. Yêu cầu sẽ không thành công nếu bạn đặt và không đáp ứng yêu cầu này trong tài liệu đích.

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của Document.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Document.

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/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.