Cloud Firestore API

Доступ к базе данных документов NoSQL, созданной для автоматического масштабирования, высокой производительности и простоты разработки приложений.

Сервис: firestore.googleapis.com.

Для вызова этой службы мы рекомендуем использовать клиентские библиотеки Google. Если вашему приложению необходимо использовать собственные библиотеки для вызова этой службы, используйте следующую информацию при отправке запросов API.

Документ открытия

Документ обнаружения — это машиночитаемая спецификация для описания и использования REST API. Он используется для создания клиентских библиотек, плагинов IDE и других инструментов, взаимодействующих с API Google. Одна служба может предоставлять несколько документов обнаружения. Эта служба предоставляет следующие документы обнаружения:

Конечная точка службы

Конечная точка службы — это базовый 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
Перечисляет все резервные копии.