指定されたFirebaseProject
で使用可能なすべてのアプリをリストします。
これは便利な方法です。通常、アプリとの対話はプラットフォーム固有のサービスを使用して行う必要がありますが、一部のツールの使用例では、すべての既知のアプリの概要が必要になります (アプリ セレクター インターフェイスなど)。
HTTPリクエスト
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}:searchApps
URL はgRPC トランスコーディング構文を使用します。
パスパラメータ
パラメーター | |
---|---|
parent | アプリをリストする親 PROJECT_IDENTIFIER値の詳細については、 |
クエリパラメータ
パラメーター | |
---|---|
pageToken | アプリのセット内のどこでリストを再開するかを示す、 |
pageSize | 応答で返されるアプリの最大数。 サーバーはその裁量により、この値よりも少ない値を返す場合があります。値が指定されていない場合 (または大きすぎる値が指定されている場合)、サーバーは独自の制限を課します。 この値を負にすることはできません。 |
filter | Google のAIP-160 標準と互換性のあるクエリ文字列。 クエリでは次のフィールドのいずれかを使用します。 このクエリは、次の「仮想」フィールドもサポートしています。これらのフィールドは実際には返されるリソース オブジェクトの一部ではありませんが、特定の値が事前に入力されているかのようにクエリを実行できます。
|
showDeleted | 指定しない場合は、 |
リクエストボディ
リクエストの本文は空である必要があります。
レスポンスボディ
成功した場合、応答本文には次の構造のデータが含まれます。
JSON表現 |
---|
{
"apps": [
{
object ( |
田畑 | |
---|---|
apps[] | |
nextPageToken | 結果リストが大きすぎて 1 つの応答に収まらない場合は、トークンが返されます。 このトークンは、 ページ トークンの有効期間は短いため、永続化しないでください。 |
認可の範囲
次の 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 ( |
田畑 | |
---|---|
name | Firebase アプリのリソース名。次の形式です。 または
または
|
displayName | ユーザーが割り当てた Firebase アプリの表示名。 |
platform | Firebase アプリのプラットフォーム。 |
appId | 出力のみ。不変。 Firebase によって割り当てられた データ形式が指定されていないため、この識別子は不透明なトークンとして扱う必要があります。 |
namespace | 出力のみ。不変。アプリのプラットフォーム固有の識別子。 注:ほとんどの使用例では、アプリを参照するための正規のグローバルに一意の識別子である この文字列は、各プラットフォームのネイティブ識別子 ( |
apiKeyId | アプリに関連付けられた Firebase API キーに Google が割り当てた、グローバルに一意な識別子 (UID)。 この値は API キーの アプリ( |
state | 出力のみ。アプリのライフサイクル状態。 |
アプリプラットフォーム
Firebase アプリを関連付けることができるプラットフォーム。
列挙型 | |
---|---|
PLATFORM_UNSPECIFIED | 不明な状態。これは、未設定の値を区別するためにのみ使用されます。 |
IOS | Firebase アプリは iOS に関連付けられています。 |
ANDROID | Firebase アプリは Android に関連付けられています。 |
WEB | Firebase アプリはウェブに関連付けられています。 |