เขียน Cloud Functions สำหรับส่วนขยาย

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

ดูข้อมูลทั่วไปเกี่ยวกับการใช้ Cloud Functions ได้ในเอกสารประกอบของ Cloud Functions

รุ่นที่ 1 และ 2 Cloud Functions

Firebase รองรับทั้ง Cloud Functions รุ่นที่ 1 และรุ่นที่ 2 อย่างไรก็ตาม ปัจจุบันส่วนขยาย Firebase มีข้อจํากัดบางอย่างเกี่ยวกับรุ่นของฟังก์ชัน Cloud ที่คุณใช้กับทริกเกอร์บางประเภทได้ ด้วยเหตุนี้ ชิ้นงานจำนวนมากจึงมีฟังก์ชันรุ่นที่ 1 และ 2 ผสมกัน

โปรดดูการรองรับการสร้างฟังก์ชันสำหรับทริกเกอร์แต่ละประเภทที่ด้านล่าง

สิ่งที่ควรพิจารณาเป็นพิเศษ

  • การกําหนดฟังก์ชันบางรายการกําหนดให้คุณระบุข้อมูลที่ระบุไว้ในไฟล์ extension.yaml ด้วย เช่น Cloud Firestore มีเมธอด document() ที่ระบุรูปแบบเอกสารที่จะเฝ้าดู และการประกาศที่เกี่ยวข้องใน extension.yaml มีช่อง resource ที่ระบุรูปแบบเดียวกัน

    ในกรณีเหล่านี้ ระบบจะใช้การกําหนดค่าที่ระบุในไฟล์ extension.yaml และจะไม่สนใจการกําหนดค่าที่ระบุไว้ในคําจํากัดความของฟังก์ชัน

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

  • Cloud Functions SDK รุ่นที่ 1 มีเมธอด functions.config() และfunctions:config:set คำสั่ง CLI ที่คุณสามารถใช้เพื่อทำงานกับค่าที่มีพารามิเตอร์ในฟังก์ชันรุ่นที่ 1 เราเลิกใช้งานเทคนิคนี้ใน Cloud Functions และจะไม่ทำงานเลยในส่วนขยาย แต่ให้ใช้ข้อบังคับของ functions.params (แนะนำ) หรือ process.env แทน

การใช้ TypeScript

เอกสารประกอบส่วนใหญ่สำหรับการพัฒนาส่วนขยายของคุณเองจะอธิบายเวิร์กโฟลว์ที่ใช้ JavaScript สําหรับ Cloud Functions for Firebase แต่คุณเขียนฟังก์ชันโดยใช้ TypeScript แทนได้

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

หากเขียนฟังก์ชันของเวิร์กชีตใน TypeScript คุณต้องทําดังนี้ก่อนติดตั้งส่วนขยาย

  1. คอมไพล์ซอร์สโค้ดของฟังก์ชันของส่วนขยายเป็น JavaScript

    firebase ext:dev:init คำสั่ง ช่วยให้คุณเลือก TypeScript ในการเขียนฟังก์ชันได้ คำสั่งนี้จะสร้างส่วนขยายที่ติดตั้งได้สมบูรณ์ รวมถึงสคริปต์การสร้างที่คุณเรียกใช้ได้ด้วย npm run build

  2. ในไฟล์ package.json ให้ตรวจสอบว่าได้ชี้ช่อง main ไปที่ JavaScript ที่สร้างขึ้น

  3. หากคุณกำลังติดตั้งหรืออัปโหลดส่วนขยายจากแหล่งที่มาในเครื่อง ให้คอมไพล์ไฟล์ TypeScript ก่อน

ทริกเกอร์ฟังก์ชันที่รองรับ

ทริกเกอร์ HTTP

ระบบจะติดตั้งใช้งานฟังก์ชันที่ทริกเกอร์โดย HTTP ไปยังปลายทาง https สาธารณะและจะทํางานเมื่อมีการเข้าถึงปลายทาง

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์ HTTP ได้ที่การเรียกฟังก์ชันผ่านคําขอ HTTP ในCloud Functions เอกสารประกอบ

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { https } from "firebase-functions/v1";

