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/v1/{document.name=projects/*/databases/*/documents/*/**}

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

Tham số đường dẫn

Thông 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

Thông 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ì chúng sẽ không thay đổi. Các trường được tham chiếu trong mặt nạ nhưng không có trong tài liệu đầu vào sẽ bị xóa khỏi tài liệu trên máy chủ.

mask

object ( DocumentMask )

Các trường để trả về. Nếu không được đặt, trả về tất cả các trường.

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

currentDocument

object ( Precondition )

Một điều kiện tiên quyết tùy chọn trên tài liệu. Yêu cầu sẽ thất bại nếu điều này được đặt ra và không được tài liệu đích đáp ứng.

Nội dung yêu cầu

Phần thân yêu cầu chứa một phiên bản 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 ủy quyền

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

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem Tổng quan về xác thực .