Как настроить проект Firebase и управлять им с помощью Management REST API

Firebase Management REST API позволяет программно настраивать проекты Firebase и управлять ими, в том числе ресурсами и приложениями Firebase.

В этом обзоре описывается общий рабочий процесс добавления ресурсов и приложений Firebase в существующий проект Google Cloud, в котором ещё не используются сервисы Firebase.

Вы можете перейти к определенным разделам этой страницы, если хотите:

Прежде чем выполнять инструкции на этой странице, включите API.

Информацию об управлении доступом для Firebase Management API можно найти в документации по Cloud Identity Access Management (IAM) API.

Подготовка

Прежде чем начать, включите Management API для проекта Google Cloud и сгенерируйте токен доступа.

Включите Management REST API для проекта Google Cloud

Если вы ещё этого не сделали, включите Firebase Management API для использования с проектом Google Cloud.

  1. Откройте страницу Firebase Management API в Google API Console.
  2. При появлении запроса выберите проект Google Cloud.
  3. Нажмите Включить на странице Firebase Management API.

Как сгенерировать токен доступа к API

Ниже приведен пример кода Node.js, который получает токен доступа.

Если вы не используете среду Google Cloud, задайте для переменной среды GOOGLE_APPLICATION_CREDENTIALS путь к ключу сервисного аккаунта.

Linux или macOS

export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json"

Windows

С помощью PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\your\service-account-file.json"

Затем используйте Firebase Admin SDK, чтобы получить токен доступа из учетных данных сервисного аккаунта:

import { initializeApp, applicationDefault } from "firebase-admin/app";

initializeApp();

async function getAccessToken() {
  try {
    const accessToken = await applicationDefault().getAccessToken();
    return accessToken.access_token;
  } catch (err) {
    console.error('Unable to get access token');
    console.error(err);
  }
}

Как найти название ресурса проекта

Вы можете найти Google Cloud проектов, в которые можно добавить сервисы Firebase.

ЗАПРОСИТЬ

Позвонить availableProjects.list. Тело запроса для этого вызова должно быть пустым.

Ниже приведен пример запроса списка доступных проектов Google Cloud на Node.js.

const fetch = require('node-fetch');

async function listProjects() {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/availableProjects';
  const options = {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    const projects = resp['projectInfo'];
    console.log('Project total: ' + projects.length);
    console.log('');
    for (let i in projects) {
      const project = projects[i];
      console.log('Project ' + i);
      console.log('ID: ' + project['project']);
      console.log('Display Name: ' + project['displayName']);
      console.log('');
    }
  } catch(err) {
    console.error(err);
  }
}

РЕЗУЛЬТАТ

Тело ответа на вызов availableProjects.list содержит список объектов ProjectInfo. Если список проектов слишком длинный, тело ответа также содержит параметр nextPageToken, который можно использовать в качестве параметра запроса для получения следующей страницы проектов.

Ниже приведен пример тела ответа на вызов availableProjects.list.

{
  "projectInfo": [
    {
      "project": "projects/first-cloud-project",
      "displayName": "First Cloud Project"
    },
    {
      "project": "projects/second-cloud-project",
      "displayName": "Second Cloud Project"
    }
  ]
}

В этом примере ответа есть два проекта Google Cloud, в которые можно добавить сервисы Firebase. Обратите внимание, что в поле project указано глобально уникальное название ресурса для проекта.

Вы можете использовать любое значение project, указанное в ответе от availableProjects.list, чтобы добавить сервисы Firebase или добавить приложения в проект.

В следующем разделе мы добавим сервисы Firebase в First Cloud Project, используя название ресурса projects/first-gcp-project.

Добавьте сервисы Firebase в проект

Google Cloud проектов могут использовать сервисы Firebase. В этом разделе вы узнаете, как программно добавить сервисы Firebase в существующий проект Google Cloud. Обратите внимание, что вы также можете добавить сервисы Firebase в существующий проект Google Cloud в консоли Firebase.