export const yourFunctionName = https.onRequest(async (req, resp) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      runtime: nodejs16
      httpsTrigger: {}
  - name: anotherFunction
    type: ...

ฟังก์ชันที่เรียกใช้ได้

ฟังก์ชันที่เรียกใช้ได้จะคล้ายกับฟังก์ชันที่ทริกเกอร์ HTTP แต่จะใช้โปรโตคอลที่ช่วยให้เรียกใช้จากโค้ดฝั่งไคลเอ็นต์ได้อย่างสะดวก

ดูข้อมูลเกี่ยวกับการใช้ฟังก์ชันที่เรียกใช้ได้ที่หัวข้อเรียกใช้ฟังก์ชันจากแอปในเอกสารประกอบของ Cloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { https } from "firebase-functions/v1";

export const yourFunctionName = https.onCall(async (data, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      runtime: nodejs16
      httpsTrigger: {}
  - name: anotherFunction
    type: ...

ทริกเกอร์ฟังก์ชันที่กำหนดเวลาไว้

ฟังก์ชันที่กำหนดเวลาไว้จะทํางานซ้ำๆ ตามกําหนดเวลาที่กําหนดเองได้

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ตั้งเวลาไว้ได้ที่หัวข้อตั้งเวลาฟังก์ชันในเอกสารประกอบของ Cloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { pubsub } from "firebase-functions/v1";

export const yourFunctionName = pubsub.schedule("every 6 hours").onRun((context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      scheduleTrigger:
        schedule: 'every 5 minutes'
  - name: anotherFunction
    type: ...

ฟิลด์ย่อยที่ใช้ได้สำหรับ scheduleTrigger มีดังนี้

ฟิลด์ คำอธิบาย
schedule
(ต้องระบุ)

ความถี่ที่คุณต้องการให้ฟังก์ชันทํางาน

ช่องนี้ยอมรับสตริงที่ใช้ไวยากรณ์อย่างใดอย่างหนึ่งต่อไปนี้ (ต้องใส่เครื่องหมายคำพูดเดี่ยว)
timeZone
(ไม่บังคับ)

เขตเวลาที่กําหนดการจะทํางาน

หากต้องการให้ผู้ใช้กำหนดเวลาได้เมื่อติดตั้งส่วนขยาย ให้เพิ่มพารามิเตอร์ใหม่ลงในไฟล์ extension.yaml แล้วอ้างอิงพารามิเตอร์ในการประกาศ resource ของฟังก์ชัน ดังนี้

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      scheduleTrigger:
        schedule: ${SCHEDULE_FREQUENCY}
  - name: anotherFunction
    type: ...

params:
  - param: SCHEDULE_FREQUENCY
    label: Schedule
    description: How often do you want to run yourFunctionName()?
    type: string
    default: 'every 5 minutes'  # Specifying a default is optional.
    required: true

ทริกเกอร์คิวงาน

ฟังก์ชันคิวงานจะทริกเกอร์ในเหตุการณ์ในวงจรของส่วนขยาย หรือเมื่อเพิ่มลงในคิวงานของส่วนขยายด้วยตนเองโดยใช้TaskQueue.enqueue() ของ Admin SDK

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่จัดการเหตุการณ์วงจรของลูกค้าได้ที่หัวข้อจัดการเหตุการณ์วงจรของลูกค้า

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันคิวงานได้ที่การจัดคิวฟังก์ชันด้วย Cloud Tasks ในเอกสารประกอบCloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { tasks } from "firebase-functions/v1";

export const yourFunctionName = tasks.taskQueue().onDispatch(async (data, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: myTaskFunction
    type: firebaseextensions.v1beta.function
    description: >-
      Perform a task when triggered by a lifecycle event
    properties:
      taskQueueTrigger: {}

ตั้งค่าชุดพร็อพเพอร์ตี้ taskQueueTrigger เป็น {} หรือแผนที่ของตัวเลือกที่จะปรับขีดจำกัดอัตราและลักษณะการลองอีกครั้งของคิวงาน (ดูการปรับคิวงาน)

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

lifecycleEvents:
  onInstall:
    function: myTaskFunction
    processingMessage: Resizing your existing images
  onUpdate:
    function: myOtherTaskFunction
    processingMessage: Setting up your extension
  onConfigure:
    function: myOtherTaskFunction
    processingMessage: Setting up your extension

Analytics

ฟังก์ชันที่ทริกเกอร์โดย Analytics จะทํางานเมื่อมีการบันทึกเหตุการณ์ Analytics ที่ระบุ

ดูทริกเกอร์ Google Analytics ในเอกสารประกอบ Cloud Functions เพื่อดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์ Analytics

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { analytics } from "firebase-functions/v1";

export const yourFunctionName = analytics.event("event_name").onLog((event, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.analytics/eventTypes/event.log
        resource: projects/${PROJECT_ID}/events/ga_event
  - name: anotherFunction
    type: ...

หากต้องการให้ผู้ใช้กําหนดค่าเหตุการณ์ Analytics ให้รอรับเมื่อติดตั้งส่วนขยาย ให้เพิ่มพารามิเตอร์ใหม่ลงในไฟล์ extension.yaml และอ้างอิงพารามิเตอร์ในการประกาศ resource ของฟังก์ชัน ดังนี้

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.analytics/eventTypes/event.log
        resource: projects/${PROJECT_ID}/events/${EVENT_NAME}
  - name: anotherFunction
    type: ...

params:
  - param: EVENT_NAME
    label: Analytics event
    description: What event do you want to respond to?
    type: string
    default: ga_event  # Specifying a default is optional.
    required: true

Authentication

ฟังก์ชันที่ทริกเกอร์การตรวจสอบสิทธิ์จะทำงานเมื่อมีการสร้างหรือลบผู้ใช้

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์การตรวจสอบสิทธิ์ได้ที่ทริกเกอร์การตรวจสอบสิทธิ์ Firebase ในCloud Functionsเอกสารประกอบ

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { auth } from "firebase-functions/v1";

export const yourFunctionName = auth.user().onCreate((user, context) => {
  // ...
});

export const yourFunctionName2 = auth.user().onDelete((user, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/firebase.auth/eventTypes/user.create
        resource: projects/${PROJECT_ID}
  - name: anotherFunction
    type: ...

ตารางต่อไปนี้แสดงวิธีระบุAuthenticationประเภทเหตุการณ์ แต่ละประเภทที่รองรับ

ทริกเกอร์เหตุการณ์ Cloud Functions eventType คำอธิบาย
onCreate() providers/firebase.auth/eventTypes/user.create สร้างผู้ใช้ใหม่แล้ว
onDelete() providers/firebase.auth/eventTypes/user.delete มีการลบผู้ใช้

Cloud Firestore

ฟังก์ชันที่ทริกเกอร์โดย Cloud Firestore จะทำงานเมื่อมีการสร้าง อัปเดต หรือลบเอกสาร

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์โดย Firestore ได้ที่ทริกเกอร์ Cloud Firestore ในเอกสารประกอบ Cloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { firestore } from "firebase-functions/v1";

export const yourFunctionName = firestore.document("collection/{doc_id}")
  .onCreate((snapshot, context) => {
    // ...
  });

export const yourFunctionName2 = firestore.document("collection/{doc_id}")
  .onUpdate((change, context) => {
    // ...
  });

export const yourFunctionName3 = firestore.document("collection/{doc_id}")
  .onDelete((snapshot, context) => {
    // ...
  });

export const yourFunctionName4 = firestore.document("collection/{doc_id}")
  .onWrite((change, context) => {
    // onWrite triggers on creation, update, and deletion.
    // ...
  });

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/cloud.firestore/eventTypes/document.write
        resource: projects/${PROJECT_ID}/databases/(default)/documents/collection/{documentID}
  - name: anotherFunction
    type: ...

ตารางต่อไปนี้แสดงวิธีระบุCloud Firestoreประเภทเหตุการณ์ที่รองรับแต่ละประเภท

ทริกเกอร์เหตุการณ์ Cloud Functions eventType คำอธิบาย
onCreate() providers/cloud.firestore/eventTypes/document.create สร้างเอกสารใหม่แล้ว
onDelete() providers/cloud.firestore/eventTypes/document.delete ลบเอกสารแล้ว
onUpdate() providers/cloud.firestore/eventTypes/document.update อัปเดตเอกสารแล้ว
onWrite() providers/cloud.firestore/eventTypes/document.write เอกสารที่สร้าง ลบ หรืออัปเดตแล้ว

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

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/cloud.firestore/eventTypes/document.write
        resource: projects/${PROJECT_ID}/databases/(default)/documents/${YOUR_DOCUMENT_PATH}
  - name: anotherFunction
    type: ...

params:
  - param: YOUR_DOCUMENT_PATH
    label: Cloud Firestore path
    description: Where do you want to watch for changes?
    type: string
    default: path/to/{documentID}  # Specifying a default is optional.
    required: true

Pub/Sub

ฟังก์ชันที่ Pub/Sub ทริกเกอร์จะทำงานเมื่อมีการเผยแพร่ข้อความไปยังหัวข้อที่เฉพาะเจาะจง

ดูข้อมูลเกี่ยวกับทริกเกอร์ Pub/Sub ในเอกสารประกอบของ Cloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { pubsub } from "firebase-functions/v1";

export const yourFunctionName = pubsub.topic("topic_name").onPublish((message, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.pubsub.topic.publish
        resource: projects/${PROJECT_ID}/topics/topic-name
  - name: anotherFunction
    type: ...

หากต้องการให้ผู้ใช้กำหนดค่าหัวข้อ Pub/Sub เมื่อติดตั้งส่วนขยาย ให้เพิ่มพารามิเตอร์ใหม่ลงในไฟล์ extension.yaml และอ้างอิงพารามิเตอร์ในการประกาศ resource ของฟังก์ชัน ดังนี้

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.pubsub.topic.publish
        resource: projects/${PROJECT_ID}/topics/${PUBSUB_TOPIC}
  - name: anotherFunction
    type: ...

params:
  - param: PUBSUB_TOPIC
    label: Pub/Sub topic
    description: Which Pub/Sub topic do you want to watch for messages?
    type: string
    default: topic-name  # Specifying a default is optional.
    required: true

Realtime Database

ฟังก์ชันที่ทริกเกอร์โดย Realtime Database จะทำงานเมื่อมีการสร้าง อัปเดต หรือลบเส้นทางที่ตรงกับรูปแบบที่ระบุ

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์โดย RTDB ได้ที่ทริกเกอร์ Realtime Database ในเอกสารประกอบ Cloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { database } from "firebase-functions/v1";

export const yourFunctionName = database.ref("path/to/{item}")
  .onCreate((snapshot, context) => {
    // ...
  });

export const yourFunctionName2 = database.ref("path/to/{item}")
  .onUpdate((change, context) => {
    // ...
  });

export const yourFunctionName3 = database.ref("path/to/{item}")
  .onDelete((snapshot, context) => {
    // ...
  });

export const yourFunctionName4 = database.ref("path/to/{item}")
  .onWrite((change, context) => {
    // onWrite triggers on creation, update, and deletion.
    // ...
  });

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.database/eventTypes/ref.create
        # DATABASE_INSTANCE (project's default instance) is an auto-populated
        # parameter value. You can also specify an instance.
        resource: projects/_/instances/${DATABASE_INSTANCE}/refs/path/to/{itemId}
  - name: anotherFunction
    type: ...

ตารางต่อไปนี้แสดงวิธีระบุCloud Firestoreประเภทเหตุการณ์ที่รองรับแต่ละประเภท

ทริกเกอร์เหตุการณ์ Cloud Functions eventType คำอธิบาย
onCreate() providers/google.firebase.database/eventTypes/ref.create ข้อมูลที่สร้างขึ้น
onDelete() providers/google.firebase.database/eventTypes/ref.delete ลบข้อมูลแล้ว
onUpdate() providers/google.firebase.database/eventTypes/ref.update อัปเดตข้อมูลแล้ว
onWrite() providers/google.firebase.database/eventTypes/ref.write ข้อมูลที่สร้างขึ้น ลบ หรืออัปเดต

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

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.database/eventTypes/ref.create
        # DATABASE_INSTANCE (project's default instance) is an auto-populated
        # parameter value. You can also specify an instance.
        resource: projects/_/instances/${DATABASE_INSTANCE}/refs/${DB_PATH}
  - name: anotherFunction
    type: ...

params:
  - param: DB_PATH
    label: Realtime Database path
    description: Where do you want to watch for changes?
    type: string
    default: path/to/{itemId}  # Specifying a default is optional.
    required: true

Remote Config

ฟังก์ชันที่ทริกเกอร์โดยการกำหนดค่าระยะไกลจะทํางานเมื่อเทมเพลตพารามิเตอร์ของโปรเจ็กต์ได้รับการอัปเดต

ดูทริกเกอร์การกําหนดค่าระยะไกลในเอกสารประกอบ Cloud Functions เพื่อดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์โดยการกําหนดค่าระยะไกล

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { remoteConfig } from "firebase-functions/v1";

export const yourFunctionName = remoteConfig.onUpdate((version, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.firebase.remoteconfig.update
        resource: projects/${PROJECT_ID}
  - name: anotherFunction
    type: ...

Cloud Storage

ฟังก์ชันที่ Cloud Storage ทริกเกอร์จะทำงานเมื่อมีการสร้าง เก็บถาวร หรือลบออบเจ็กต์ หรือเมื่อมีการเปลี่ยนแปลงข้อมูลเมตาของออบเจ็กต์

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ Storage ทริกเกอร์ได้ที่ทริกเกอร์ Cloud Storage ในเอกสารประกอบ Cloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { storage } from "firebase-functions/v1";

export const yourFunctionName = storage.object().onFinalize((object, context) => {
  // ...
});

export const yourFunctionName2 = storage.object().onMetadataUpdate((object, context) => {
  // ...
});

export const yourFunctionName3 = storage.object().onArchive((object, context) => {
  // ...
});

export const yourFunctionName4 = storage.object().onDelete((object, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.storage.object.finalize
        # STORAGE_BUCKET (project's default bucket) is an auto-populated
        # parameter. You can also specify a bucket.
        resource: projects/_/buckets/${STORAGE_BUCKET}
  - name: anotherFunction
    type: ...

ตารางต่อไปนี้แสดงวิธีระบุCloud Storageประเภทเหตุการณ์ที่รองรับแต่ละประเภท

ทริกเกอร์เหตุการณ์ Cloud Functions eventType คำอธิบาย
onFinalize() google.storage.object.finalize สร้างออบเจ็กต์แล้ว
onMetadataUpdate() google.storage.object.metadataUpdate อัปเดตข้อมูลเมตาของออบเจ็กต์แล้ว
onArchive() google.storage.object.archive เก็บออบเจ็กต์แล้ว
onDelete() google.storage.object.delete ลบออบเจ็กต์แล้ว

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

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.storage.object.finalize
        resource: projects/_/buckets/${YOUR_BUCKET}
  - name: anotherFunction
    type: ...

params:
  - param: YOUR_BUCKET
    label: Cloud Storage bucket
    description: Which bucket do you want to watch for changes?
    type: selectResource
    resourceType: storage.googleapis.com/Bucket
    default: ${STORAGE_BUCKET}  # Specifying a default is optional.
    required: true

Test Lab

ฟังก์ชันที่ทริกเกอร์โดย Test Lab จะทํางานเมื่อเมทริกซ์การทดสอบทำการทดสอบเสร็จสิ้น

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์โดย Test Lab ได้ที่ทริกเกอร์ Firebase Test Lab ในเอกสารประกอบ Cloud Functions

คําจํากัดความของฟังก์ชัน (รุ่นที่ 1 เท่านั้น)

import { testLab } from "firebase-functions/v1";

export const yourFunctionName = testLab.testMatrix().onComplete((matrix, context) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.testing.testMatrix.complete
        resource: projects/${PROJECT_ID}/testMatrices/{matrixId}
  - name: anotherFunction
    type: ...

Crashlytics ทริกเกอร์การแจ้งเตือน

ฟังก์ชันที่ทริกเกอร์โดย Crashlytics จะทำงานเมื่อ Crashlytics เผยแพร่การแจ้งเตือน

ดูทริกเกอร์การแจ้งเตือนของ Firebase ในเอกสารประกอบของ Cloud Functions เพื่อดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์การแจ้งเตือน

คําจํากัดความของฟังก์ชัน (รุ่นที่ 2 เท่านั้น)

import {
  onNewFatalIssuePublished,
  onNewNonfatalIssuePublished,
  onNewAnrIssuePublished,
  onRegressionAlertPublished,
  onVelocityAlertPublished,
  onStabilityDigestPublished,
} from "firebase-functions/v2/alerts/crashlytics";

export const yourFunctionName = onNewFatalIssuePublished((event) => {
  // ...
});

export const yourFunctionName2 = onNewNonfatalIssuePublished((event) => {
  // ...
});

export const yourFunctionName3 = onNewAnrIssuePublished((event) => {
  // ...
});

export const yourFunctionName4 = onRegressionAlertPublished((event) => {
  // ...
});

export const yourFunctionName5 = onVelocityAlertPublished((event) => {
  // ...
});

export const yourFunctionName6 = onStabilityDigestPublished((event) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

apis:
  - apiName: eventarc.googleapis.com
    reason: Powers all events and triggers
  - apiName: run.googleapis.com
    reason: Powers 2nd-gen functions

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: crashlytics.newFatalIssue
  - name: anotherFunction
    type: ...

คุณใช้ค่าต่อไปนี้สําหรับ alerttype ได้

  • crashlytics.newFatalIssue
  • crashlytics.newNonfatalIssue
  • crashlytics.regression
  • crashlytics.stabilityDigest
  • crashlytics.velocity
  • crashlytics.newAnrIssue

Performance Monitoring ทริกเกอร์การแจ้งเตือน

ฟังก์ชันที่ทริกเกอร์โดย Performance Monitoring จะทำงานเมื่อ Performance Monitoring เผยแพร่การแจ้งเตือน

ดูทริกเกอร์การแจ้งเตือนของ Firebase ในเอกสารประกอบของ Cloud Functions เพื่อดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์การแจ้งเตือน

คําจํากัดความของฟังก์ชัน (รุ่นที่ 2 เท่านั้น)

import { onThresholdAlertPublished } from "firebase-functions/v2/alerts/performance";

export const yourFunctionName = onThresholdAlertPublished((event) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

apis:
  - apiName: eventarc.googleapis.com
    reason: Powers all events and triggers
  - apiName: run.googleapis.com
    reason: Powers 2nd-gen functions

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: performance.threshold
  - name: anotherFunction
    type: ...

App Distribution ทริกเกอร์การแจ้งเตือน

ฟังก์ชันที่ทริกเกอร์โดย App Distribution จะทำงานเมื่อ App Distribution เผยแพร่การแจ้งเตือน

ดูทริกเกอร์การแจ้งเตือนของ Firebase ในเอกสารประกอบของ Cloud Functions เพื่อดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์การแจ้งเตือน

คําจํากัดความของฟังก์ชัน (รุ่นที่ 2 เท่านั้น)

import {
  onNewTesterIosDevicePublished,
  onInAppFeedbackPublished
} from "firebase-functions/v2/alerts/appDistribution";

export const yourFunctionName = onNewTesterIosDevicePublished((event) => {
  // ...
});

export const yourFunctionName2 = onInAppFeedbackPublished((event) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

apis:
  - apiName: eventarc.googleapis.com
    reason: Powers all events and triggers
  - apiName: run.googleapis.com
    reason: Powers 2nd-gen functions

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: appDistribution.inAppFeedback
  - name: anotherFunction
    type: ...

คุณใช้ค่าต่อไปนี้สําหรับ alerttype ได้

  • appDistribution.newTesterIosDevice
  • appDistribution.inAppFeedback

ทริกเกอร์เหตุการณ์ที่กําหนดเอง (Eventarc)

ฟังก์ชันที่ทริกเกอร์โดย Eventarc จะทํางานเมื่อมีการเผยแพร่เหตุการณ์บางประเภทไปยังแชแนลที่เฉพาะเจาะจง

ดูข้อมูลเกี่ยวกับการเขียนฟังก์ชันที่ทริกเกอร์โดย Eventarc ได้ที่สร้างและจัดการทริกเกอร์เหตุการณ์ที่กําหนดเองในCloud Functions เอกสารประกอบ

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

คําจํากัดความของฟังก์ชัน (รุ่นที่ 2 เท่านั้น)

import { onCustomEventPublished } from "firebase-functions/v2/eventarc";

export const yourFunctionName = onCustomEventPublished((event) => {
  // ...
});

การประกาศทรัพยากร (extension.yaml)

apis:
  - apiName: eventarc.googleapis.com
    reason: Powers all events and triggers
  - apiName: run.googleapis.com
    reason: Powers 2nd-gen functions

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      # LOCATION is a user-configured parameter value specified by the user
      # during installation.
      location: ${param:LOCATION}
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
        timeoutSeconds: 60
      eventTrigger:
        eventType: firebase.extensions.storage-resize-images.v1.complete
        channel: projects/${param:PROJECT_ID}/locations/us-central1/channels/firebase
  - name: anotherFunction
    type: ...

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

ตัวอย่างข้างต้นจะสร้างทริกเกอร์เหตุการณ์ที่กําหนดเองสําหรับแชแนล Firebase "เริ่มต้น" ในภูมิภาค us-central1 คุณทำให้ชื่อและภูมิภาคของช่องปรับเปลี่ยนได้โดยใช้พารามิเตอร์ เช่น


params:
  - param: EVENTARC_CHANNEL_NAME
    label: Eventarc channel name
    description: What is the name of the Eventarc channel.
    default: firebase
    type: string
    required: true

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      location: ${param:LOCATION}
      eventTrigger:
        eventType: firebase.extensions.storage-resize-images.v1.complete
        channel: projects/${param:PROJECT_ID}/locations/${param:LOCATION}/channels/${param:EVENTARC_CHANNEL_NAME}