Method: projects.searchApps

Répertorie toutes les applications disponibles pour le FirebaseProject spécifié.

Il s'agit d'une méthode pratique. En règle générale, l'interaction avec une application doit être effectuée à l'aide du service spécifique à la plate-forme, mais certains cas d'utilisation d'outils nécessitent un résumé de toutes les applications connues (comme pour les interfaces de sélection d'applications).

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
parent

string

Le FirebaseProject parent pour lequel répertorier les applications, au format :

projects/ PROJECT_IDENTIFIER

Reportez-vous au champ name FirebaseProject pour plus de détails sur les valeurs PROJECT_IDENTIFIER .

Paramètres de requête

Paramètres
pageToken

string

Jeton renvoyé lors d'un appel précédent projects.searchApps indiquant où dans l'ensemble des applications il faut reprendre la liste.

pageSize

integer

Nombre maximum d'applications à renvoyer dans la réponse.

Le serveur peut renvoyer une valeur inférieure à cette valeur à sa discrétion. Si aucune valeur n'est spécifiée (ou si une valeur trop grande est spécifiée), alors le serveur imposera sa propre limite.

Cette valeur ne peut pas être négative.

filter

string

Une chaîne de requête compatible avec la norme AIP-160 de Google.

Utilisez l'un des champs suivants dans une requête :

Cette requête prend également en charge les champs « virtuels » suivants. Ce sont des champs qui ne font pas réellement partie de l'objet ressource renvoyé, mais ils peuvent être interrogés comme s'ils étaient pré-remplis avec des valeurs spécifiques.

  • sha1_hash ou sha1Hashes : ce champ est considéré comme un champ string répété , rempli avec la liste de toutes les empreintes digitales de certificat SHA-1 enregistrées avec AndroidApp . Cette liste est vide si l'application n'est pas une AndroidApp .
  • sha256_hash ou sha256Hashes : ce champ est considéré comme un champ string répété , rempli avec la liste de toutes les empreintes digitales de certificat SHA-256 enregistrées avec AndroidApp . Cette liste est vide si l'application n'est pas une AndroidApp .
  • appStoreId : ce champ est considéré comme un champ string singulier , renseigné avec l'identifiant Apple App Store enregistré auprès de l' IosApp . Ce champ est vide si l'application n'est pas une IosApp .
  • teamId : ce champ est considéré comme un champ string singulier , renseigné avec l'identifiant de l'équipe Apple enregistré auprès de l' IosApp . Ce champ est vide si l'application n'est pas une IosApp .
showDeleted

boolean

Contrôle si les applications à l'état DELETED doivent être renvoyées.

Si cela n’est pas spécifié, seules les applications ACTIVE seront renvoyées.

Corps de la demande

Le corps de la requête doit être vide.

Corps de réponse

En cas de succès, le corps de la réponse contient des données avec la structure suivante :

Représentation JSON
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Des champs
apps[]

object ( FirebaseAppInfo )

Une page de résultats d'un appel projects.searchApps .

nextPageToken

string

Si la liste de résultats est trop longue pour tenir dans une seule réponse, un jeton est renvoyé.

Ce jeton peut être utilisé lors d'appels ultérieurs à projects.searchApps pour rechercher le groupe d'applications suivant.

Les jetons de page sont de courte durée et ne doivent pas être conservés.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

  • 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

Pour plus d'informations, consultez la Présentation de l'authentification .

FirebaseAppInfo

Un résumé de haut niveau d’une application.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Des champs
name

string

Le nom de la ressource de l'application Firebase, au format :

projects/ PROJECT_ID /iosApps/ APP_ID

ou

projects/ PROJECT_ID /androidApps/ APP_ID

ou

projects/ PROJECT_ID /webApps/ APP_ID

displayName

string

Le nom d'affichage attribué par l'utilisateur de l'application Firebase.

platform

enum ( AppPlatform )

La plateforme de l'application Firebase.

appId

string

Sortie uniquement. Immuable. Identifiant unique au monde, attribué par Firebase pour la WebApp .

Cet identifiant doit être traité comme un jeton opaque, car le format des données n'est pas spécifié.

namespace

string

Sortie uniquement. Immuable. L'identifiant spécifique à la plate-forme de l'application.

Remarque : Pour la plupart des cas d'utilisation, utilisez appId , qui est l'identifiant canonique et unique au monde pour référencer une application.

Cette chaîne est dérivée d'un identifiant natif pour chaque plateforme : packageName pour une AndroidApp , bundleId pour une IosApp et webId pour une WebApp . Son contenu doit être traité comme opaque, car le format d’identifiant natif peut changer à mesure que les plateformes évoluent. Cette chaîne est unique uniquement au sein d'un FirebaseProject et de ses applications associées.

apiKeyId

string

L'identifiant (UID) attribué par Google, unique au monde, pour la clé API Firebase associée à l'application.

Sachez que cette valeur est l'UID de la clé API, et non la keyString de la clé API. La keyString est la valeur qui peut être trouvée dans l'artefact de configuration de l'application ( AndroidApp | IosApp | WebApp ).

Si apiKeyId n'est pas défini dans les demandes de création de l'application ( AndroidApp | IosApp | WebApp ), Firebase associe automatiquement un apiKeyId à l'application. Cette clé auto-associée peut être une clé valide existante ou, si aucune clé valide n'existe, une nouvelle sera fournie.

state

enum ( State )

Sortie uniquement. L'état du cycle de vie de l'application.

Plateforme d'application

Plateformes auxquelles une application Firebase peut être associée.

Énumérations
PLATFORM_UNSPECIFIED Etat inconnu. Ceci n'est utilisé que pour distinguer les valeurs non définies.
IOS L'application Firebase est associée à iOS.
ANDROID L'application Firebase est associée à Android.
WEB L'application Firebase est associée au Web.