REST Resource: projects

แหล่งข้อมูล: FirebaseProject

FirebaseProject เป็นเอนทิตี Firebase ระดับบนสุด ซึ่งเป็นคอนเทนเนอร์สำหรับแอป Firebase, เว็บไซต์โฮสติ้งของ Firebase, ระบบพื้นที่เก็บข้อมูล (ฐานข้อมูลเรียลไทม์ของ Firebase, Cloud Firestore, ที่เก็บข้อมูล Cloud Storage) และทรัพยากรอื่นๆ ของ Firebase และ Google Cloud Platform (GCP)

คุณสร้าง FirebaseProject โดยการเรียกใช้ projects.addFirebase และระบุ GCP Project ที่มีอยู่ การดำเนินการนี้จะเพิ่มทรัพยากร Firebase ไปยัง Project ของ GCP ที่มีอยู่

เนื่องจาก FirebaseProject เป็น GCP Project จริงๆ FirebaseProject จึงมีตัวระบุ GCP เบื้องหลังเหมือนกัน (projectNumber และ projectId) ซึ่งทำให้สามารถทำงานร่วมกับ Google APIs ได้ง่าย

การแสดง 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 ของโปรเจ็กต์
ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้ตัวระบุโปรเจ็กต์ในมาตรฐาน AIP 2510 ของ Google
โปรดทราบว่าค่าของ PROJECT_IDENTIFIER ในเนื้อหาการตอบกลับจะเป็น ProjectId
projectId

string

เอาต์พุตเท่านั้น เปลี่ยนแปลงไม่ได้ ตัวระบุที่ไม่ซ้ำกันที่ผู้ใช้กำหนดสำหรับโปรเจ็กต์

ตัวระบุนี้อาจปรากฏใน URL หรือชื่อของทรัพยากร Firebase บางรายการที่เชื่อมโยงกับโปรเจ็กต์ แต่โดยทั่วไปตัวระบุนี้ควรถือเป็นชื่อเรียกที่สะดวกสำหรับใช้อ้างอิงโปรเจ็กต์
projectNumber

string (int64 format)

เอาต์พุตเท่านั้น เปลี่ยนแปลงไม่ได้ ตัวระบุ Canonical ที่ไม่ซ้ำกันทั่วโลกซึ่ง Google กำหนดให้สำหรับโปรเจ็กต์ ใช้ตัวระบุนี้เมื่อกำหนดค่าการผสานรวมและ/หรือเรียก API ไปยัง Firebase หรือบริการของบุคคลที่สาม
displayName

string

ชื่อที่แสดงที่ผู้ใช้กำหนดของโปรเจ็กต์
resources

object (DefaultResources)

เอาต์พุตเท่านั้น ทรัพยากร Firebase เริ่มต้นที่เชื่อมโยงกับโปรเจ็กต์
state

enum (State)

เอาต์พุตเท่านั้น สถานะวงจรของโปรเจ็กต์
annotations

map (key: string, value: string)

ชุดคำอธิบายประกอบที่ผู้ใช้กำหนดสำหรับ FirebaseProject
ดูข้อมูลเพิ่มเติมเกี่ยวกับคำอธิบายประกอบในมาตรฐาน AIP-128 ของ Google

คำอธิบายประกอบเหล่านี้มีไว้สำหรับนักพัฒนาซอฟต์แวร์และเครื่องมือฝั่งไคลเอ็นต์เท่านั้น บริการ Firebase จะไม่เปลี่ยนแปลงชุดคำอธิบายประกอบนี้

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
etag

string

เซิร์ฟเวอร์จะคำนวณการตรวจสอบข้อผิดพลาดดังกล่าวโดยอิงตามค่าของช่องอื่นๆ และอาจส่งไปพร้อมคำขออัปเดตเพื่อให้แน่ใจว่าไคลเอ็นต์มีค่าเป็นปัจจุบันก่อนดำเนินการต่อ

ดูข้อมูลเพิ่มเติมเกี่ยวกับ etag ในมาตรฐาน AIP-154 ของ Google

eTag นี้ได้รับการตรวจสอบอย่างเข้มงวด

ทรัพยากรเริ่มต้น

ทรัพยากรเริ่มต้นที่เชื่อมโยงกับโปรเจ็กต์

การแสดง JSON 
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
ช่อง
hostingSite

string

เอาต์พุตเท่านั้น ชื่อเว็บไซต์โฮสติ้งของ Firebase เริ่มต้นในรูปแบบ

PROJECT_ID

