Method: projects.searchApps

Enumera todas las aplicaciones disponibles para el FirebaseProject especificado.

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

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
parent

string

El FirebaseProject principal para el que enumerar aplicaciones, en el formato:

projects/ PROJECT_IDENTIFIER

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

Parámetros de consulta

Parámetros
pageToken

string

Token devuelto de una llamada anterior a projects.searchApps que indica dónde reanudar la lista en el conjunto de aplicaciones.

pageSize

integer

El número máximo de aplicaciones para devolver en la respuesta.

El servidor puede devolver menos de este valor a su 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.

Utilice cualquiera de los siguientes campos en una consulta:

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

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

boolean

Controla si se deben devolver las aplicaciones en estado DELETED .

Si no se especifica, solo se devolverán las aplicaciones ACTIVE .

cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

Si tiene éxito, 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 de una llamada a projects.searchApps .

nextPageToken

string

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

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

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

Ámbitos de autorización

Requiere uno de los siguientes ámbitos 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, consulte Descripción general de la autenticación .

FirebaseAppInfo

Un resumen de alto nivel de una aplicación.

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 aplicación 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 para mostrar asignado por el usuario de la aplicación Firebase.

platform

enum ( AppPlatform )

La plataforma de la aplicación Firebase.

appId

string

Solo salida. Inmutable. El identificador único global asignado por Firebase para la WebApp .

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

namespace

string

Solo salida. Inmutable. El identificador específico de la plataforma de la aplicación.

Nota: Para la mayoría de los casos de uso, use appId , que es el identificador canónico global único para hacer referencia a una aplicación.

Esta cadena se deriva de un identificador nativo para cada plataforma: packageName para AndroidApp , bundleId para IosApp y webId para 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 aplicaciones asociadas.

apiKeyId

string

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

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

Si no se establece apiKeyId en las solicitudes para crear la aplicación ( AndroidApp | IosApp | WebApp ), entonces Firebase asocia automáticamente un apiKeyId con la aplicación. Esta clave asociada automáticamente 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 aplicación.

Plataforma de aplicaciones

Plataformas con las que se puede asociar una aplicación de Firebase.

Enumeraciones
PLATFORM_UNSPECIFIED Estado desconocido. Esto solo se usa para distinguir valores no establecidos.
IOS La aplicación Firebase está asociada con iOS.
ANDROID La aplicación Firebase está asociada con Android.
WEB La aplicación Firebase está asociada con web.