REST Resource: projects

리소스: FirebaseProject

FirebaseProject는 최상위 Firebase 항목입니다. Firebase 앱, Firebase 호스팅 사이트, 저장소 시스템 (Firebase 실시간 데이터베이스, Cloud Firestore, Cloud Storage 버킷), 기타 Firebase 및 Google Cloud Platform (GCP) 리소스를 위한 컨테이너입니다.

projects.addFirebase를 호출하고 기존 GCP Project를 지정하여 FirebaseProject를 만듭니다. 이렇게 하면 Firebase 리소스가 기존 GCP Project에 추가됩니다.

FirebaseProject는 실제로 GCP Project이기도 하므로 FirebaseProject에는 동일한 기본 GCP 식별자 (projectNumberprojectId)가 있습니다. 따라서 Google API와 쉽게 상호 운용할 수 있습니다.

JSON 표현
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
필드
name

string

프로젝트의 리소스 이름으로서 형식은 다음과 같습니다.

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER: 프로젝트의 ProjectNumber (권장) 또는 ProjectId입니다.
Google의 AIP 2510 표준에서 프로젝트 식별자를 사용하는 방법을 자세히 알아보세요.
모든 응답 본문의 PROJECT_IDENTIFIER 값은 ProjectId입니다.

projectId

string

출력 전용입니다. 변경할 수 없습니다. 사용자가 할당한 프로젝트의 고유 식별자입니다.

이 식별자는 프로젝트와 관련된 일부 Firebase 리소스의 URL 또는 이름에 나타날 수 있지만, 일반적으로 프로젝트를 참조하기 위한 편의성 별칭으로 취급됩니다.

projectNumber

string (int64 format)

출력 전용입니다. 변경할 수 없습니다. 전역적으로 고유하며 Google에서 할당한 프로젝트의 표준 식별자입니다. 통합을 구성하거나 Firebase 또는 서드 파티 서비스에 대한 API를 호출할 때 이 식별자를 사용합니다.

displayName

string

사용자가 지정한 프로젝트의 표시 이름입니다.

resources

object (DefaultResources)

출력 전용입니다. 프로젝트와 관련된 기본 Firebase 리소스입니다.

state

enum (State)

출력 전용입니다. 프로젝트의 수명 주기 상태입니다.

annotations

map (key: string, value: string)

FirebaseProject의 사용자 정의 주석 집합입니다.
Google AIP-128 표준의 주석에 관해 자세히 알아보세요.

이러한 주석은 개발자 및 클라이언트 측 도구만을 위한 것입니다. Firebase 서비스는 이 주석 세트를 변경하지 않습니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

etag

string

이 체크섬은 서버에서 다른 필드의 값을 기반으로 계산하며, 계속하기 전에 클라이언트에 최신 값이 있는지 확인하기 위해 업데이트 요청과 함께 전송될 수 있습니다.

Google의 AIP-154 표준에서 etag에 관해 자세히 알아보세요.

이 etag는 엄격하게 검증되었습니다.

DefaultResources

프로젝트와 연결된 기본 리소스입니다.

JSON 표현
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
필드
hostingSite

string

출력 전용입니다. 기본 Firebase 호스팅 사이트 이름으로, 형식은 다음과 같습니다.

PROJECT_ID

드물지만 projectId이 이미 다른 프로젝트의 기존 호스팅 사이트의 이름으로 사용되었을 수 있습니다 (기본이 아닌 추가 사이트 만들기에 대해 자세히 알아보기). 이 경우 projectId에 하이픈과 5개의 영숫자 문자가 추가되어 기본 호스팅 사이트 이름이 생성됩니다. 예를 들어 projectIdmyproject123인 경우 기본 호스팅 사이트 이름은 myproject123-a5c16일 수 있습니다.

realtimeDatabaseInstance

string

출력 전용입니다. 기본 Firebase 실시간 데이터베이스 인스턴스 이름으로, 형식은 다음과 같습니다.

PROJECT_ID

드물긴 하지만 projectId이 다른 프로젝트의 기존 실시간 데이터베이스 인스턴스 이름으로 이미 사용 중일 수 있습니다 (데이터베이스 샤딩 자세히 알아보기). 이 경우 projectId에 하이픈과 5개의 영숫자 문자가 추가되어 기본 실시간 데이터베이스 인스턴스 이름이 생성됩니다. 예를 들어 projectIdmyproject123이면 기본 데이터베이스 인스턴스 이름은 myproject123-a5c16일 수 있습니다.

storageBucket

string

출력 전용입니다. Firebase 저장소 버킷용 기본 Cloud Storage로서 형식은 다음과 같습니다.

PROJECT_ID.appspot.com

locationId

string

출력 전용입니다. 프로젝트의 기본 GCP 리소스 위치 ID입니다. 위치는 사용 가능한 GCP 리소스 위치 중 하나입니다.

기본 GCP 리소스 위치가 아직 확정되지 않은 경우 이 필드가 생략됩니다. 프로젝트의 기본 GCP 리소스 위치를 설정하려면 프로젝트에 Firebase 리소스를 추가한 후 defaultLocation.finalize를 호출합니다.

프로젝트의 가능한 수명 주기 상태 Google의 AIP-216 표준에서 상태에 관해 자세히 알아보세요.

열거형
STATE_UNSPECIFIED 지정되지 않은 상태.
ACTIVE 프로젝트가 활성 상태입니다.
DELETED 프로젝트가 소프트 삭제되었습니다.

메소드

addFirebase

Firebase 리소스를 지정된 기존 GCP (Google Cloud Platform) Project에 추가합니다.

addGoogleAnalytics

지정된 FirebaseProject를 기존 Google 애널리틱스 계정과 연결합니다.

get

지정된 FirebaseProject를 가져옵니다.

getAdminSdkConfig

지정된 FirebaseProject와 연결된 구성 아티팩트를 가져옵니다. 이는 서버에서 초기화를 간소화하는 데 사용할 수 있습니다.

getAnalyticsDetails

현재 지정된 FirebaseProject와 연결된 Google 애널리틱스 세부정보를 가져옵니다.

list

호출자가 액세스할 수 있는 각 FirebaseProject를 나열합니다.

patch

지정된 FirebaseProject의 속성을 업데이트합니다.

removeAnalytics

Google 애널리틱스 계정에서 지정된 FirebaseProject의 연결을 해제합니다.

searchApps

지정된 FirebaseProject에 사용 가능한 모든 앱을 나열합니다.