ЗАПРОСИТЬ

Позвонить projects.addFirebase. Тело запроса для этого вызова должно быть пустым.

Ниже приведен пример добавления сервисов Firebase в проект Google Cloud для Node.js.

const fetch = require('node-fetch');

async function addFirebase(projectId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + ':addFirebase';
  const options = {
    method: 'POST',
    // Use a manual access token here since explicit user access token is required.
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

РЕЗУЛЬТАТ

Результатом вызова projects.addFirebase является Operation. Прежде чем вызывать другие конечные точки Firebase для проекта, убедитесь, что операция выполнена успешно.

Чтобы проверить, успешно ли выполнена операция, вы можете вызывать метод operations.get, пока значение done не станет равно true, а response не будет иметь тип FirebaseProject. Если операция не выполнена, для ее поля error задается значение google.rpc.Status.

Вот тело ответа на вызов operations.get:

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.FirebaseProject",
    "projectId": "first-cloud-project",
    "projectNumber": "...",
    "displayName": "First Cloud Project",
    "name": "projects/first-cloud-project",
    "resources": {
      "hostingSite": "first-cloud-project",
      "realtimeDatabaseInstance": "first-cloud-project"
    }
  }
}

Поскольку done – это true, а тип response – FirebaseProject, в проекте Google Cloud теперь есть сервисы Firebase. Ответ также содержит другую полезную информацию о созданном объекте FirebaseProject, например его projectNumber и resources по умолчанию. После завершения Operation автоматически удаляется.

Добавьте приложения Firebase в проект

FirebaseProject можно использовать в разных приложениях, в том числе для iOS, Android и веб-приложениях. В этом разделе вы узнаете, как программно добавить приложения Firebase в существующий проект FirebaseProject. Вы также можете добавить приложения Firebase в существующий проект Firebase в консоли Firebase.

Выберите тип приложения Firebase, которое нужно добавить в проект Firebase.

iOS+

Вы можете добавить приложение Firebase для iOS в существующий проект Firebase.

ЗАПРОСИТЬ

Позвонить projects.iosApps.create. Вот как составить тело запроса:

  • Обязательно:

    • bundleId – канонический идентификатор пакета приложения для iOS, который используется в магазине приложений iOS.
  • Рекомендуем также:

    • displayName – отображаемое название приложения, назначенное пользователем. Оно позволяет найти приложение в консоли Firebase.

    • appStoreId – автоматически сгенерированный идентификатор Apple ID, назначенный вашему приложению компанией Apple. Укажите appStoreId, если он уже назначен Apple.

В теле запроса для нашего примера мы будем использовать только displayName и bundleId:

{
  "displayName": "My Firebase iOS App",
  "bundleId": "com.firebase.ios"
}

Ниже приведен пример добавления приложения Firebase для iOS в проект Firebase с помощью Node.js.

const fetch = require('node-fetch');

async function addIosApp(projectId, displayName, bundleId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + '/iosApps';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'displayName': displayName,
      'bundleId': bundleId
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

РЕЗУЛЬТАТ

Результатом вызова projects.iosApps.create является Operation. Прежде чем вызывать другие конечные точки Firebase для проекта, убедитесь, что операция выполнена успешно.

Чтобы проверить, успешно ли выполнена операция, вы можете вызывать operations.get для операции, пока значение done не станет true, а его response не будет иметь тип IosApp. Если операция не выполнена, для ее поля error задается значение google.rpc.Status.

Вот тело ответа на вызов operations.get:

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.IosApp",
    "name": "projects/first-cloud-project/iosApps/...",
    "appId": "...",
    "displayName": "My Firebase iOS App",
    "projectId": "first-cloud-project",
    "bundleId": "com.firebase.ios"
  }
}

