ติดตั้งส่วนขยาย Firebase

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

อย่าลืมตรวจสอบ ความแตกต่าง ในการดำเนินการที่รองรับสำหรับ Firebase CLI และคอนโซล Firebase


หากต้องการติดตั้งหรือจัดการส่วนขยาย คุณต้องได้รับมอบหมายบทบาทใดบทบาทหนึ่งต่อไปนี้ เจ้าของหรือผู้แก้ไข หรือ ผู้ดูแลระบบ Firebase

หากต้องการติดตั้งส่วนขยาย โปรเจ็กต์ของคุณต้องอยู่ในแผน Blaze (จ่ายตามการใช้งาน) แม้ว่าจะไม่มีค่าใช้จ่ายในการติดตั้งส่วนขยาย แต่คุณอาจถูกเรียกเก็บเงินสำหรับการใช้บริการ Firebase หรือบริการคลาวด์ เช่น Cloud Secret Manager หากการใช้งานของคุณเกินระดับฟรีของบริการ

ก่อนที่คุณจะเริ่ม

  1. หากคุณยังไม่ได้ เพิ่ม Firebase ในโครงการของคุณ

  2. หากคุณยังไม่ได้อัปเกรดโปรเจ็กต์ของคุณเป็นแผน Blaze (จ่ายตามการใช้งาน)

  3. ติดตั้งหรืออัปเดตเป็น Firebase CLI เวอร์ชันล่าสุด

  4. จดรหัสโปรเจ็กต์ Firebase ของคุณหรือชื่อแทนโปรเจ็กต์ที่กำหนดค่าไว้ก่อนหน้านี้

ขั้นตอนที่ 1 : ดูข้อมูลโดยละเอียดเกี่ยวกับส่วนขยาย

ขั้นตอนนี้เป็นทางเลือก แต่ขอแนะนำเป็นอย่างยิ่ง

ก่อนที่จะติดตั้งส่วนขยาย Firebase เราขอแนะนำให้คุณตรวจสอบข้อมูลโดยละเอียดเกี่ยวกับส่วนขยาย รวมถึง:

  • วิธีการทำงานของส่วนขยาย งานก่อนการติดตั้ง และรายละเอียดเกี่ยวกับส่วนขยาย
  • ข้อมูลการระบุทั่วไปและคำอธิบาย
  • งานของส่วนขยายจำเป็นต้องมีบัญชีสำหรับการเรียกเก็บเงินหรือไม่
  • บริการของ Google (API) และ บทบาทการเข้าถึง ที่จำเป็นสำหรับการดำเนินการ
  • ทรัพยากร ที่สร้างขึ้นสำหรับส่วนขยาย (เช่น ฟังก์ชัน)
  • คำอธิบายของพารามิเตอร์ที่ผู้ใช้กำหนดได้

หากต้องการดูข้อมูลโดยละเอียดของส่วนขยาย:

  1. ตรวจสอบให้แน่ใจว่าคุณได้ ตั้งค่าสภาพแวดล้อมของคุณ และ เลือกส่วนขยาย

  2. เรียกใช้คำสั่ง extension-info จากทุกที่บนคอมพิวเตอร์ของคุณ:

    firebase ext:info publisher-id/extension-id

    จำเป็นต้องมีอาร์กิวเมนต์ publisher-id และ extension-id และสามารถดูได้ใน หน้ารายละเอียดการติดตั้งล่วงหน้าของส่วนขยาย

ขั้นตอนที่ 2 : ติดตั้งส่วนขยาย

ในระหว่างขั้นตอนการติดตั้ง คุณจะได้รับแจ้งให้ตรวจสอบข้อกำหนดพื้นฐานสำหรับส่วนขยาย (เช่น การเปิดใช้งาน API ทรัพยากร ที่สร้าง การให้สิทธิ์ ในการเข้าถึง ฯลฯ) คุณจะได้รับแจ้งเกี่ยวกับข้อกำหนดในการเรียกเก็บเงิน และคุณยังจะได้รับแจ้งให้ระบุค่าสำหรับพารามิเตอร์ที่กำหนดค่าได้ของส่วนขยายด้วย

  1. ตรวจสอบให้แน่ใจว่าคุณได้ ตั้งค่าสภาพแวดล้อมของคุณ และ เลือกส่วนขยาย

  2. จากไดเร็กทอรี Firebase ในเครื่องของคุณ ให้รันคำสั่ง extension-install หากได้รับแจ้ง ให้ป้อนค่าพารามิเตอร์เพื่อปรับแต่งอินสแตนซ์ส่วนขยาย

    firebase ext:install publisher-id/extension-id --project=projectId-or-alias

    จำเป็นต้องมีอาร์กิวเมนต์ publisher-id และ extension-id และสามารถดูได้ใน หน้ารายละเอียดการติดตั้งล่วงหน้าของส่วนขยาย

    การรันคำสั่งนี้จะเพิ่มอินสแตนซ์ส่วนขยายให้กับ รายการส่วนขยาย ของคุณ

  3. จากนั้น หากต้องการปรับใช้ส่วนขยายในรายการของคุณกับโปรเจ็กต์ Firebase ให้เรียกใช้:

    firebase deploy --only extensions --project=projectId-or-alias

ขั้นตอนที่ 3 : ตั้งค่าหลังการติดตั้งให้เสร็จสิ้น

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

คุณยังสามารถดูคำแนะนำเหล่านี้ได้ในไฟล์ POSTINSTALL.md ที่รวมอยู่ใน ไดเร็กทอรีต้นทางของส่วนขยาย

สร้างทรัพยากร Firebase

หากคุณกำหนดค่าส่วนขยายให้ใช้ทรัพยากร Firebase (คอลเล็กชัน Cloud Firestore, เส้นทางฐานข้อมูลเรียลไทม์, ที่เก็บข้อมูล Cloud Storage) ที่ไม่มีอยู่แล้ว ให้สร้างส่วนขยายก่อนใช้ส่วนขยาย

สร้างตัวจัดการเหตุการณ์ Eventarc

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

ดูเอกสารประกอบของส่วนขยายเพื่อดูรายการเหตุการณ์ (ถ้ามี) ที่เผยแพร่ ตัวอย่างเช่น ดู ประเภทเหตุการณ์สำหรับส่วนขยาย Run Payments with Stripe

จากนั้น โปรดดู ทริกเกอร์เหตุการณ์แบบกำหนดเอง สำหรับข้อมูลเกี่ยวกับการเขียนตัวจัดการเหตุการณ์ Eventarc

ติดตั้งอินสแตนซ์ส่วนขยายหลายรายการ

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

ขั้นตอนถัดไป

  • ดูรายละเอียดและการกำหนดค่า ส่วนขยายที่ติดตั้งของคุณในคอนโซล Firebase

  • ตรวจสอบกิจกรรม ของส่วนขยายที่ติดตั้งของคุณ รวมถึงการตรวจสอบความสมบูรณ์ การใช้งาน และบันทึก

  • ใช้ Firebase CLI จัดการ ส่วนขยายที่ติดตั้งไว้ คุณสามารถกำหนดค่าใหม่หรือถอนการติดตั้งส่วนขยายของคุณ รวมถึงอัปเดตส่วนขยายเป็นเวอร์ชันล่าสุดได้

  • ใช้คอนโซล Firebase จัดการ ส่วนขยายที่ติดตั้งของคุณ สำหรับส่วนขยาย Firebase อย่างเป็นทางการ คุณสามารถกำหนดค่าใหม่หรือถอนการติดตั้งส่วนขยายของคุณ รวมถึงอัปเดตส่วนขยายเป็นเวอร์ชันล่าสุดได้

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