REST Resource: projects

Tài nguyên: Dự án Firebase

FirebaseProject là thực thể Firebase cấp cao nhất. Nó là nơi chứa Ứng dụng Firebase, trang web Lưu trữ Firebase, hệ thống lưu trữ (Cơ sở dữ liệu thời gian thực Firebase, Cloud Firestore, nhóm Lưu trữ đám mây) và các tài nguyên Firebase và Google Cloud Platform (GCP) khác.

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

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

Biểu diễn JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Lĩnh vực
name

string

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

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : ProjectNumber của Dự án (được khuyến nghị) hoặc ProjectId của Dự án.
Tìm hiểu thêm về cách sử dụng số nhận dạng dự án trong tiêu chuẩn AIP 2510 của Google.
Lưu ý rằng giá trị của PROJECT_IDENTIFIER trong bất kỳ nội dung phản hồi nào sẽ là ProjectId .

projectId

string

Chỉ đầu ra. Bất biến. Mã định danh duy nhất do người dùng chỉ định cho Dự án.

Mã 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 nhìn chung nó phải được coi là bí danh thuận tiện để tham chiếu Dự án.

projectNumber

string ( int64 format)

Chỉ đầ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 mã nhận dạng này khi định cấu hình tích hợp và/hoặc thực hiện lệnh gọi API tới Firebase hoặc các dịch vụ của bên thứ ba.

displayName

string

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

resources

object ( DefaultResources )

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

state

enum ( State )

Chỉ đầ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ú thích do người dùng xác định cho FirebaseProject .
Tìm hiểu thêm về chú thích trong 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ông cụ phía khách hàng. Dịch vụ Firebase sẽ không thay đổi bộ 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

Tổng kiểm tra này được máy chủ tính toán dựa trên giá trị của các trường khác và nó có thể được gửi cùng với các 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 trong tiêu chuẩn AIP-154 của Google .

Etag này được xác nhận mạnh mẽ.

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

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

Biểu diễn JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Lĩnh vực
hostingSite

string

Chỉ đầu ra. Tên trang web Firebase Hosting mặc định, ở định dạng:

PROJECT_ID

Mặc dù hiếm gặp nhưng projectId của bạn có thể đã được sử 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ủa bạn được thêm một dấu gạch nối rồi đến năm ký tự 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ỉ đầu ra. Tên phiên bản Cơ sở dữ liệu thời gian thực Firebase mặc định, ở định dạng:

PROJECT_ID

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

storageBucket

string

Chỉ đầu ra. Bộ lưu trữ đám mây mặc định cho Firebase, ở định dạng:

PROJECT_ID .appspot.com

locationId

string

Chỉ đầu ra. ID của vị trí tài nguyên GCP mặc định của Dự án. Vị trí này là một trong những vị trí tài nguyên GCP có sẵn .

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

Tình trạng

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ị xóa mềm.

phương pháp

addFirebase

Thêm tài nguyên Firebase vào Project Google Cloud Platform (GCP) hiện có được chỉ định.

addGoogleAnalytics

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

get

Nhận FirebaseProject được chỉ định.

getAdminSdkConfig

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

getAnalyticsDetails

Nhận 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à người gọi có thể truy cập.

patch

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

removeAnalytics

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

searchApps

Liệt kê tất cả Ứng dụng có sẵn cho FirebaseProject được chỉ định.