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 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
เรียนรู้เพิ่มเติมเกี่ยวกับการใช้ตัวระบุโครงการใน มาตรฐาน 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 ของคุณจะถูกต่อท้ายด้วยเครื่องหมายยัติภังค์และตัวเลขและตัวอักษรห้าตัวเพื่อสร้างชื่อไซต์โฮสติ้งเริ่มต้นของคุณ ตัวอย่างเช่น หาก projectId ของคุณคือ myproject123 ชื่อไซต์โฮสติ้งเริ่มต้นของคุณอาจเป็น: myproject123-a5c16

realtimeDatabaseInstance

string

เอาท์พุทเท่านั้น ชื่ออินสแตนซ์ Firebase Realtime Database เริ่มต้นในรูปแบบ:

PROJECT_ID

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

storageBucket

string

เอาท์พุทเท่านั้น ที่เก็บข้อมูล Cloud Storage เริ่มต้นสำหรับ Firebase ในรูปแบบ:

PROJECT_ID .appspot.com

locationId

string

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

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

สถานะ

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

เอนัม
STATE_UNSPECIFIED สถานะที่ไม่ระบุ
ACTIVE โครงการมีการใช้งานอยู่
DELETED โครงการถูกลบอย่างนุ่มนวลแล้ว

วิธีการ

addFirebase

เพิ่มทรัพยากร Firebase ให้กับ Project Google Cloud Platform (GCP) ที่มีอยู่ที่ระบุ

addGoogleAnalytics

เชื่อมโยง FirebaseProject ที่ระบุกับ บัญชี Google Analytics ที่มีอยู่

get

รับ FirebaseProject ที่ระบุ

getAdminSdkConfig

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

getAnalyticsDetails

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

list

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

patch

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

removeAnalytics

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

searchApps

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