این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Cloud Firestore API

دسترسی به پایگاه داده سند NoSQL که برای مقیاس بندی خودکار، کارایی بالا و سهولت توسعه برنامه ساخته شده است.

خدمات: firestore.googleapis.com

برای تماس با این سرویس، توصیه می کنیم از کتابخانه های سرویس گیرنده ارائه شده توسط Google استفاده کنید. اگر برنامه شما نیاز به استفاده از کتابخانه های خود برای فراخوانی این سرویس دارد، هنگام درخواست API از اطلاعات زیر استفاده کنید.

سند کشف

Discovery Document یک ویژگی قابل خواندن توسط ماشین برای توصیف و مصرف API های REST است. از آن برای ساخت کتابخانه های سرویس گیرنده، پلاگین های IDE و سایر ابزارهایی که با Google API در تعامل هستند استفاده می شود. یک سرویس ممکن است چندین سند کشف را ارائه دهد. این سرویس اسناد کشف زیر را ارائه می دهد:

نقطه پایان خدمات

نقطه پایانی سرویس یک 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 وارد می کند.

منبع 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` همه ی نسخه های پشتیبان را لیست می کند.