コンソールへ移動

メソッド: projects.searchApps

指定した FirebaseProject で使用可能なすべてのアプリを一覧表示する便利なメソッド。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

アプリをリストする親プロジェクト。形式は次のとおりです。

projects/project-id

クエリ パラメータ

パラメータ
pageToken

string

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

pageSize

number

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

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

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

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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
}
フィールド
name

string

Firebase アプリの完全修飾リソース名。形式は次のとおりです。

projects/project-id/ios/app-id

displayName

string

ユーザーが割り当てた Firebase アプリの表示名。

platform

enum(AppPlatform)

Firebase アプリのプラットフォーム。

appId

string

不変。Firebase によって割り当てられたアプリのグローバル一意識別子。

この識別子はデータ形式が指定されておらず、不透明トークンとして扱う必要があります。

AppPlatform

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

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

試してみましょう