REST Resource: projects.webApps

แหล่งข้อมูล: เว็บแอป

รายละเอียดของแอป 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) ที่ไม่ซ้ำกันทั่วโลกสำหรับคีย์ Firebase API ซึ่งเชื่อมโยงกับ WebApp

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

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

ในคำขอแพตช์ จะตั้งค่า apiKeyId เป็นค่าว่างไม่ได้ และ UID ใหม่ต้องไม่มีข้อจำกัดหรือมีเพียงข้อจำกัดที่ถูกต้องสำหรับ WebApp ที่เชื่อมโยง เราขอแนะนำให้ใช้คอนโซล Google Cloud เพื่อจัดการคีย์ 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