แม้ว่าจะพบไม่บ่อย แต่อาจมีการใช้ projectId เป็นชื่อสำหรับเว็บไซต์โฮสติ้งที่มีอยู่ในโปรเจ็กต์อื่นแล้ว (ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างเว็บไซต์เพิ่มเติมที่ไม่ใช่ค่าเริ่มต้น) ในกรณีเหล่านี้ projectId จะต่อท้ายด้วยเครื่องหมายขีดกลางและอักขระที่เป็นตัวอักษรและตัวเลขคละกัน 5 ตัวเพื่อสร้างชื่อเว็บไซต์โฮสติ้งเริ่มต้น ตัวอย่างเช่น หาก projectId ของคุณคือ myproject123 ชื่อเว็บไซต์โฮสติ้งเริ่มต้นอาจเป็น myproject123-a5c16
realtimeDatabaseInstance

string

เอาต์พุตเท่านั้น ชื่ออินสแตนซ์ฐานข้อมูลเรียลไทม์ของ Firebase เริ่มต้นในรูปแบบ

PROJECT_ID

แม้ว่าจะพบไม่บ่อยนัก แต่อาจมีการใช้ projectId เป็นชื่อสำหรับอินสแตนซ์ Realtime Database ที่มีอยู่ในโปรเจ็กต์อื่นแล้ว (ดูข้อมูลเพิ่มเติมเกี่ยวกับการชาร์ดดิ้งฐานข้อมูล) ในกรณีเหล่านี้ ระบบจะเติม projectId ต่อท้ายด้วยเครื่องหมายขีดกลางและอักขระที่เป็นตัวอักษรและตัวเลขคละกัน 5 ตัวเพื่อสร้างชื่ออินสแตนซ์ฐานข้อมูลเรียลไทม์เริ่มต้น ตัวอย่างเช่น หาก projectId ของคุณคือ myproject123 ชื่ออินสแตนซ์ฐานข้อมูลเริ่มต้นอาจเป็น myproject123-a5c16
storageBucket

string

เอาต์พุตเท่านั้น ที่เก็บข้อมูลเริ่มต้นของพื้นที่เก็บข้อมูลของ Cloud Storage for Firebase ในรูปแบบต่อไปนี้

PROJECT_ID.appspot.com
locationId

string

เอาต์พุตเท่านั้น รหัสตำแหน่งทรัพยากร GCP เริ่มต้นของโปรเจ็กต์ สถานที่ตั้งดังกล่าวเป็นตำแหน่งทรัพยากร GCP ที่พร้อมให้บริการ

หากยังไม่สรุปตำแหน่งทรัพยากร GCP เริ่มต้น ระบบจะเว้นช่องนี้ไว้ หากต้องการตั้งค่าตำแหน่งทรัพยากร GCP เริ่มต้นของโปรเจ็กต์ ให้เรียกใช้ defaultLocation.finalize หลังจากที่คุณเพิ่มทรัพยากร Firebase ไปยังโปรเจ็กต์แล้ว

รัฐ

สถานะวงจรที่เป็นไปได้ของโปรเจ็กต์ ดูข้อมูลเพิ่มเติมเกี่ยวกับรัฐในมาตรฐาน AIP-216 ของ Google

Enum
STATE_UNSPECIFIED สถานะที่ไม่ได้ระบุ
ACTIVE โปรเจ็กต์เปิดใช้งานอยู่
DELETED โปรเจ็กต์ถูกลบชั่วคราวแล้ว

เมธอด

addFirebase

 เพิ่มทรัพยากร Firebase ไปยัง Google Cloud Platform (GCP) Project ที่มีอยู่ตามที่ระบุ

addGoogleAnalytics

 ลิงก์ FirebaseProject ที่ระบุกับบัญชี Google Analytics ที่มีอยู่

get

 รับ FirebaseProject ที่ระบุ

getAdminSdkConfig

 รับอาร์ติแฟกต์การกำหนดค่าที่เชื่อมโยงกับ FirebaseProject ที่ระบุ ซึ่งเซิร์ฟเวอร์จะใช้เพื่อทำให้การเริ่มต้นง่ายขึ้นได้

getAnalyticsDetails

 ดูรายละเอียดของ Google Analytics ที่เชื่อมโยงกับ FirebaseProject ที่ระบุในปัจจุบัน

list

 แสดงรายการ FirebaseProject แต่ละรายการที่ผู้โทรเข้าถึงได้

patch

 อัปเดตแอตทริบิวต์ของ FirebaseProject ที่ระบุ

removeAnalytics

 ยกเลิกการเชื่อมโยง FirebaseProject ที่ระบุจากบัญชี Google Analytics ของบัญชีดังกล่าว

searchApps

 แสดงรายการแอปที่ใช้ได้ทั้งหมดสำหรับ FirebaseProject ที่ระบุ