Используйте REST API Cloud Firestore.

bookmark_border Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Хотя самый простой способ использования Cloud Firestore — это использование одной из собственных клиентских библиотек, в некоторых ситуациях полезно вызвать REST API напрямую.

REST API может быть полезен в следующих случаях использования:

• Доступ к Cloud Firestore из среды с ограниченными ресурсами, например, устройства Интернета вещей (IoT), где запуск полной клиентской библиотеки невозможен.
• Автоматизация администрирования базы данных или извлечение подробных метаданных базы данных.

Если вы используете язык, поддерживаемый gRPC , рассмотрите возможность использования RPC API вместо REST API.

Аутентификация и авторизация

Для аутентификации Cloud Firestore REST API принимает либо токен Firebase Authentication ID, либо токен Google Identity OAuth 2.0 . Токен, который вы предоставляете, влияет на авторизацию вашего запроса:

• Используйте токены Firebase ID для аутентификации запросов от пользователей вашего приложения. Для этих запросов Cloud Firestore использует Cloud Firestore Security Rules , чтобы определить, авторизован ли запрос.

• Используйте токен Google Identity OAuth 2.0 и учетную запись службы для аутентификации запросов из вашего приложения, таких как запросы на администрирование базы данных. Для этих запросов Cloud Firestore использует Identity and Access Management (IAM), чтобы определить, авторизован ли запрос.

Работа с токенами Firebase ID

Получить токен Firebase ID можно двумя способами:

• Сгенерируйте токен Firebase ID с помощью REST API Firebase Authentication .
• Извлеките токен Firebase ID пользователя из Firebase Authentication SDK .

Получив токен Firebase ID пользователя, вы можете делать запросы от имени пользователя.

Для запросов, аутентифицированных с помощью токена Firebase ID, и для неаутентифицированных запросов Cloud Firestore использует ваши Cloud Firestore Security Rules , чтобы определить, авторизован ли запрос.

Работа с токенами Google Identity OAuth 2.0

Вы можете сгенерировать токен доступа, используя учетную запись службы с клиентской библиотекой Google API или следуя инструкциям в разделе Использование OAuth 2.0 для приложений Server to Server . Вы также можете сгенерировать токен с помощью инструмента командной строки gcloud и команды gcloud auth application-default print-access-token .

Для отправки запросов в Cloud Firestore REST API этот токен должен иметь следующую область действия:

• https://www.googleapis.com/auth/datastore

Если вы аутентифицируете свои запросы с помощью учетной записи службы и токена Google Identity OAuth 2.0, Cloud Firestore предполагает, что ваши запросы действуют от имени вашего приложения, а не отдельного пользователя. Cloud Firestore позволяет этим запросам игнорировать ваши правила безопасности. Вместо этого Cloud Firestore использует IAM для определения того, авторизован ли запрос.

Вы можете контролировать права доступа учетных записей служб, назначая роли IAM Cloud Firestore .

Аутентификация с помощью токена доступа

Получив токен Firebase ID или токен Google Identity OAuth 2.0, передайте его в конечные точки Cloud Firestore в качестве заголовка Authorization , установленного на Bearer {YOUR_TOKEN} .

Выполнение REST-вызовов

Все конечные точки REST API существуют по базовому URL-адресу https://firestore.googleapis.com/v1/ .

Чтобы создать путь к документу с идентификатором LA в коллекции cities в рамках проекта YOUR_PROJECT_ID , вы должны использовать следующую структуру.

/projects/YOUR_PROJECT_ID/databases/(default)/documents/cities/LA

Чтобы взаимодействовать с этим путем, объедините его с базовым URL-адресом API.

https://firestore.googleapis.com/v1/projects/YOUR_PROJECT_ID/databases/(default)/documents/cities/LA

Лучший способ начать экспериментировать с REST API — использовать API Explorer , который автоматически генерирует токены Google Identity OAuth 2.0 и позволяет вам изучить API.

Методы

Ниже приведены краткие описания двух наиболее важных групп методов. Полный список см. в справочнике REST API или используйте API Explorer .

v1.projects.databases.documents

Выполняйте операции CRUD с документами, аналогичные тем, которые описаны в руководствах по добавлению или получению данных .

v1.projects.databases.collectionGroups.indexes

Выполнять действия с индексами, такие как создание новых индексов, отключение существующего индекса или перечисление всех текущих индексов. Полезно для автоматизации миграции структур данных или синхронизации индексов между проектами.

Также позволяет извлекать метаданные документа, такие как список всех полей и подколлекций для данного документа.

Коды ошибок

При успешном выполнении запроса Cloud Firestore API Cloud Firestore возвращает код статуса HTTP 200 OK и запрошенные данные. При неудачном выполнении запроса API Cloud Firestore возвращает код статуса HTTP 4xx или 5xx и ответ с информацией об ошибке.

В следующей таблице перечислены рекомендуемые действия для каждого кода ошибки. Эти коды применяются к REST и RPC API Cloud Firestore . SDK и клиентские библиотеки Cloud Firestore могут не возвращать эти же коды ошибок.