ตั้งค่าและใช้พารามิเตอร์ในส่วนขยายของคุณ

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

พารามิเตอร์เหล่านี้พร้อมให้คุณอ้างอิงในซอร์สโค้ดฟังก์ชันของส่วนขยาย ไฟล์ extension.yaml และไฟล์ POSTINSTALL.md ของคุณ ต่อไปนี้เป็นไวยากรณ์สำหรับวิธีอ้างอิงพารามิเตอร์ชื่อ PARAMETER_NAME :

• ภายในซอร์สโค้ดฟังก์ชันของคุณ ให้ใช้ โมดูล params (เช่น params.defineInt(" PARAMETER_NAME ") ) หรือ process.env. PARAMETER_NAME

• ภายใน extension.yaml และ POSTINSTALL.md ให้ใช้ ${param: PARAMETER_NAME }

  หลังการติดตั้ง คอนโซล Firebase จะแสดงเนื้อหาของไฟล์ POSTINSTALL.md และเติมการอ้างอิงพารามิเตอร์ด้วยค่า จริง สำหรับอินสแตนซ์ที่ติดตั้ง

พารามิเตอร์ที่เติมอัตโนมัติ

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

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

แม้ว่า Firebase จะเติมค่าพารามิเตอร์เหล่านี้สำหรับส่วนขยายโดยอัตโนมัติ แต่ Firebase จะไม่จัดสรรผลิตภัณฑ์ที่เกี่ยวข้องให้กับผู้ใช้โดยอัตโนมัติในระหว่างการติดตั้ง ผู้ใช้ที่ติดตั้งส่วนขยายจะต้องเปิดใช้งานผลิตภัณฑ์ที่เกี่ยวข้องและเกี่ยวข้องในโปรเจ็กต์ของตนก่อนการติดตั้ง ตัวอย่างเช่น หากส่วนขยายของคุณเกี่ยวข้องกับ Cloud Firestore ผู้ใช้จะต้อง ตั้งค่า Cloud Firestore ในโปรเจ็กต์ของตน เราขอแนะนำให้แจ้งผู้ใช้ของคุณเกี่ยวกับข้อกำหนดเหล่านี้ใน ไฟล์ PREINSTALL.md

พารามิเตอร์ที่ผู้ใช้กำหนด

หากต้องการให้ผู้ใช้ปรับแต่งแต่ละอินสแตนซ์ที่ติดตั้งของส่วนขยาย คุณสามารถขอให้ผู้ใช้ระบุค่าพารามิเตอร์ระหว่างการติดตั้งได้ หากต้องการขอค่าเหล่านี้ คุณจะต้องตั้งค่าข้อความแจ้งในส่วน params ของไฟล์ extension.yaml

ต่อไปนี้คือส่วน params ตัวอย่าง ตามด้วยตารางที่อธิบายช่องพารามิเตอร์ที่มีอยู่ทั้งหมด

# extension.yaml
...

# Parameters (environment variables) for which the user specifies values during installation
params:
  - param: DB_PATH
    label: Realtime Database path
    description: >-
      What is the Realtime Database path where you will write new text
      for sentiment analysis?
    type: string
    validationRegex: ^\S+$
    validationErrorMessage: Realtime Database path cannot contain spaces.
    example: path/to/posts
    required: true

  - param: TEXT_KEY
    label: Key for text
    description: What is the name of the key that will contain text to be analyzed?
    type: string
    default: textToAnalyze
    required: true

ในส่วน params ของไฟล์ extension.yaml ให้ใช้ช่องต่อไปนี้เพื่อกำหนดพารามิเตอร์ที่ผู้ใช้กำหนดค่า:

options:
  - label:
    value:
  - label:
    value:
  - label:
    value:

การตรวจสอบความถูกต้องและการส่งข้อความแสดงข้อผิดพลาดสำหรับค่าที่ผู้ใช้กำหนด

เมื่อคุณตั้งค่าพารามิเตอร์ด้วย type string คุณจะต้องกำหนดการตรวจสอบความถูกต้องของ regex ที่เหมาะสมผ่านทางช่อง validationRegex ของพารามิเตอร์

นอกจากนี้ สำหรับส่วนขยายจำนวนมาก ค่าพารามิเตอร์ที่ขอโดยทั่วไปคือเส้นทางฐานข้อมูลหรือที่เก็บข้อมูล Cloud Storage โปรดทราบว่าในระหว่างการติดตั้ง กำหนดค่าใหม่ หรืออัป เดต บริการส่วนขยายจะ ไม่ ตรวจสอบสิ่งต่อไปนี้ในขณะที่ ป้อน ค่าพารามิเตอร์ :

• มีการตั้งค่าฐานข้อมูลที่ระบุหรือที่เก็บข้อมูล Cloud Storage ภายในโปรเจ็กต์ Firebase ของผู้ใช้หรือไม่
• ไม่ว่าเส้นทางฐานข้อมูลที่ระบุจะมีอยู่ในฐานข้อมูลของผู้ใช้หรือไม่

อย่างไรก็ตาม เมื่อส่วนขยายปรับใช้ทรัพยากรจริง คอนโซล Firebase หรือ Firebase CLI จะแสดงข้อความแสดงข้อผิดพลาดหากยังไม่ได้ตั้งค่าฐานข้อมูลอ้างอิงหรือที่เก็บข้อมูล Cloud Storage ในโปรเจ็กต์

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

พารามิเตอร์ของระบบ

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

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

อย่างไรก็ตาม หากส่วนขยายของคุณมีข้อกำหนดทรัพยากรพิเศษ คุณสามารถตั้งค่าเฉพาะในระดับต่อทรัพยากรใน extension.yaml ได้ การตั้งค่าการกำหนดค่าต่อทรัพยากรเหล่านี้จะแทนที่การตั้งค่าทั่วทั้งอินสแตนซ์ส่วนขยายของผู้ใช้ ตัวอย่างเช่น:

resources:
- name: high_memory_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function needs at least 1GB of memory!
  properties:
    httpsTrigger: {}
    runtime: nodejs18
    availableMemoryMb: 1024
- name: normal_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function has no special memory requirements. It will use the
    default value, or the value of `firebaseextension.v1beta.function/memory`
  properties:
    httpsTrigger: {}
    runtime: nodejs18

พารามิเตอร์ของระบบที่ใช้ได้คือ: