Cloud Firestore API

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

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

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

وثيقة الاكتشاف

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

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

نقطة نهاية الخدمة هي عنوان URL الأساسي الذي يحدد عنوان الشبكة لخدمة API. قد تحتوي خدمة واحدة على نقاط نهاية خدمة متعددة. تحتوي هذه الخدمة على نقطة نهاية الخدمة التالية وجميع معرفات 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.

مصدر الراحة: 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/*}
يقوم بتحديث تكوين الحقل.

مصدر الراحة: 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
يسرد العمليات التي تطابق عامل التصفية المحدد في الطلب.

مصدر الراحة: v1.projects.locations

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

مصدر الراحة: 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
يسرد كافة النسخ الاحتياطية.