REST Resource: projects

Tài nguyên: FirebaseProject

FirebaseProject là thực thể cấp cao nhất trong Firebase. Đây là vùng chứa cho các ứng dụng Firebase, trang web Lưu trữ Firebase, hệ thống lưu trữ (Cơ sở dữ liệu theo thời gian thực của Firebase, Cloud Firestore, bộ chứa Cloud Storage) và các tài nguyên khác của Firebase và Google Cloud Platform (GCP).

Bạn tạo FirebaseProject bằng cách gọi projects.addFirebase và chỉ định một GCP Project hiện có. Thao tác này sẽ thêm các tài nguyên Firebase vào Project GCP hiện có.

FirebaseProject thực ra cũng là Project GCP, nên FirebaseProject có cùng các giá trị nhận dạng GCP cơ bản (projectNumberprojectId). Điều này cho phép dễ dàng tương tác với các API của Google.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Trường
name

string

Tên tài nguyên của Dự án, ở định dạng:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER: ProjectNumber (nên dùng) của Dự án hoặc ProjectId của Dự án.
Tìm hiểu thêm về cách sử dụng mã nhận dạng dự án theo tiêu chuẩn API 2510 của Google.
Lưu ý rằng giá trị của PROJECT_IDENTIFIER trong mọi nội dung phản hồi sẽ là ProjectId.

projectId

string

Chỉ có đầu ra. Bất biến. Giá trị nhận dạng riêng biệt do người dùng chỉ định cho Dự án.

Giá trị nhận dạng này có thể xuất hiện trong URL hoặc tên của một số tài nguyên Firebase được liên kết với Dự án, nhưng thường phải được coi là một bí danh tiện lợi để tham chiếu đến Dự án.

projectNumber

string (int64 format)

Chỉ có đầu ra. Bất biến. Giá trị nhận dạng chuẩn duy nhất trên toàn cầu do Google chỉ định cho Dự án. Sử dụng giá trị nhận dạng này khi định cấu hình chế độ tích hợp và/hoặc thực hiện lệnh gọi API đến Firebase hoặc các dịch vụ của bên thứ ba.

displayName

string

Tên hiển thị của Dự án do người dùng chỉ định.

resources

object (DefaultResources)

Chỉ có đầu ra. Các tài nguyên mặc định của Firebase được liên kết với Dự án.

state

enum (State)

Chỉ có đầu ra. Trạng thái vòng đời của Dự án.

annotations

map (key: string, value: string)

Một tập hợp các chú giải do người dùng xác định cho FirebaseProject.
Tìm hiểu thêm về chú thích theo tiêu chuẩn AIP-128 của Google.

Những chú thích này chỉ dành cho nhà phát triển và các công cụ phía máy khách. Các dịch vụ của Firebase sẽ không làm thay đổi tập hợp chú thích này.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

Giá trị tổng kiểm này do máy chủ tính toán dựa trên giá trị của các trường khác và có thể được gửi cùng với yêu cầu cập nhật để đảm bảo máy khách có giá trị đã cập nhật trước khi tiếp tục.

Tìm hiểu thêm về etag theo tiêu chuẩn AIP-154 của Google.

Etag này được xác thực chặt chẽ.

Tài nguyên mặc định

Các tài nguyên mặc định liên kết với Dự án.

Biểu diễn dưới dạng JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Trường
hostingSite

string

Chỉ có đầu ra. Tên trang web Lưu trữ Firebase mặc định, theo định dạng:

PROJECT_ID

Mặc dù hiếm, nhưng projectId của bạn có thể đã được dùng làm tên cho một trang web Lưu trữ hiện có trong một dự án khác (tìm hiểu thêm về cách tạo các trang web bổ sung, không mặc định). Trong những trường hợp này, projectId được thêm bằng một dấu gạch nối, rồi đến năm ký tự bao gồm chữ và số để tạo tên trang web Lưu trữ mặc định của bạn. Ví dụ: nếu projectId của bạn là myproject123, thì tên trang web Lưu trữ mặc định của bạn có thể là: myproject123-a5c16

realtimeDatabaseInstance

string

Chỉ có đầu ra. Tên phiên bản Cơ sở dữ liệu theo thời gian thực mặc định của Firebase, ở định dạng:

PROJECT_ID

Mặc dù hiếm khi xảy ra, nhưng projectId của bạn có thể đã được dùng làm tên cho một thực thể hiện có của Cơ sở dữ liệu theo thời gian thực trong một dự án khác (tìm hiểu thêm về việc phân đoạn cơ sở dữ liệu). Trong những trường hợp này, projectId sẽ được thêm dấu gạch nối, sau đó là năm ký tự chữ-số để tạo tên phiên bản Cơ sở dữ liệu theo thời gian thực mặc định. Ví dụ: nếu projectId của bạn là myproject123, tên thực thể cơ sở dữ liệu mặc định có thể là: myproject123-a5c16

storageBucket

string

Chỉ có đầu ra. Bộ chứa lưu trữ mặc định của Cloud Storage cho Firebase, có định dạng:

PROJECT_ID.appspot.com

locationId

string

Chỉ có đầu ra. Mã vị trí tài nguyên GCP mặc định của Dự án. Vị trí này là một trong các vị trí tài nguyên GCP hiện có.

Trường này sẽ bị bỏ qua nếu vị trí tài nguyên GCP mặc định chưa được hoàn tất. Để đặt vị trí tài nguyên GCP mặc định của một Dự án, hãy gọi defaultLocation.finalize sau khi bạn thêm tài nguyên Firebase vào Dự án.

Tiểu bang

Các trạng thái vòng đời có thể có của Dự án. Tìm hiểu thêm về các trạng thái trong tiêu chuẩn AIP-216 của Google.

Enum
STATE_UNSPECIFIED Trạng thái không xác định.
ACTIVE Dự án đang hoạt động.
DELETED Dự án đã bị xoá tạm thời.

Phương thức

addFirebase

Thêm các tài nguyên của Firebase vào Google Cloud Platform (GCP) Project hiện có.

addGoogleAnalytics

Liên kết FirebaseProject được chỉ định với một tài khoản Google Analytics hiện có.

get

Lấy FirebaseProject được chỉ định.

getAdminSdkConfig

Lấy cấu phần phần mềm cấu hình liên kết với FirebaseProject đã chỉ định. Máy chủ có thể sử dụng cấu phần phần mềm này để đơn giản hoá quá trình khởi chạy.

getAnalyticsDetails

Lấy thông tin chi tiết về Google Analytics hiện được liên kết với FirebaseProject được chỉ định.

list

Liệt kê từng FirebaseProject mà phương thức gọi có thể truy cập.

patch

Cập nhật các thuộc tính của FirebaseProject được chỉ định.

removeAnalytics

Huỷ liên kết FirebaseProject được chỉ định khỏi tài khoản Google Analytics của nó.

searchApps

Liệt kê mọi ứng dụng có sẵn cho FirebaseProject đã chỉ định.