Method: projects.webApps.getConfig

Ruft das Konfigurationsartefakt ab, das der angegebenen WebApp zugeordnet ist.

HTTP-Anfrage

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

Die URL verwendet die gRPC-Transcoding -Syntax.

Pfadparameter

Parameter
name

string

Der Ressourcenname der herunterzuladenden WebApp Konfiguration im Format:

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID /config


Da es sich bei einer APP_ID um eine eindeutige Kennung handelt, kann hier das Zugriffsmuster „Unique Resource from Sub-Collection“ im folgenden Format verwendet werden:

projects/-/webApps/ APP_ID


Einzelheiten zu den Werten PROJECT_IDENTIFIER und APP_ID finden Sie im Feld WebApp name .

Anforderungstext

Der Anfragetext muss leer sein.

Antwortkörper

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Konfigurationsmetadaten einer einzelnen Firebase-App für das Web.

JSON-Darstellung
{
  "projectId": string,
  "appId": string,
  "databaseURL": string,
  "storageBucket": string,
  "locationId": string,
  "apiKey": string,
  "authDomain": string,
  "messagingSenderId": string,
  "measurementId": string
}
Felder
projectId

string

Unveränderlich. Eine vom Benutzer zugewiesene eindeutige Kennung für das FirebaseProject .

appId

string

Unveränderlich. Der weltweit eindeutige, von Firebase zugewiesene Bezeichner für die WebApp .

databaseURL

string

Die Standard-URL der Firebase-Echtzeitdatenbank.

storageBucket

string

Der Standardname des Cloud Storage für Firebase-Speicher-Buckets.

locationId

string

Die ID des standardmäßigen GCP-Ressourcenstandorts des Projekts. Der Standort ist einer der verfügbaren GCP-Ressourcenstandorte .

Dieses Feld wird weggelassen, wenn der standardmäßige GCP-Ressourcenstandort noch nicht festgelegt wurde. Um den standardmäßigen GCP-Ressourcenspeicherort eines Projekts festzulegen, rufen Sie defaultLocation.finalize auf, nachdem Sie Firebase-Ressourcen zum Projekt hinzugefügt haben.

apiKey

string

Der keyString des API-Schlüssels, der der WebApp zugeordnet ist.

Beachten Sie, dass dieser Wert nicht die apiKeyId (die UID) des API-Schlüssels ist, der der WebApp zugeordnet ist.

authDomain

string

Die Domäne Firebase Auth konfiguriert für OAuth-Weiterleitungen im Format:

PROJECT_ID .firebaseapp.com

messagingSenderId

string

Die Absender-ID zur Verwendung mit Firebase Cloud Messaging.

measurementId

string

Die eindeutige, von Google zugewiesene Kennung des mit der WebApp verknüpften Google Analytics-Webstreams. Firebase-SDKs verwenden diese ID, um mit Google Analytics-APIs zu interagieren.

Dieses Feld ist nur vorhanden, wenn die WebApp mit einem Webstream in einer Google Analytics App + Web-Property verknüpft ist. Weitere Informationen zu dieser ID und Google Analytics-Webstreams finden Sie in der Analytics-Dokumentation .

Rufen Sie projects.addGoogleAnalytics auf, um eine measurementId zu generieren und die WebApp mit einem Google Analytics-Webstream zu verknüpfen.

Bei Apps, die das Firebase JavaScript SDK v7.20.0 und höher verwenden, ruft Firebase die measurementId dynamisch ab, wenn Ihre App Analytics initialisiert. Die Angabe dieser ID in Ihrem Konfigurationsobjekt ist optional, dient jedoch als Ausweichlösung für den seltenen Fall, dass der dynamische Abruf fehlschlägt.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie in der Authentifizierungsübersicht .