Method: availableProjects.list

Listet jedes Google Cloud Platform (GCP) Project auf, dem Firebase-Ressourcen hinzugefügt werden können.

Ein Projekt wird nur aufgeführt, wenn:

  • Der Aufrufer verfügt über ausreichende Google IAM- Berechtigungen, um projects.addFirebase aufzurufen.
  • Das Projekt ist noch kein FirebaseProject .
  • Das Projekt befindet sich nicht in einer Organisation, die über Richtlinien verfügt, die das Hinzufügen von Firebase-Ressourcen verhindern.

HTTP-Anfrage

GET https://firebase.googleapis.com/v1beta1/availableProjects

Die URL verwendet die gRPC-Transcoding -Syntax.

Abfrageparameter

Parameter
pageToken

string

Von einem vorherigen Aufruf von availableProjects.list zurückgegebenes Token, das angibt, an welcher Stelle im Projektsatz die Auflistung fortgesetzt werden soll.

pageSize

integer

Die maximale Anzahl von Projekten, die in der Antwort zurückgegeben werden sollen.

Der Server kann nach eigenem Ermessen weniger als diesen Wert zurückgeben. Wenn kein Wert angegeben wird (oder ein zu großer Wert angegeben wird), legt der Server sein eigenes Limit fest.

Dieser Wert darf nicht negativ sein.

Anforderungstext

Der Anfragetext muss leer sein.

Antwortkörper

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

JSON-Darstellung
{
  "projectInfo": [
    {
      object (ProjectInfo)
    }
  ],
  "nextPageToken": string
}
Felder
projectInfo[]

object ( ProjectInfo )

Die Liste der GCP- Projects , denen Firebase-Ressourcen hinzugefügt werden können.

nextPageToken

string

Wenn die Ergebnisliste zu groß ist, um in eine einzelne Antwort zu passen, wird ein Token zurückgegeben. Wenn die Zeichenfolge leer ist, handelt es sich bei dieser Antwort um die letzte Ergebnisseite.

Dieses Token kann in nachfolgenden Aufrufen von availableProjects.list verwendet werden, um die nächste Gruppe von Projekten zu finden.

Seitentokens sind von kurzer Dauer und sollten nicht beibehalten werden.

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 .

ProjektInfo

Ein Verweis auf ein Google Cloud Platform (GCP) Project .

JSON-Darstellung
{
  "project": string,
  "displayName": string,
  "locationId": string
}
Felder
project

string

Der Ressourcenname des GCP- Project , zu dem Firebase-Ressourcen hinzugefügt werden können, im Format:

projects/ PROJECT_IDENTIFIER

Einzelheiten zu PROJECT_IDENTIFIER Werten finden Sie im name FirebaseProject .

displayName

string

Der vom Benutzer zugewiesene Anzeigename des GCP- Project , zum Beispiel: My App

locationId

string

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

Dieses Feld ist nicht bei allen Projekten ausgefüllt. Wenn es nicht ausgefüllt ist, bedeutet dies, dass das Projekt noch keinen Standard-GCP-Ressourcenstandort hat. Um den standardmäßigen GCP-Ressourcenspeicherort eines Projekts festzulegen, rufen Sie defaultLocation.finalize auf, nachdem Sie Firebase-Ressourcen zum Projekt hinzugefügt haben.