Method: projects.databases.documents.patch

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

طلب HTTP

PATCH https://firestore.googleapis.com/v1beta1/{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

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