Method: projects.webApps.getConfig

Получает артефакт конфигурации, связанный с указанным WebApp .

HTTP-запрос

GET https://firebase.googleapis.com/v1beta1/{name=projects/*/webApps/*/config}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Имя ресурса загружаемой конфигурации WebApp в формате:

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID /config


Поскольку APP_ID является уникальным идентификатором, здесь можно использовать шаблон доступа «Уникальный ресурс из подколлекции» в формате:

projects/-/webApps/ APP_ID


Подробную информацию о значениях PROJECT_IDENTIFIER и APP_ID см. в поле name WebApp .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

Метаданные конфигурации одного веб-приложения Firebase.

JSON-представление
{
  "projectId": string,
  "appId": string,
  "databaseURL": string,
  "storageBucket": string,
  "locationId": string,
  "apiKey": string,
  "authDomain": string,
  "messagingSenderId": string,
  "measurementId": string
}
Поля
projectId

string

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

appId

string

Неизменный. Глобальный уникальный идентификатор WebApp , присвоенный Firebase.

databaseURL

string

URL-адрес базы данных Firebase Realtime по умолчанию.

storageBucket

string

Имя сегмента хранилища Cloud Storage по умолчанию для Firebase.

locationId

string

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

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

apiKey

string

keyString ключа API, связанного с WebApp .

Обратите внимание, что это значение не является apiKeyId (UID) ключа API, связанного с WebApp .

authDomain

string

Домен Firebase Auth настраивает перенаправления OAuth в формате:

PROJECT_ID .firebaseapp.com

messagingSenderId

string

Идентификатор отправителя для использования с Firebase Cloud Messaging.

measurementId

string

Уникальный идентификатор, присвоенный Google веб-потоку Google Analytics, связанному с WebApp . SDK Firebase используют этот идентификатор для взаимодействия с API Google Analytics.

Это поле присутствует только в том случае, если WebApp связано с веб-потоком в ресурсе Google Analytics "Приложение и сайт". Подробную информацию об этом идентификаторе и веб-потоках Google Analytics можно найти в документации Analytics .

Чтобы создать measurementId и связать WebApp с веб-потоком Google Analytics, вызовите projects.addGoogleAnalytics .

Для приложений, использующих Firebase JavaScript SDK версии 7.20.0 и более поздних версий, Firebase динамически извлекает measurementId , когда ваше приложение инициализирует Analytics. Наличие этого идентификатора в вашем объекте конфигурации не является обязательным, но он служит запасным вариантом в том редком случае, когда динамическая выборка не удалась.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

Для получения дополнительной информации см. Обзор аутентификации .