REST Resource: projects

Zasób: FirebaseProject

Element FirebaseProject to element Firebase najwyższego poziomu. Jest to kontener dla aplikacji Firebase, witryn Hostingu Firebase, systemów pamięci (Baza danych czasu rzeczywistego Firebase, Cloud Firestore, zasobników Cloud Storage) oraz innych zasobów Firebase i Google Cloud Platform (GCP).

Aby utworzyć FirebaseProject, wywołaj funkcję projects.addFirebase i wskaż istniejący GCP Project. Zasoby Firebase zostaną dodane do istniejącego Project GCP.

FirebaseProject to w rzeczywistości również element Project GCP, więc FirebaseProject ma te same podstawowe identyfikatory GCP (projectNumber i projectId). Ułatwia to współpracę z interfejsami API Google.

Zapis 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 (zalecane) lub ProjectId projektu.
Więcej informacji o korzystaniu z identyfikatorów projektów znajdziesz w standardzie AIP 2510 Google.
Pamiętaj, że wartością PROJECT_IDENTIFIER w każdej treści odpowiedzi jest ProjectId.
projectId

string

Tylko dane wyjściowe. Stały. Przypisany przez użytkownika unikalny identyfikator projektu.

Ten identyfikator może się pojawiać w adresach URL lub nazwach niektórych zasobów Firebase powiązanych z projektem, ale zwykle powinien być traktowany jako wygodny alias odwołujący się do projektu.
projectNumber

string (int64 format)

Tylko dane wyjściowe. Stały. Unikalny globalnie kanoniczny identyfikator projektu przypisany przez Google. Użyj tego identyfikatora podczas konfigurowania integracji lub wywoływania interfejsu API Firebase albo usług innych firm.
displayName

string

Wyświetlana nazwa projektu przypisana przez użytkownika.
resources

object (DefaultResources)

Tylko dane wyjściowe. Domyślne zasoby Firebase powiązane z projektem.
state

enum (State)

Tylko dane wyjściowe. Stan cyklu życia projektu.
annotations

map (key: string, value: string)

Zestaw adnotacji zdefiniowanych przez użytkownika dla zasobu FirebaseProject.
Więcej informacji o adnotacjach znajdziesz w standardzie AIP-128 Google.

Są one przeznaczone wyłącznie dla programistów i narzędzi po stronie klienta. Usługi Firebase nie będą wprowadzać mutacji do 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 razem z żądaniami aktualizacji w celu zadbania o to, aby dane klienta były aktualne, zanim przejdziesz dalej.

Więcej informacji o usłudze etag znajdziesz w normie Google AIP-154.

Ten parametr jest silnie zweryfikowany.

Zasoby domyślne

Domyślne zasoby powiązane z projektem.

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

string

Tylko dane wyjściowe. Domyślna nazwa witryny Hostingu Firebase w formacie:

PROJECT_ID

Choć Twoja domena projectId jest już rzadko używana, może już być używana jako nazwa istniejącej witryny Hostingu w innym projekcie (dowiedz się więcej o tworzeniu dodatkowych witryn innych niż domyślne). W takich przypadkach do projectId jest dodawany łącznik, a następnie 5 znaków alfanumerycznych, które tworzą domyślną nazwę witryny Hostingu. Jeśli na przykład projectId to myproject123, domyślna nazwa witryny Hostingu może wyglądać tak: myproject123-a5c16
realtimeDatabaseInstance

string

Tylko dane wyjściowe. Domyślna nazwa instancji Bazy danych czasu rzeczywistego Firebase w formacie:

PROJECT_ID

Chociaż zdarza się to rzadko, Twoja nazwa projectId może już być używana jako nazwa istniejącej instancji Bazy danych czasu rzeczywistego w innym projekcie (dowiedz się więcej o fragmentowaniu baz danych). W takich przypadkach do projectId jest dodawany łącznik, a następnie pięć znaków alfanumerycznych, które tworzą domyślną nazwę instancji Bazy danych czasu rzeczywistego. Jeśli na przykład projectId to myproject123, domyślna nazwa instancji bazy danych może wyglądać tak: myproject123-a5c16
storageBucket

string

Tylko dane wyjściowe. Domyślny zasobnik na dane Cloud Storage dla Firebase w formacie:

PROJECT_ID.appspot.com
locationId

string

Tylko dane wyjściowe. Identyfikator domyślnej lokalizacji zasobu GCP projektu. Lokalizacja to jedna z dostępnych lokalizacji zasobów GCP.

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

Stan

Możliwe stany cyklu życia projektu. Więcej informacji o stanach znajdziesz w normie Google AIP-216.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony.
ACTIVE Projekt jest aktywny.
DELETED Projekt został przeniesiony do kosza.

Metody

addFirebase

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

addGoogleAnalytics

 Łączy konto FirebaseProject z istniejącym kontem Google Analytics.

get

 Pobiera określoną wartość FirebaseProject.

getAdminSdkConfig

 Pobiera artefakt konfiguracji powiązany z podanym identyfikatorem FirebaseProject, którego serwery mogą używać do uproszczenia inicjowania.

getAnalyticsDetails

 Pobiera dane Google Analytics aktualnie powiązane z konkretnym identyfikatorem FirebaseProject.

list

 Wyświetla listę wszystkich elementów FirebaseProject dostępnych dla wywołującego.

patch

 Aktualizuje atrybuty określonego elementu FirebaseProject.

removeAnalytics

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

searchApps

 Wyświetla listę wszystkich aplikacji dostępnych w przypadku określonego zasobu (FirebaseProject).