Method: projects.searchApps

指定された FirebaseProject で利用可能なすべてのアプリのリストを取得します。

これは便利な方法です。通常、アプリとのやり取りはプラットフォーム固有のサービスを使用して行いますが、一部のツール ユースケース（アプリセレクタ インターフェースなど）では、既知のすべてのアプリの一覧が必要となります。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

アプリを一覧表示する親 FirebaseProject。次の形式で指定します。

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER 値の詳細については、FirebaseProject の name フィールドをご覧ください。

クエリ パラメータ

パラメータ
pageToken

string

前回の projects.searchApps の呼び出しから返されたトークン。アプリのセット内のどこから一覧表示を再開するかを示します。
pageSize

integer

レスポンスで返すアプリの最大数。

サーバー独自の判断で、返される数がこれより少なくなる場合があります。値が指定されていない場合（または指定された値が大きすぎる場合）は、固有の制限が課されます。

負の値を指定することはできません。
filter

string

Google の AIP-160 標準と互換性のあるクエリ文字列。

クエリでは次のいずれかのフィールドを使用します。

このクエリは、次の「仮想」テーブルもサポートしています。表示されます。これらは実際には返されるリソース オブジェクトの一部ではないフィールドですが、特定の値が事前入力されたかのようにクエリできます。

  • sha1_hash または sha1Hashes: このフィールドは、AndroidApp に登録されているすべての SHA-1 証明書フィンガープリントのリストが入力された繰り返し string フィールドであるとみなされます。アプリが AndroidApp でない場合、このリストは空です。
  • sha256_hash または sha256Hashes: このフィールドは、AndroidApp に登録されているすべての SHA-256 証明書フィンガープリントのリストが入力された繰り返し string フィールドであるとみなされます。アプリが AndroidApp でない場合、このリストは空です。
  • appStoreId: このフィールドは、IosApp で登録された Apple App Store ID が入力された単一の string フィールドとみなされます。アプリが IosApp でない場合、このフィールドは空です。
  • teamId: このフィールドは、IosApp で登録された Apple チーム ID が入力された単一の string フィールドとみなされます。アプリが 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 キーの 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 アプリはウェブに関連付けられています。