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 應用程式與網路相關聯。