Method: projects.searchApps

Muestra una lista de todas las apps disponibles para el FirebaseProject especificado.

Este es un método conveniente. Por lo general, la interacción con una app debe realizarse mediante el servicio específico de la plataforma, pero algunos casos prácticos de herramientas requieren un resumen de todas las apps conocidas (como las interfaces de selección de app).

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

El FirebaseProject superior para el que se enumeran las apps, en el formato:

projects/PROJECT_IDENTIFIER

Consulta el campo FirebaseProject name para obtener detalles sobre los valores PROJECT_IDENTIFIER.

Parámetros de consulta

Parámetros
pageToken

string

El token que se muestra desde una llamada anterior a projects.searchApps que indica en qué lugar del conjunto de apps se puede reanudar la lista.

pageSize

integer

El número máximo de apps que se debe mostrar en la respuesta.

Es posible que el servidor muestre menos de este valor a discreción. Si no se especifica ningún valor (o se especifica un valor demasiado grande), el servidor impondrá su propio límite.

Este valor no puede ser negativo.

filter

string

Una cadena de consulta compatible con el estándar AIP-160 de Google.

Usa cualquiera de los siguientes campos en una consulta:

Esta consulta también admite los siguientes tipos "virtuales" . Estos son campos que, en realidad, no forman parte del objeto de recurso que se muestra, pero que se pueden consultar como si se completaran previamente con valores específicos.

  • sha1_hash o sha1Hashes: Este campo se considera un campo string repetido, que se propaga con la lista de todas las huellas digitales del certificado SHA-1 registradas con AndroidApp. Esta lista estará vacía si la app no es una AndroidApp.
  • sha256_hash o sha256Hashes: Este campo se considera un campo string repetido, que se propaga con la lista de todas las huellas digitales del certificado SHA-256 registradas con AndroidApp. Esta lista estará vacía si la app no es una AndroidApp.
  • appStoreId: Este campo se considera un campo string singular que se propaga con el ID de la App Store de Apple registrado con el IosApp. Este campo estará vacío si la app no es una IosApp.
  • teamId: Este campo se considera un campo string singular que se propaga con el ID del equipo de Apple registrado con IosApp. Este campo estará vacío si la app no es una IosApp.
showDeleted

boolean

Controla si se deben mostrar las apps en el estado DELETED.

Si no se especifica, solo se mostrarán las apps de ACTIVE.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Campos
apps[]

object (FirebaseAppInfo)

Una página de resultados a partir de una llamada a projects.searchApps.

nextPageToken

string

Si la lista de resultados es demasiado grande para caber en una sola respuesta, entonces se muestra un token.

Este token se puede usar en las llamadas posteriores a projects.searchApps para encontrar el siguiente grupo de apps.

Los tokens de página son de corta duración y no deben ser persistentes.

Alcances con autorización

Se necesita uno de los siguientes alcances de 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

Para obtener más información, consulta Descripción general de la autenticación.

FirebaseAppInfo

Un resumen de alto nivel de la app.

Representación JSON
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Campos
name

string

El nombre del recurso de la app de Firebase, en el formato:

projects/PROJECT_ID/iosApps/APP_ID

o

projects/PROJECT_ID/androidApps/APP_ID

o

projects/PROJECT_ID/webApps/APP_ID

displayName

string

El nombre visible de la app de Firebase asignado por el usuario.

platform

enum (AppPlatform)

La plataforma de la app de Firebase.

appId

string

Solo salida. Inmutable. El identificador único a nivel global asignado por Firebase para el WebApp.

Este identificador debe tratarse como un token opaco, ya que no se especifica el formato de los datos.

namespace

string

Solo salida. Inmutable. El identificador específico de la plataforma de la app.

Nota: En la mayoría de los casos de uso, usa appId, que es el identificador único canónico y único a nivel global para hacer referencia a una app.

Esta cadena deriva de un identificador nativo para cada plataforma: packageName para una AndroidApp, bundleId para una IosApp y webId para una WebApp. Su contenido debe tratarse como opaco, ya que el formato del identificador nativo puede cambiar a medida que evolucionan las plataformas. Esta cadena solo es única dentro de un FirebaseProject y sus apps asociadas.

apiKeyId

string

El identificador único a nivel global asignado por Google (UID) para la clave de API de Firebase asociada con la aplicación.

Ten en cuenta que este valor es el UID de la clave de API, no el keyString de la clave de API. El keyString es el valor que se puede encontrar en el artefacto de configuración de la app (AndroidApp | IosApp | WebApp).

Si apiKeyId no está configurado en las solicitudes para crear la app (AndroidApp | IosApp | WebApp), Firebase asocia automáticamente un apiKeyId con la app. Esta clave asociada de forma automática puede ser una clave válida existente o, si no existe una clave válida, se aprovisionará una nueva.

state

enum (State)

Solo salida. El estado del ciclo de vida de la app.

AppPlatform

Plataformas con las que se puede asociar una app de Firebase.

Enums
PLATFORM_UNSPECIFIED Estado desconocido. Esto solo se usa para distinguir valores no configurados.
IOS La app de Firebase está asociada con iOS.
ANDROID La app de Firebase está asociada con Android.
WEB La app de Firebase está asociada con la Web.