Method: projects.databases.documents.patch

یک سند را به روز می کند یا درج می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
document.name	string نام منبع سند، برای مثال projects/{projectId}/databases/{databaseId}/documents/{document_path} .

پارامترهای پرس و جو

مولفه های
updateMask	object ( DocumentMask ) فیلدهایی که باید به روز شوند. هیچ یک از مسیرهای فیلد در ماسک ممکن است حاوی نام رزرو شده نباشد. اگر سند روی سرور وجود داشته باشد و دارای فیلدهایی باشد که در ماسک به آنها اشاره نشده است، آنها بدون تغییر باقی می مانند. فیلدهایی که در ماسک ارجاع داده شده اند، اما در سند ورودی وجود ندارند، از سند روی سرور حذف می شوند.
mask	object ( DocumentMask ) زمینه هایی برای بازگشت. اگر تنظیم نشود، همه فیلدها را برمی گرداند. اگر سند دارای فیلدی باشد که در این ماسک وجود ندارد، آن فیلد در پاسخ بازگردانده نمی شود.
currentDocument	object ( Precondition ) یک پیش شرط اختیاری در سند. اگر این درخواست تنظیم شده باشد و توسط سند مورد نظر برآورده نشود، این درخواست با شکست مواجه خواهد شد.

درخواست بدن

بدنه درخواست حاوی نمونه‌ای از Document است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Document است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.