Method: projects.searchApps

列出指定FirebaseProject的所有可用应用程序。

这是一种方便的方法。通常,与应用程序的交互应使用特定于平台的服务来完成,但某些工具用例需要所有已知应用程序的摘要(例如应用程序选择器界面)。

HTTP请求

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

URL 使用gRPC 转码语法。

路径参数

参数
parent

string

要列出应用程序的父FirebaseProject ,格式为:

projects/ PROJECT_IDENTIFIER

有关PROJECT_IDENTIFIER值的详细信息,请参阅FirebaseProject name字段。

查询参数

参数
pageToken

string

从先前对projects.searchApps的调用返回的令牌,指示应用程序集中要恢复列表的位置。

pageSize

integer

响应中返回的应用程序的最大数量。

服务器可能会自行决定返回小于此值的值。如果未指定值(或指定的值太大),则服务器将施加自己的限制。

该值不能为负数。

filter

string

与 Google 的AIP-160 标准兼容的查询字符串。

在查询中使用以下任意字段:

此查询还支持以下“虚拟”字段。这些字段实际上不是返回的资源对象的一部分,但可以查询它们,就好像它们预先填充了特定值一样。

  • sha1_hashsha1Hashes :此字段被视为重复string字段,填充有在AndroidApp中注册的所有 SHA-1 证书指纹的列表。如果应用程序不是AndroidApp ,则此列表为空。
  • sha256_hashsha256Hashes :此字段被视为重复string字段,填充有在AndroidApp中注册的所有 SHA-256 证书指纹的列表。如果应用程序不是AndroidApp ,则此列表为空。
  • appStoreId :此字段被视为单个string字段,填充有在IosApp中注册的 Apple App Store ID。如果应用程序不是IosApp ,则此字段为空。
  • teamId :此字段被视为单个string字段,填充有在IosApp中注册的 Apple 团队 ID。如果应用程序不是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

有关详细信息,请参阅身份验证概述

Firebase应用程序信息

应用程序的高级摘要。

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

仅输出。不变的。 Firebase 为WebApp分配的全局唯一标识符。

该标识符应被视为不透明令牌,因为未指定数据格式。

namespace

string

仅输出。不变的。应用程序特定于平台的标识符。

注意:对于大多数用例,请使用appId ,它是用于引用应用程序的规范的全局唯一标识符。

该字符串派生自每个平台的本机标识符: AndroidApppackageNameIosAppbundleIdWebAppwebId 。其内容应被视为不透明,因为本机标识符格式可能会随着平台的发展而变化。该字符串仅在FirebaseProject及其关联应用程序中是唯一的。

apiKeyId

string

与应用关联的 Firebase API 密钥的全局唯一的 Google 分配标识符 (UID)。

请注意,该值是 API 密钥的 UID,而不是API 密钥的keyStringkeyString是可以在应用程序的配置工件 ( AndroidApp | IosApp | WebApp ) 中找到的值。

如果在创建应用程序 ( AndroidApp | IosApp | WebApp ) 的请求中未设置apiKeyId ,则 Firebase 会自动将apiKeyId与该应用程序关联。该自动关联的密钥可以是现有的有效密钥,或者如果不存在有效密钥,则将提供新的密钥。

state

enum ( State )

仅输出。应用程序的生命周期状态。

应用平台

Firebase 应用程序可以关联的平台。

枚举
PLATFORM_UNSPECIFIED未知状态。这仅用于区分未设置的值。
IOS Firebase 应用程序与 iOS 关联。
ANDROID Firebase 应用程序与 Android 关联。
WEB Firebase 应用程序与网络相关联。