REST Resource: projects

Ресурс: FirebaseProject

FirebaseProject — это объект Firebase верхнего уровня. Это контейнер для приложений Firebase, сайтов хостинга Firebase, систем хранения (база данных Firebase Realtime, Cloud Firestore, сегменты облачного хранилища) и других ресурсов Firebase и Google Cloud Platform (GCP).

Вы создаете FirebaseProject вызывая projects.addFirebase и указывая существующий Project GCP . Это добавит ресурсы Firebase к существующему Project GCP.

Поскольку FirebaseProject на самом деле также является Project GCP, FirebaseProject имеет те же базовые идентификаторы GCP ( projectNumber и projectId ). Это позволяет легко взаимодействовать с API Google.

JSON-представление 
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Поля
name

string

Имя ресурса Проекта в формате:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : ProjectNumber проекта (рекомендуется) или его ProjectId .
Узнайте больше об использовании идентификаторов проектов в стандарте Google AIP 2510 .
Обратите внимание, что значением PROJECT_IDENTIFIER в любом теле ответа будет ProjectId .

projectId

string

Только вывод. Неизменяемый. Назначаемый пользователем уникальный идентификатор проекта.

Этот идентификатор может появляться в URL-адресах или именах некоторых ресурсов Firebase, связанных с Проектом, но обычно его следует рассматривать как удобный псевдоним для ссылки на Проект.

projectNumber

string ( int64 format)

Только вывод. Неизменяемый. Глобально уникальный канонический идентификатор проекта, присвоенный Google. Используйте этот идентификатор при настройке интеграции и/или вызове API к Firebase или сторонним сервисам.

displayName

string

Назначаемое пользователем отображаемое имя проекта.

resources

object ( DefaultResources )

Только вывод. Ресурсы Firebase по умолчанию, связанные с проектом.

state

enum ( State )

Только вывод. Состояние жизненного цикла Проекта.

annotations

map (key: string, value: string)

Набор пользовательских аннотаций для FirebaseProject .
Узнайте больше об аннотациях в стандарте Google AIP-128 .

Эти аннотации предназначены исключительно для разработчиков и клиентских инструментов. Сервисы Firebase не будут изменять этот набор аннотаций.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

etag

string

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

Узнайте больше об etag в стандарте Google AIP-154 .

Этот etag строго проверен.

Ресурсы по умолчанию

Ресурсы по умолчанию, связанные с проектом.

JSON-представление 
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Поля
hostingSite

string

Только вывод. Имя сайта хостинга Firebase по умолчанию в формате:

PROJECT_ID

Хотя это случается редко, ваш projectId может уже использоваться в качестве имени существующего сайта хостинга в другом проекте (узнайте больше о создании дополнительных сайтов , отличных от стандартных). В этих случаях к вашему projectId добавляется дефис, а затем пять буквенно-цифровых символов, чтобы создать имя хостинг-сайта по умолчанию. Например, если ваш projectId — myproject123 , имя вашего сайта хостинга по умолчанию может быть: myproject123-a5c16

realtimeDatabaseInstance

string

Только вывод. Имя экземпляра базы данных Firebase Realtime по умолчанию в формате:

PROJECT_ID

В редких случаях ваш projectId может уже использоваться в качестве имени существующего экземпляра базы данных реального времени в другом проекте (подробнее о сегментировании базы данных ). В этих случаях к вашему projectId добавляется дефис, а затем пять буквенно-цифровых символов, чтобы создать имя экземпляра базы данных реального времени по умолчанию. Например, если ваш projectId — myproject123 , имя экземпляра вашей базы данных по умолчанию может быть: myproject123-a5c16

storageBucket

string

Только вывод. Облачное хранилище по умолчанию для сегмента хранилища Firebase в формате:

PROJECT_ID .appspot.com

locationId

string

Только вывод. Идентификатор местоположения ресурса GCP проекта по умолчанию. Это одно из доступных местоположений ресурсов GCP .

Это поле опускается, если местоположение ресурса GCP по умолчанию еще не определено. Чтобы установить местоположение ресурса GCP проекта по умолчанию, вызовите defaultLocation.finalize после добавления ресурсов Firebase в проект.

Состояние

Возможные состояния жизненного цикла проекта. Узнайте больше о состояниях стандарта Google AIP-216 .

Перечисления
STATE_UNSPECIFIED Неустановленное состояние.
ACTIVE Проект активен.
DELETED Проект был мягко удален.

Методы

addFirebase

 Добавляет ресурсы Firebase в указанный существующий Project Google Cloud Platform (GCP) .

addGoogleAnalytics

 Связывает указанный FirebaseProject с существующей учетной записью Google Analytics .

get

 Получает указанный FirebaseProject .

getAdminSdkConfig

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

getAnalyticsDetails

 Получает сведения Google Analytics, связанные в данный момент с указанным FirebaseProject .

list

 Перечисляет все FirebaseProject доступные вызывающему объекту.

patch

 Обновляет атрибуты указанного FirebaseProject .

removeAnalytics

 Отключает указанный FirebaseProject от его аккаунта Google Analytics.

searchApps

 Перечисляет все доступные приложения для указанного FirebaseProject .