Method: projects.searchApps

Lists all available Apps for the specified FirebaseProject.

This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent FirebaseProject for which to list Apps, in the format:

projects/PROJECT_IDENTIFIER

Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Query parameters

Parameters
pageToken

string

Token returned from a previous call to projects.searchApps indicating where in the set of Apps to resume listing.
pageSize

integer

The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative.
filter

string

A query string compatible with Google's AIP-160 standard.

Use any of the following fields in a query:

This query also supports the following "virtual" fields. These are fields which are not actually part of the returned resource object, but they can be queried as if they are pre-populated with specific values.

  • sha1_hash or sha1Hashes: This field is considered to be a repeated string field, populated with the list of all SHA-1 certificate fingerprints registered with the AndroidApp. This list is empty if the App is not an AndroidApp.
  • sha256_hash or sha256Hashes: This field is considered to be a repeated string field, populated with the list of all SHA-256 certificate fingerprints registered with the AndroidApp. This list is empty if the App is not an AndroidApp.
  • appStoreId: This field is considered to be a singular string field, populated with the Apple App Store ID registered with the IosApp. This field is empty if the App is not an IosApp.
  • teamId: This field is considered to be a singular string field, populated with the Apple team ID registered with the IosApp. This field is empty if the App is not an IosApp.
showDeleted

boolean

Controls whether Apps in the DELETED state should be returned.

If not specified, only ACTIVE Apps will be returned.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Fields
apps[]

object (FirebaseAppInfo)

One page of results from a call to projects.searchApps.
nextPageToken

string

If the result list is too large to fit in a single response, then a token is returned.

This token can be used in a subsequent calls to projects.searchApps to find the next group of Apps.

Page tokens are short-lived and should not be persisted.

Authorization scopes

Requires one of the following OAuth scopes:

  • 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

For more information, see the Authentication Overview.

FirebaseAppInfo

A high-level summary of an App.

JSON representation 
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State),
  "expireTime": string
}
Fields
name

string

The resource name of the Firebase App, in the format:

projects/PROJECT_ID/iosApps/APP_ID

or

projects/PROJECT_ID/androidApps/APP_ID

or

projects/PROJECT_ID/webApps/APP_ID
displayName

string

The user-assigned display name of the Firebase App.
platform

enum (AppPlatform)

The platform of the Firebase App.
appId

string

Output only. Immutable. The globally unique, Firebase-assigned identifier for the WebApp.

This identifier should be treated as an opaque token, as the data format is not specified.
namespace

string

Output only. Immutable. The platform-specific identifier of the App.

Note: For most use cases, use appId, which is the canonical, globally unique identifier for referencing an App.

This string is derived from a native identifier for each platform: packageName for an AndroidApp, bundleId for an IosApp, and webId for a WebApp. Its contents should be treated as opaque, as the native identifier format may change as platforms evolve. This string is only unique within a FirebaseProject and its associated Apps.
apiKeyId

string

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the App.

Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact (AndroidApp | IosApp | WebApp).

If apiKeyId is not set in requests to create the App (AndroidApp | IosApp | WebApp), then Firebase automatically associates an apiKeyId with the App. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.
state

enum (State)

Output only. The lifecycle state of the App.
expireTime

string (Timestamp format)

Output only. If the App has been removed from the Project, this is the timestamp of when the App is considered expired and will be permanently deleted. After this time, the App cannot be undeleted (that is, restored to the Project).

This value is only provided if the App is in the DELETED state.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

AppPlatform

Platforms with which a Firebase App can be associated.

Enums
PLATFORM_UNSPECIFIED Unknown state. This is only used for distinguishing unset values.
IOS The Firebase App is associated with iOS.
ANDROID The Firebase App is associated with Android.
WEB The Firebase App is associated with web.