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
يسرد جميع النُسخ الاحتياطية.