Method: projects.searchApps

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

Это удобный метод. Обычно взаимодействие с приложением должно осуществляться с помощью службы, специфичной для платформы, но в некоторых случаях использования инструмента требуется сводка всех известных приложений (например, для интерфейсов выбора приложений).

HTTP-запрос

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}:searchApps

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

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

Параметры
parent

string

Родительский FirebaseProject для которого нужно перечислить приложения, в формате:

projects/ PROJECT_IDENTIFIER

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

Параметры запроса

Параметры
pageToken

string

Токен, возвращенный из предыдущего вызова projects.searchApps указывает, где в наборе приложений возобновляется список.

pageSize

integer

Максимальное количество приложений, возвращаемых в ответе.

Сервер может вернуть меньшее значение по своему усмотрению. Если значение не указано (или указано слишком большое значение), то сервер наложит свой собственный лимит.

Это значение не может быть отрицательным.

filter

string

Строка запроса, совместимая со стандартом Google AIP-160 .

Используйте любое из следующих полей в запросе:

Этот запрос также поддерживает следующие «виртуальные» поля. Это поля, которые на самом деле не являются частью возвращаемого объекта ресурса, но их можно запрашивать, как если бы они были предварительно заполнены конкретными значениями.

  • sha1_hash или sha1Hashes : это поле считается повторяющимся string полем, заполненным списком всех отпечатков сертификатов SHA-1, зарегистрированных в AndroidApp . Этот список пуст, если приложение не является AndroidApp .
  • sha256_hash или sha256Hashes : это поле считается повторяющимся string полем, заполненным списком всех отпечатков сертификатов SHA-256, зарегистрированных в AndroidApp . Этот список пуст, если приложение не является AndroidApp .
  • appStoreId : это поле считается string полем единственного числа , заполненным идентификатором Apple App Store, зарегистрированным в IosApp . Это поле пусто, если приложение не является IosApp .
  • teamId : это поле считается единичным string полем, заполненным идентификатором команды Apple, зарегистрированным в IosApp . Это поле пусто, если приложение не является IosApp .
showDeleted

boolean

Определяет, следует ли возвращать приложения в состоянии DELETED .

Если не указано, будут возвращены только ACTIVE приложения.

Тело запроса

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

Тело ответа

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

JSON-представление 
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Поля
apps[]

object ( FirebaseAppInfo )

Одна страница результатов вызова projects.searchApps .

nextPageToken

string

Если список результатов слишком велик, чтобы поместиться в один ответ, возвращается токен.

Этот токен можно использовать при последующих вызовах projects.searchApps для поиска следующей группы приложений.

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

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

Требуется одна из следующих областей 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

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

FirebaseAppInfo

Общее описание приложения.

JSON-представление 
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Поля
name

string

Имя ресурса приложения Firebase в формате:

projects/ PROJECT_ID /iosApps/ APP_ID

или

projects/ PROJECT_ID /androidApps/ APP_ID

или

projects/ PROJECT_ID /webApps/ APP_ID

displayName

string

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

platform

enum ( AppPlatform )

Платформа приложения Firebase.

appId

string

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

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

namespace

string

Только вывод. Неизменяемый. Идентификатор приложения, зависящий от платформы.

Примечание. В большинстве случаев используйте appId — канонический глобальный уникальный идентификатор для ссылки на приложение.

Эта строка получена из собственного идентификатора для каждой платформы: packageName для AndroidApp , bundleId для IosApp и webId для WebApp . Его содержимое следует рассматривать как непрозрачное, поскольку собственный формат идентификатора может меняться по мере развития платформ. Эта строка уникальна только в пределах FirebaseProject и связанных с ним приложений.

apiKeyId

string

Глобальный уникальный идентификатор (UID), присвоенный Google, для ключа API Firebase, связанного с приложением.

Имейте в виду, что это значение представляет собой UID ключа API, а не keyString ключа API. keyString — это значение, которое можно найти в артефакте конфигурации приложения ( AndroidApp | IosApp | WebApp ).

Если apiKeyId не установлен в запросах на создание приложения ( AndroidApp | IosApp | WebApp ), то Firebase автоматически связывает apiKeyId с приложением. Этот автоматически ассоциированный ключ может быть существующим действительным ключом или, если действительный ключ не существует, будет предоставлен новый.

state

enum ( State )

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

Платформа приложений

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

Перечисления
PLATFORM_UNSPECIFIED Неизвестное государство. Это используется только для различения неустановленных значений.
IOS Приложение Firebase связано с iOS.
ANDROID Приложение Firebase связано с Android.
WEB Приложение Firebase связано с web.