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_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の呼び出しからの結果の 1 ページ。

nextPageToken

string

結果リストが大きすぎて 1 つの応答に収まらない場合は、トークンが返されます。

このトークンは、 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を使用します。

この文字列は、各プラットフォームのネイティブ識別子 ( AndroidAppの場合はpackageName 、 IosAppの場合はbundleId 、 WebAppの場合はwebIdから派生します。ネイティブ識別子の形式はプラットフォームの進化に応じて変更される可能性があるため、その内容は不透明なものとして扱う必要があります。この文字列は、 FirebaseProjectとそれに関連付けられたアプリ内でのみ一意です。

apiKeyId

string

アプリに関連付けられた Firebase API キーに Google が割り当てた、グローバルに一意な識別子 (UID)。

この値は API キーのkeyStringではなく、API キーの UID であることに注意してください。 keyStringアプリの構成アーティファクト ( AndroidApp | IosApp | WebApp ) で見つかる値です。

アプリ（ AndroidApp | IosApp | WebApp ）を作成するリクエストにapiKeyId設定されていない場合、Firebase は自動的にapiKeyIdをアプリに関連付けます。この自動関連付けされたキーは既存の有効なキーである可能性があります。有効なキーが存在しない場合は、新しいキーがプロビジョニングされます。

state

enum ( State )

出力のみ。アプリのライフサイクル状態。

アプリプラットフォーム

Firebase アプリを関連付けることができるプラットフォーム。

列挙型
PLATFORM_UNSPECIFIED不明な状態。これは、未設定の値を区別するためにのみ使用されます。
IOS Firebase アプリは iOS に関連付けられています。
ANDROID Firebase アプリは Android に関連付けられています。
WEB Firebase アプリはウェブに関連付けられています。