Поскольку done – это true, а тип response – это IosApp, то FirebaseProject теперь имеет IosApp. Ответ также содержит другую полезную информацию о созданном приложении Firebase для iOS, например уникальный идентификатор appId. После завершения Operation автоматически удаляется.

Android

Вы можете добавить приложение Firebase для Android в существующий проект Firebase.

ЗАПРОСИТЬ

Позвонить projects.androidApps.create. Вот как составить тело запроса:

  • Обязательно:

    • packageName – каноническое название пакета приложения для Android, которое отображается в Google Play Console.
  • Рекомендуем также:

    • displayName – название приложения, которое задал пользователь. Оно поможет найти приложение в консоли Firebase.

В теле запроса для нашего примера мы будем использовать packageName и displayName:

{
  "displayName": "My Firebase Android App"
  "packageName": "com.firebase.android"
}

Ниже приведен пример кода Node.js, который добавляет приложение Firebase для Android в проект Firebase.

const fetch = require('node-fetch');

async function addAndroidApp(projectId, displayName, packageName) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + '/androidApps';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'displayName': displayName,
      'packageName': packageName
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

РЕЗУЛЬТАТ

Результатом вызова projects.androidApps.create является Operation. Прежде чем вызывать другие конечные точки Firebase для проекта, убедитесь, что операция выполнена успешно.

Чтобы проверить, успешно ли выполнена операция, вы можете вызывать метод operations.get, пока значение done не станет равно true, а response не будет иметь тип AndroidApp. Если операция не выполнена, для ее поля error задается значение google.rpc.Status.

Вот тело ответа на вызов operations.get:

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.AndroidApp",
    "name": "projects/first-cloud-project/androidApps/...",
    "appId": "...",
    "displayName": "My Firebase Android App",
    "projectId": "first-cloud-project",
    "packageName": "com.firebase.android"
  }
}

Поскольку done – это true, а тип response – это AndroidApp, то FirebaseProject теперь имеет AndroidApp. Ответ также содержит другую полезную информацию о созданном приложении Firebase для Android, например уникальный идентификатор Firebase appId. Operation автоматически удаляется после завершения.

Добавьте сертификаты SHA

Вы можете добавить сертификаты SHA в любое существующее приложение Firebase для Android, вызвав projects.androidApps.sha.create. Тело запроса для этого вызова метода должно содержать пустое поле name. Результатом этого вызова является новый экземпляр ShaCertificate.

При вызове projects.androidApps.sha.create необходимо указать действительный хеш сертификата SHA-1 или SHA-256. Получить хеш SHA сертификата подписи можно с помощью команды gradle signingReport:

./gradlew signingReport

Дополнительную информацию можно найти в статье API Google для Android.

Веб-приложение

Вы можете добавить веб-приложение Firebase в существующий проект Firebase.

ЗАПРОСИТЬ

Позвонить projects.webApps.create. Вот как составить тело запроса:

  • Необязательно.

    • displayName – отображаемое название приложения, заданное пользователем. Оно поможет вам найти приложение в консоли Firebase.
  • Не рекомендуется:

    • appUrls – полные URL, по которым размещено приложение. Когда веб-приложение Firebase связано с сайтом Firebase Hosting, Firebase автоматически заполняет эти поля, поэтому оставьте их пустыми в теле запроса.

В нашем примере мы укажем в теле запроса только displayName:

{
  "displayName": "My Firebase Web App"
}

Ниже приведен пример добавления веб-приложения Firebase в проект Firebase для Node.js.

const fetch = require('node-fetch');

async function addWebApp(projectId, displayName) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + '/webApps';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'displayName': displayName
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

РЕЗУЛЬТАТ

Результатом вызова projects.webApps.create является Operation. Прежде чем вызывать другие конечные точки Firebase для проекта, убедитесь, что операция выполнена успешно.

Чтобы проверить, успешно ли выполнена операция, вы можете вызывать operations.get для операции, пока значение done не станет true, а его response не будет иметь тип WebApp. Если операция не выполнена, для ее поля error задается значение google.rpc.Status.

