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

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ạ, các trường này 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 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 bạn không đặt chính sách này, hệ thống sẽ 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)

Đ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 giá trị này được thiết lập nhưng tài liệu đích không đáp ứng.

Nội dung yêu cầu

Phần nội dung yêu cầu chứa một thực thể 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 thực thể của Document.

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/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ề việc xác thực.