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

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

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

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

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

ก่อนจะเริ่ม

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

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

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

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

   • รหัสโปรเจ็ กต์ — เรียกใช้ firebase projects:list จากทุกที่บนคอมพิวเตอร์ของคุณ
   • ชื่อแทนโปรเจ็ กต์ — เรียกใช้ firebase use จากไดเร็กทอรีแอปในเครื่องของคุณ

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

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

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

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

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

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

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

   firebase ext:info publisher-id/extension-id

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

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

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

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

2. เรียกใช้คำสั่งติดตั้งส่วนขยาย หากได้รับแจ้ง ให้ป้อนค่าพารามิเตอร์เพื่อปรับแต่งอินสแตนซ์ของส่วนขยาย

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

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

   ข้ามเทอร์มินัลโต้ตอบพร้อมท์สำหรับค่าพารามิเตอร์ระหว่างการติดตั้ง

   1. สร้างไฟล์ . params.env .env ที่กำหนดค่าพารามิเตอร์ของคุณ บันทึกไฟล์ในเครื่อง

      • ประกาศพารามิเตอร์แต่ละตัวตามค่า param ที่พบใน extension.yaml extension.yaml ของส่วนขยาย
      • รวมค่าสำหรับพารามิเตอร์ทั้งหมด
      • ทำตาม ไวยากรณ์ dotenv

      ตัวอย่างเช่น สำหรับ ส่วนขยาย Translate Text คุณสามารถสร้างไฟล์ .env นี้ได้:

      # params.env
      
      LOCATION=us-east1
      LANGUAGES=fr,es
      COLLECTION_PATH=translations
      INPUT_FIELD_NAME=input
      OUTPUT_FIELD_NAME=output
      

   2. รันคำสั่ง extension-install ด้วยแฟ --params ตัวอย่างเช่น ในการติดตั้งส่วนขยาย Translate Text ให้รันคำสั่งต่อไปนี้:

      firebase ext:install firebase/firestore-translate-text --params=path/to/params.env --project=projectID-or-alias

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

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

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

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

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

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

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

ดูเอกสารของส่วนขยายสำหรับรายการกิจกรรม (ถ้ามี) ที่เผยแพร่

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

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

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

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

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

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

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

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

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