Вот тело ответа на вызов operations.get:

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.WebApp",
    "name": "projects/first-cloud-project/webApps/...",
    "appId": "...",
    "displayName": "My Firebase Web App",
    "projectId": "first-cloud-project"
  }
}

Поскольку done – это true, а тип response – это WebApp, у FirebaseProject теперь есть WebApp. Ответ также содержит другую полезную информацию о вашем новом веб-приложении Firebase, например уникальный идентификатор appId. После завершения Operation автоматически удаляется.

Вы можете программно связать существующий аккаунт Google Аналитики с существующим аккаунтом FirebaseProject. Вы также можете связать существующий проект Firebase с Google Аналитикой на вкладке Integrations (Интеграция) в разделе Project Settings (Настройки проекта).

Для вызова projects.addGoogleAnalytics требуется analytics_resource, который может быть analyticsAccountId или analyticsPropertyId:

  • Укажите существующий analyticsAccountId, чтобы создать новый ресурс Google Аналитики в указанном аккаунте и связать его с проектом Firebase.

  • Укажите существующий analyticsPropertyId, чтобы связать ресурс Google Аналитики с проектом Firebase.

Найти analyticsAccountId и существующие analyticsPropertyId можно на сайте Google Аналитики.

Когда вы звоните в projects.addGoogleAnalytics:

  1. Сначала система проверяет, соответствуют ли существующие потоки данных в ресурсе Google Аналитики существующим приложениям Firebase в вашем проекте FirebaseProject (на основе packageName или bundleId, связанных с потоком данных). Затем потоки данных и приложения связываются. Обратите внимание, что автоматическое связывание применяется только к приложениям Android и приложениям iOS.

  2. Если для приложений Firebase не будут найдены соответствующие потоки данных, в ресурсе Google Аналитики будут созданы новые потоки данных для каждого из приложений Firebase. Обратите внимание, что для веб-приложения всегда создается новый поток данных, даже если ранее оно было связано с потоком данных в вашем ресурсе Аналитики.

Подробнее об иерархии и структуре аккаунтов Google Аналитики рассказывается в документации Аналитики.

ЗАПРОСИТЬ

Позвонить projects.addGoogleAnalytics.

В теле запроса для нашего примера вызова project.addGoogleAnalytics мы укажем аккаунт Google Аналитики analyticsAccountId. Этот вызов создаст новый ресурс Google Аналитики и свяжет его с FirebaseProject.

{
  "analyticsAccountId": "<your-google-analytics-account-id>"
}

Ниже приведен пример кода Node.js для связывания проекта Firebase с аккаунтом Google Аналитики.

const fetch = require('node-fetch');

async function addGoogleAnalytics(projectId, analyticsAccountId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + ':addGoogleAnalytics';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'analyticsAccountId': analyticsAccountId
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

РЕЗУЛЬТАТ

Результатом вызова projects.addGoogleAnalytics является Operation. Прежде чем вызывать другие конечные точки Firebase для проекта, убедитесь, что операция выполнена успешно.

Чтобы проверить, успешно ли выполнена операция, вы можете вызывать operations.get, пока значение done не станет true, а response не будет иметь тип analyticsDetails. Если операция не выполнена, для ее поля error задается значение google.rpc.Status.

Вот тело ответа на вызов operations.get:

{
  "name": "operations/...",
  "none": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.AnalyticsDetails",
    "analyticsProperty": [
      {
        "id": "...",
        "displayName": "..."
      }
    ],
    "streamMappings": [
      {
        "app": "...",
        "streamId": "...",
        "measurementId": "..."
      }
    ]
  }
}

Поскольку done имеет значение true, а тип response – analyticsDetails, FirebaseProject теперь связан с указанным аккаунтом Google Аналитики. После завершения Operation автоматически удаляется.