Method: projects.searchApps

Elenca tutte le app disponibili per il FirebaseProject specificato.

Questo è un metodo conveniente. In genere, l'interazione con un'app deve essere eseguita utilizzando il servizio specifico della piattaforma, ma alcuni casi d'uso dello strumento richiedono un riepilogo di tutte le app conosciute (ad esempio per le interfacce di selezione delle app).

Richiesta HTTP

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

L'URL usa la sintassi di transcodifica gRPC .

Parametri del percorso

Parametri
parent

string

Il FirebaseProject genitore per il quale elencare le app, nel formato:

projects/ PROJECT_IDENTIFIER

Fare riferimento al campo name FirebaseProject per dettagli sui valori PROJECT_IDENTIFIER .

Parametri di query

Parametri
pageToken

string

Token restituito da una chiamata precedente a projects.searchApps che indica dove riprendere l'elenco nell'insieme di app.

pageSize

integer

Il numero massimo di app da restituire nella risposta.

Il server può restituire un valore inferiore a questo valore a sua discrezione. Se non viene specificato alcun valore (o viene specificato un valore troppo grande), il server imporrà il proprio limite.

Questo valore non può essere negativo.

filter

string

Una stringa di query compatibile con lo standard AIP-160 di Google.

Utilizza uno dei seguenti campi in una query:

Questa query supporta anche i seguenti campi "virtuali". Si tratta di campi che non fanno effettivamente parte dell'oggetto risorsa restituito, ma possono essere interrogati come se fossero precompilati con valori specifici.

  • sha1_hash o sha1Hashes : questo campo è considerato un campo string ripetuto , popolato con l'elenco di tutte le impronte digitali del certificato SHA-1 registrate con AndroidApp . Questo elenco è vuoto se l'app non è AndroidApp .
  • sha256_hash o sha256Hashes : questo campo è considerato un campo string ripetuto , popolato con l'elenco di tutte le impronte digitali del certificato SHA-256 registrate con AndroidApp . Questo elenco è vuoto se l'app non è AndroidApp .
  • appStoreId : questo campo è considerato un campo string singolare , popolato con l'ID dell'App Store di Apple registrato con IosApp . Questo campo è vuoto se l'App non è una IosApp .
  • teamId : questo campo è considerato un campo string singolare , popolato con l'ID del team Apple registrato con IosApp . Questo campo è vuoto se l'App non è una IosApp .
showDeleted

boolean

Controlla se devono essere restituite le app nello stato DELETED .

Se non specificato verranno restituite solo le App ACTIVE .

Richiedi corpo

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Campi
apps[]

object ( FirebaseAppInfo )

Una pagina di risultati da una chiamata a projects.searchApps .

nextPageToken

string

Se l'elenco dei risultati è troppo grande per essere contenuto in una singola risposta, viene restituito un token.

Questo token può essere utilizzato nelle chiamate successive a projects.searchApps per trovare il gruppo successivo di app.

I token di pagina hanno vita breve e non devono essere persistenti.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

FirebaseAppInfo

Un riepilogo di alto livello di un'app.

Rappresentazione JSON
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Campi
name

string

Il nome della risorsa dell'app Firebase, nel formato:

projects/ PROJECT_ID /iosApps/ APP_ID

O

projects/ PROJECT_ID /androidApps/ APP_ID

O

projects/ PROJECT_ID /webApps/ APP_ID

displayName

string

Il nome visualizzato assegnato dall'utente dell'app Firebase.

platform

enum ( AppPlatform )

La piattaforma dell'app Firebase.

appId

string

Solo uscita. Immutabile. L'identificatore univoco globale assegnato da Firebase per la WebApp .

Questo identificatore deve essere trattato come un token opaco, poiché il formato dei dati non è specificato.

namespace

string

Solo uscita. Immutabile. L'identificatore specifico della piattaforma dell'app.

Nota: per la maggior parte dei casi d'uso, utilizzare appId , che è l'identificatore canonico e univoco a livello globale per fare riferimento a un'app.

Questa stringa deriva da un identificatore nativo per ogni piattaforma: packageName per AndroidApp , bundleId per IosApp e webId per WebApp . I suoi contenuti dovrebbero essere trattati come opachi, poiché il formato dell'identificatore nativo potrebbe cambiare con l'evoluzione delle piattaforme. Questa stringa è univoca solo all'interno di FirebaseProject e delle app associate.

apiKeyId

string

L'identificatore univoco globale assegnato da Google (UID) per la chiave API Firebase associata all'app.

Tieni presente che questo valore è l'UID della chiave API, non la keyString della chiave API. La keyString è il valore che può essere trovato nell'artefatto di configurazione dell'app ( AndroidApp | IosApp | WebApp ).

Se apiKeyId non è impostato nelle richieste per creare l'app ( AndroidApp | IosApp | WebApp ), Firebase associa automaticamente un apiKeyId all'app. Questa chiave associata automaticamente può essere una chiave valida esistente oppure, se non esiste alcuna chiave valida, ne verrà fornita una nuova.

state

enum ( State )

Solo uscita. Lo stato del ciclo di vita dell'app.

Piattaforma app

Piattaforme a cui è possibile associare un'app Firebase.

Enumerazioni
PLATFORM_UNSPECIFIED Stato sconosciuto. Viene utilizzato solo per distinguere i valori non impostati.
IOS L'app Firebase è associata a iOS.
ANDROID L'app Firebase è associata ad Android.
WEB L'app Firebase è associata al web.