Method: projects.databases.documents.createDocument

ينشئ مستندًا جديدًا.

طلب HTTP

POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/**}/{collectionId}

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

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

المَعلمات
parent

string

يجب ملء الحقل. المرجع الرئيسي. على سبيل المثال: projects/{projectId}/databases/{databaseId}/documents أو projects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}
collectionId

string

يجب ملء الحقل. رقم تعريف المجموعة المرتبط بـ parent في القائمة. مثلاً: chatrooms

معامِلات طلب البحث

المَعلمات
documentId

string

رقم تعريف المستند الذي خصّصه العميل لاستخدامه لهذا المستند.

هذه السمة اختيارية. إذا لم يتم تحديد هذا الحقل، سيتم تخصيص معرّف من قِبل الخدمة.
mask

object (DocumentMask)

الحقول المطلوب عرضها. وفي حال تم تركها بدون ضبط، سيتم عرض جميع الحقول.

إذا كان المستند يحتوي على حقل غير موجود في هذا القناع، لن يتم عرض هذا الحقل في الرد.

نص الطلب

يحتوي نص الطلب على مثيل Document.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Document.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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