Cloud Firestore API

للوصول إلى قاعدة بيانات مستندات NoSQL المصمّمة للتوسّع التلقائي والأداء العالي وسهولة تطوير التطبيقات.

الخدمة: firestore.googleapis.com

لطلب هذه الخدمة، ننصحك باستخدام مكتبات البرامج التي توفّرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لاستدعاء هذه الخدمة، استخدِم المعلومات التالية عند تقديم طلبات البيانات من واجهة برمجة التطبيقات.

مستند Discovery

مستند الاستكشاف هو مواصفة يمكن للآلة قراءتها، لوصف واجهات برمجة تطبيقات REST واستخدامها. يُستخدم لإنشاء مكتبات للعملاء، ومكونات IDE الإضافية، وأدوات أخرى تتفاعل مع Google APIs. قد توفّر خدمة واحدة مستندات استكشاف متعددة. توفّر هذه الخدمة مستندات الاكتشاف التالية:

نقطة نهاية الخدمة

نقطة نهاية الخدمة هي عنوان URL أساسي يحدّد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد تحتوي خدمة واحدة على عدة نقاط نهاية للخدمة. تشتمل هذه الخدمة على نقطة نهاية الخدمة التالية، وترتبط جميع معرّفات الموارد المنتظمة (URI) أدناه بنقطة نهاية الخدمة هذه:

  • https://firestore.googleapis.com

مورد REST: v1beta2.projects.databases

