Method: projects.searchApps

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

这是一种方便的方法。通常，应该使用针对具体平台的服务完成与应用的交互，但一些工具用例需要所有已知应用（例如用于应用选择器界面）的摘要。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

要为其列出应用的父级 FirebaseProject，格式为：

projects/PROJECT_IDENTIFIER

请参阅 FirebaseProject name 字段，详细了解 PROJECT_IDENTIFIER 值。

查询参数

参数
pageToken

string

之前调用 projects.searchApps 返回的令牌，指示要在应用集中的什么位置恢复列表。
pageSize

integer

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

服务器可以自行决定返回少于此值的项目。如果未指定任何值（或指定的值太大），则服务器将强制执行其自己的限值。

该值不能为负数。
filter

string

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

在查询中使用以下任一字段：

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

  • sha1_hash 或 sha1Hashes：此字段被视为重复 string 字段，其中填充了通过 AndroidApp 注册的所有 SHA-1 证书指纹的列表。如果应用不是 AndroidApp，则此列表为空。
  • sha256_hash 或 sha256Hashes：此字段被视为重复 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

如需了解详情，请参阅身份验证概览。

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

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

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

string

仅限输出。不可变。应用的平台特定标识符。

注意：对于大多数用例，请使用 appId，这是用于引用应用的规范全局唯一标识符。

此字符串派生自各个平台的原生标识符：packageName（对于 AndroidApp）、bundleId（对于 IosApp）和 webId（对于 WebApp）。其内容应被视为不透明，因为原生标识符格式可能会随着平台的发展而发生变化。此字符串仅在 FirebaseProject 及其关联的应用中是唯一的。
apiKeyId

string

由 Google 为与应用关联的 Firebase API 密钥指定的全局唯一标识符 (UID)。

请注意，此值是 API 密钥的 UID，而不是 API 密钥的 keyString。keyString 是可在应用的配置工件 (AndroidApp | IosApp | WebApp) 中找到的值。

如果未在创建应用的请求 (AndroidApp | IosApp | WebApp) 中设置 apiKeyId，则 Firebase 会自动将 apiKeyId 与应用相关联。此自动关联的密钥可能是现有的有效密钥；如果没有有效的密钥，系统会配置新密钥。
state

enum (State)

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

AppPlatform

可与 Firebase 应用关联的平台。

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