REST Resource: projects.webApps

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

รายละเอียดของแอป Firebase สำหรับเว็บ

การเป็นตัวแทน JSON
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
เขตข้อมูล
name

string

ชื่อทรัพยากรของ WebApp ในรูปแบบ:

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID

  • PROJECT_IDENTIFIER : ProjectNumber ของโปรเจ็กต์หลัก (แนะนำ) หรือ ProjectId เรียนรู้เพิ่มเติมเกี่ยวกับการใช้ตัวระบุโครงการใน มาตรฐาน AIP 2510 ของ Google
    โปรดทราบว่าค่าสำหรับ PROJECT_IDENTIFIER ในเนื้อหาการตอบสนองใดๆ จะเป็น ProjectId
  • APP_ID : ตัวระบุที่กำหนดโดย Firebase ที่ไม่ซ้ำกันทั่วโลกสำหรับแอป (ดู appId )
appId

string

เอาท์พุทเท่านั้น ไม่เปลี่ยนรูป ตัวระบุที่กำหนดโดย Firebase ที่ไม่ซ้ำกันทั่วโลกสำหรับ WebApp

ตัวระบุนี้ควรถือเป็นโทเค็นทึบแสง เนื่องจากไม่ได้ระบุรูปแบบข้อมูล

displayName

string

ชื่อที่แสดงที่ผู้ใช้กำหนดสำหรับ WebApp

projectId

string

เอาท์พุทเท่านั้น ไม่เปลี่ยนรูป ตัวระบุเฉพาะที่ผู้ใช้กำหนดของ FirebaseProject หลักสำหรับ WebApp

appUrls[]

string

URL ที่โฮสต์ WebApp

webId
(deprecated)

string

เอาท์พุทเท่านั้น ไม่เปลี่ยนรูป ตัวระบุที่กำหนดโดย Firebase ที่ไม่ซ้ำกันสำหรับ WebApp

ตัวระบุนี้ใช้เพื่อเติมค่า namespace สำหรับ WebApp เท่านั้น สำหรับกรณีการใช้งานส่วนใหญ่ ให้ใช้ appId เพื่อระบุหรืออ้างอิงแอป ค่า webId จะไม่ซ้ำกันภายใน FirebaseProject และแอปที่เกี่ยวข้องเท่านั้น

apiKeyId

string

ตัวระบุ (UID) ที่กำหนดโดย Google ที่ไม่ซ้ำกันทั่วโลกสำหรับคีย์ Firebase API ที่เชื่อมโยงกับ WebApp

โปรดทราบว่าค่านี้เป็น UID ของคีย์ API ไม่ใช่ keyString ของคีย์ API keyString คือค่าที่สามารถพบได้ใน ส่วนกำหนดค่า ของแอป

หากไม่ได้ตั้ง apiKeyId ในคำขอไปยัง webApps.Create Firebase จะเชื่อมโยง apiKeyId กับ WebApp โดยอัตโนมัติ คีย์ที่เชื่อมโยงอัตโนมัตินี้อาจเป็นคีย์ที่ถูกต้องที่มีอยู่ หรือหากไม่มีคีย์ที่ถูกต้อง ระบบจะจัดเตรียมคีย์ใหม่

ในคำขอแพตช์ ไม่สามารถตั้งค่า apiKeyId เป็นค่าว่างได้ และ UID ใหม่จะต้องไม่มีข้อจำกัดหรือมีเพียงข้อจำกัดที่ถูกต้องสำหรับ WebApp ที่เกี่ยวข้องเท่านั้น เราขอแนะนำให้ใช้ Google Cloud Console เพื่อจัดการคีย์ API

state

enum ( State )

เอาท์พุทเท่านั้น สถานะวงจรชีวิตของแอป

etag

string

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

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

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

วิธีการ

create

ร้องขอการสร้าง WebApp ใหม่ใน FirebaseProject ที่ระบุ

get

รับ WebApp ที่ระบุ

getConfig

รับส่วนการกำหนดค่าที่เกี่ยวข้องกับ WebApp ที่ระบุ

list

แสดงรายการ WebApp แต่ละรายการที่เกี่ยวข้องกับ FirebaseProject ที่ระบุ

patch

อัพเดตแอ็ตทริบิวต์ของ WebApp ที่ระบุ

remove

ลบ WebApp ที่ระบุออกจาก FirebaseProject

undelete

คืนค่า WebApp ที่ระบุเป็น FirebaseProject