Method: projects.searchApps

列出指定 FirebaseProject 的所有可用應用程式。

這個方法十分便利。一般來說，您應該透過平台專屬的服務與應用程式互動，但有些工具用途需要在所有已知應用程式的摘要 (例如應用程式選取器介面) 中取得摘要。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

用來列出應用程式的父項 FirebaseProject，格式為：

projects/PROJECT_IDENTIFIER

如要進一步瞭解 PROJECT_IDENTIFIER 值，請參閱 FirebaseProject name 欄位。

查詢參數

參數
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 ID。

由於未指定資料格式，因此這個 ID 應視為不透明權杖。
namespace

string

僅供輸出。不可變動。應用程式的平台專屬 ID。

注意：在大多數情況下，請使用 appId，這是參照應用程式的標準全域專屬 ID。

這個字串衍生自每個平台的原生 ID：packageName (AndroidApp、bundleId 的 IosApp 和 WebApp 的 webId)。由於原生 ID 格式可能會隨著平台演進而變更，因此內容應視為不透明格式。這個字串只會在 FirebaseProject 及其相關 Apps 中重複出現。
apiKeyId

string

Google 為與應用程式相關聯的 Firebase API 金鑰指派的全域專屬 ID (UID)。

請注意，這個值是 API 金鑰的 UID，而「不是」API 金鑰的 keyString。keyString 是可在應用程式的設定構件 (AndroidApp | IosApp | WebApp) 中找到的值。

如果未在建立應用程式的要求中設定 apiKeyId (AndroidApp | IosApp | WebApp)，Firebase 就會自動將 apiKeyId 與該應用程式建立關聯。這組自動建立關聯的金鑰可能是現有的有效金鑰，如果沒有有效的金鑰，則會佈建新的金鑰。
state

enum (State)

僅供輸出。應用程式的生命週期狀態。

應用程式平台

可與 Firebase 應用程式建立關聯的平台。

列舉
PLATFORM_UNSPECIFIED 狀態不明。這個引數只會用來區分未設定的值。
IOS Firebase 應用程式已與 iOS 建立關聯。
ANDROID Firebase 應用程式已與 Android 建立關聯。
WEB Firebase 應用程式已與網站建立關聯。