REST Resource: projects

Zasób: FirebaseProject

FirebaseProject to jednostka Firebase najwyższego poziomu. Jest to kontener dla aplikacji Firebase, witryn Firebase Hosting, systemów pamięci masowej (baza danych Firebase Realtime Database, Cloud Firestore, zasobników Cloud Storage) oraz innych zasobów Firebase i Google Cloud Platform (GCP).

Tworzysz FirebaseProject , wywołując projects.addFirebase i określając istniejący Project GCP . Spowoduje to dodanie zasobów Firebase do istniejącego Project GCP.

Ponieważ FirebaseProject jest w rzeczywistości także Project GCP, FirebaseProject ma te same podstawowe identyfikatory GCP ( projectNumber i projectId ). Umożliwia to łatwą współpracę z interfejsami API Google.

Reprezentacja JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Pola
name

string

Nazwa zasobu projektu w formacie:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : ProjectNumber projektu projektu (zalecane) lub jego ProjectId .
Dowiedz się więcej o używaniu identyfikatorów projektów w standardzie Google AIP 2510 .
Należy pamiętać, że wartością PROJECT_IDENTIFIER w dowolnej treści odpowiedzi będzie ProjectId .

projectId

string

Tylko wyjście. Niezmienny. Unikalny identyfikator przypisany przez użytkownika dla projektu.

Identyfikator ten może pojawiać się w adresach URL lub nazwach niektórych zasobów Firebase powiązanych z Projektem, ale ogólnie należy go traktować jako wygodny alias umożliwiający odniesienie do Projektu.

projectNumber

string ( int64 format)

Tylko wyjście. Niezmienny. Globalnie unikalny, kanoniczny identyfikator projektu przypisany przez Google. Użyj tego identyfikatora podczas konfigurowania integracji i/lub wykonywania wywołań API do Firebase lub usług stron trzecich.

displayName

string

Przypisana przez użytkownika nazwa wyświetlana projektu.

resources

object ( DefaultResources )

Tylko wyjście. Domyślne zasoby Firebase powiązane z projektem.

state

enum ( State )

Tylko wyjście. Stan cyklu życia projektu.

annotations

map (key: string, value: string)

Zestaw adnotacji zdefiniowanych przez użytkownika dla FirebaseProject .
Dowiedz się więcej o adnotacjach w standardzie Google AIP-128 .

Te adnotacje są przeznaczone wyłącznie dla programistów i narzędzi po stronie klienta. Usługi Firebase nie zmutują tego zestawu adnotacji.

Obiekt zawierający listę par "key": value . Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

etag

string

Ta suma kontrolna jest obliczana przez serwer na podstawie wartości innych pól i może być wysyłana z żądaniami aktualizacji, aby przed kontynuowaniem upewnić się, że klient ma aktualną wartość.

Dowiedz się więcej o etag w standardzie Google AIP-154 .

Ten etag jest mocno zweryfikowany.

Domyślne zasoby

Domyślne zasoby powiązane z projektem.

Reprezentacja JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Pola
hostingSite

string

Tylko wyjście. Domyślna nazwa witryny Firebase Hosting w formacie:

PROJECT_ID

Chociaż jest to rzadkie, Twój projectId może już być używany jako nazwa istniejącej witryny Hostingowej w innym projekcie (dowiedz się więcej o tworzeniu innych niż domyślne, dodatkowych witryn ). W takich przypadkach do projectId dołączany jest łącznik, a następnie pięć znaków alfanumerycznych, aby utworzyć domyślną nazwę witryny hostingowej. Na przykład, jeśli projectId to myproject123 , domyślna nazwa witryny hostingowej może wyglądać następująco: myproject123-a5c16

realtimeDatabaseInstance

string

Tylko wyjście. Domyślna nazwa instancji Firebase Realtime Database w formacie:

PROJECT_ID

Chociaż jest to rzadkie, Twój projectId może już być używany jako nazwa istniejącej instancji bazy danych czasu rzeczywistego w innym projekcie (dowiedz się więcej o fragmentowaniu bazy danych ). W takich przypadkach do projectId dołączany jest łącznik, a następnie pięć znaków alfanumerycznych, aby utworzyć domyślną nazwę instancji bazy danych czasu rzeczywistego. Na przykład, jeśli projectId to myproject123 , domyślna nazwa instancji bazy danych może wyglądać następująco: myproject123-a5c16

storageBucket

string

Tylko wyjście. Domyślny zasobnik pamięci Cloud Storage dla Firebase w formacie:

PROJECT_ID .appspot.com

locationId

string

Tylko wyjście. Identyfikator domyślnej lokalizacji zasobu GCP projektu. Lokalizacja jest jedną z dostępnych lokalizacji zasobów GCP .

To pole jest pomijane, jeśli domyślna lokalizacja zasobu GCP nie została jeszcze ustalona. Aby ustawić domyślną lokalizację zasobów GCP projektu, wywołaj defaultLocation.finalize po dodaniu zasobów Firebase do projektu.

Państwo

Możliwe stany cyklu życia Projektu. Dowiedz się więcej o stanach w standardzie Google AIP-216 .

Wyliczenia
STATE_UNSPECIFIED Nieokreślony stan.
ACTIVE Projekt jest aktywny.
DELETED Projekt został usunięty nietrafnie.

Metody

addFirebase

Dodaje zasoby Firebase do określonego istniejącego Project Google Cloud Platform (GCP) .

addGoogleAnalytics

Łączy określony FirebaseProject z istniejącym kontem Google Analytics .

get

Pobiera określony FirebaseProject .

getAdminSdkConfig

Pobiera artefakt konfiguracji skojarzony z określonym FirebaseProject , którego mogą używać serwery w celu uproszczenia inicjalizacji.

getAnalyticsDetails

Pobiera szczegóły Google Analytics aktualnie powiązane z określonym FirebaseProject .

list

Wyświetla listę każdego FirebaseProject dostępnego dla obiektu wywołującego.

patch

Aktualizuje atrybuty określonego FirebaseProject .

removeAnalytics

Odłącza określony FirebaseProject od jego konta Google Analytics.

searchApps

Wyświetla listę wszystkich dostępnych aplikacji dla określonego FirebaseProject .