Method: projects.webApps.getConfig

Obtient l'artefact de configuration associé à la WebApp spécifiée.

Requête HTTP

GET https://firebase.googleapis.com/v1beta1/{name=projects/*/webApps/*/config}

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
name

string

Le nom de la ressource de la configuration WebApp à télécharger, au format :

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID /config


Puisqu'un APP_ID est un identifiant unique, le modèle d'accès à la ressource unique de la sous-collection peut être utilisé ici, au format :

projects/-/webApps/ APP_ID


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

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 :

Métadonnées de configuration d'une seule application Firebase pour le Web.

Représentation JSON
{
  "projectId": string,
  "appId": string,
  "databaseURL": string,
  "storageBucket": string,
  "locationId": string,
  "apiKey": string,
  "authDomain": string,
  "messagingSenderId": string,
  "measurementId": string
}
Des champs
projectId

string

Immuable. Un identifiant unique attribué par l'utilisateur pour le FirebaseProject .

appId

string

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

databaseURL

string

L'URL de la base de données en temps réel Firebase par défaut.

storageBucket

string

Nom du bucket de stockage Cloud Storage pour Firebase par défaut.

locationId

string

ID de l'emplacement des ressources GCP par défaut du projet. L'emplacement est l'un des emplacements de ressources GCP disponibles.

Ce champ est omis si l'emplacement des ressources GCP par défaut n'a pas encore été finalisé. Pour définir l'emplacement des ressources GCP par défaut d'un projet, appelez defaultLocation.finalize après avoir ajouté des ressources Firebase au projet.

apiKey

string

Le keyString de la clé API associée à la WebApp .

Notez que cette valeur n'est pas l' apiKeyId (l'UID) de la clé API associée à la WebApp .

authDomain

string

Le domaine Firebase Auth configure pour les redirections OAuth, au format :

PROJECT_ID .firebaseapp.com

messagingSenderId

string

L'ID de l'expéditeur à utiliser avec Firebase Cloud Messaging.

measurementId

string

Identifiant unique attribué par Google du flux Web Google Analytics associé à la WebApp . Les SDK Firebase utilisent cet identifiant pour interagir avec les API Google Analytics.

Ce champ n'est présent que si la WebApp est liée à un flux Web dans une propriété Application + Web Google Analytics. Apprenez-en plus sur cet identifiant et les flux Web Google Analytics dans la documentation Analytics .

Pour générer un measurementId et lier la WebApp à un flux Web Google Analytics, projects.addGoogleAnalytics .

Pour les applications utilisant le SDK JavaScript Firebase v7.20.0 et versions ultérieures, Firebase récupère dynamiquement l' measurementId lorsque votre application initialise Analytics. Avoir cet ID dans votre objet de configuration est facultatif, mais il sert de solution de secours dans les rares cas où la récupération dynamique échoue.

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 .