Method: projects.databases.documents.patch

لتعديل مستند أو إدراجه

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة حول المصادقة.