الطُرق
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
تصدِّر نسخة من كل المستندات أو مجموعة فرعية منها من Google Cloud Firestore إلى نظام تخزين آخر، مثل Google Cloud Storage.
importDocuments POST /v1beta2/{name=projects/*/databases/*}:importDocuments
لاستيراد المستندات إلى Google Cloud Firestore.

مورد REST: v1beta2.projects.databases.collectionGroups.fields

الطُرق
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}
الحصول على البيانات الوصفية والتهيئة للحقل.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
يسرد إعدادات الحقل والبيانات الوصفية لقاعدة البيانات هذه.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
يتم تعديل إعدادات الحقل.

مورد REST: v1beta2.projects.databases.collectionGroups.indexes

الطُرق
create POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
ينشئ فهرسًا مركبًا.
delete DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
حذف فهرس مركب.
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
الحصول على فهرس مركب.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
يسرد الفهارس المركّبة.

مورد REST: v1beta1.projects.databases

الطُرق
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
تصدِّر نسخة من كل المستندات أو مجموعة فرعية منها من Google Cloud Firestore إلى نظام تخزين آخر، مثل Google Cloud Storage.
importDocuments POST /v1beta1/{name=projects/*/databases/*}:importDocuments
لاستيراد المستندات إلى Google Cloud Firestore.

مورد REST: v1beta1.projects.databases.documents

الطُرق
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
الحصول على مستندات متعددة
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
يُطبق مجموعة من عمليات الكتابة.
beginTransaction POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction
بدء معاملة جديدة
commit POST /v1beta1/{database=projects/*/databases/*}/documents:commit
إتمام معاملة، مع تعديل المستندات اختياريًا
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
ينشئ مستندًا جديدًا.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
حذف مستند
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
للحصول على مستند واحد
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
يسرد المستندات.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
يسرد جميع معرّفات المجموعة أسفل مستند.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
يسرد المستندات.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
لتقسيم استعلام عن طريق عرض مؤشرات الأقسام التي يمكن استخدامها لتشغيل الاستعلام بشكل متوازٍ.
patch PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}
لتعديل مستند أو إدراجه
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
إرجاع معاملة
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
لتنفيذ طلب بحث عن تجميع.
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
لتنفيذ استعلام.

مورد REST: v1beta1.projects.databases.indexes

الطُرق
create POST /v1beta1/{parent=projects/*/databases/*}/indexes
ينشئ الفهرس المحدد.
delete DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}
لحذف فهرس.
get GET /v1beta1/{name=projects/*/databases/*/indexes/*}
الحصول على فهرس.
list GET /v1beta1/{parent=projects/*/databases/*}/indexes
يتم سرد الفهارس التي تطابق الفلاتر المحددة.

مورد REST: v1.projects.databases

الطُرق
create POST /v1/{parent=projects/*}/databases
قم بإنشاء قاعدة بيانات.
delete DELETE /v1/{name=projects/*/databases/*}
حذف قاعدة بيانات.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
تصدِّر نسخة من كل المستندات أو مجموعة فرعية منها من Google Cloud Firestore إلى نظام تخزين آخر، مثل Google Cloud Storage.
get GET /v1/{name=projects/*/databases/*}
الحصول على معلومات حول قاعدة بيانات.
importDocuments POST /v1/{name=projects/*/databases/*}:importDocuments
لاستيراد المستندات إلى Google Cloud Firestore.
list GET /v1/{parent=projects/*}/databases
أدرج جميع قواعد البيانات في المشروع.
patch PATCH /v1/{database.name=projects/*/databases/*}
يعدِّل هذا الإجراء قاعدة بيانات.
restore POST /v1/{parent=projects/*}/databases:restore
ينشئ قاعدة بيانات جديدة عن طريق الاستعادة من نسخة احتياطية حالية.

مورد REST: v1.projects.databases.backupschedules

الطُرق
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
يقوم بإنشاء جدول زمني احتياطي على قاعدة بيانات.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
حذف جدول زمني للنسخ الاحتياطي
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
الحصول على معلومات حول الجدول الزمني للاحتفاظ بنسخة احتياطية
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
يمكنك إدراج الجداول الزمنية للاحتفاظ بنسخة احتياطية.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
يتم تعديل الجدول الزمني للاحتفاظ بنسخة احتياطية.

مورد REST: v1.projects.databases.collectionGroups.fields

الطُرق
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
الحصول على البيانات الوصفية والتهيئة للحقل.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
يسرد إعدادات الحقل والبيانات الوصفية لقاعدة البيانات هذه.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
يتم تعديل إعدادات الحقل.

مورد REST: v1.projects.databases.collectionGroups.indexes

الطُرق
create POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
ينشئ فهرسًا مركبًا.
delete DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
حذف فهرس مركب.
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
الحصول على فهرس مركب.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
يسرد الفهارس المركّبة.

مورد REST: v1.projects.databases.documents

الطُرق
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
الحصول على مستندات متعددة
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
يُطبق مجموعة من عمليات الكتابة.
beginTransaction POST /v1/{database=projects/*/databases/*}/documents:beginTransaction
بدء معاملة جديدة
commit POST /v1/{database=projects/*/databases/*}/documents:commit
إتمام معاملة، مع تعديل المستندات اختياريًا
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
ينشئ مستندًا جديدًا.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
حذف مستند
get GET /v1/{name=projects/*/databases/*/documents/*/**}
للحصول على مستند واحد
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
يسرد المستندات.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
يسرد جميع معرّفات المجموعة أسفل مستند.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
يسرد المستندات.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
لتقسيم استعلام عن طريق عرض مؤشرات الأقسام التي يمكن استخدامها لتشغيل الاستعلام بشكل متوازٍ.
patch PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}
لتعديل مستند أو إدراجه
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
إرجاع معاملة
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
لتنفيذ طلب بحث عن تجميع.
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
لتنفيذ استعلام.

مورد REST: v1.projects.databases.operations

الطُرق
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
لبدء الإلغاء غير المتزامن على عملية طويلة الأمد
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
حذف عملية طويلة الأمد
get GET /v1/{name=projects/*/databases/*/operations/*}
يحصل على أحدث حالة لعملية طويلة الأمد.
list GET /v1/{name=projects/*/databases/*}/operations
يسرد العمليات التي تتطابق مع الفلتر المحدّد في الطلب.

مورد REST: v1.projects.locations

الطُرق
get GET /v1/{name=projects/*/locations/*}
الحصول على معلومات حول موقع جغرافي
list GET /v1/{name=projects/*}/locations
يسرد معلومات عن المواقع الجغرافية المتاحة لهذه الخدمة.

مورد REST: v1.projects.locations.backups

الطُرق
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
لحذف نسخة احتياطية.
get GET /v1/{name=projects/*/locations/*/backups/*}
الحصول على معلومات حول نسخة احتياطية
list GET /v1/{parent=projects/*/locations/*}/backups
يسرد جميع النسخ الاحتياطية.