Bir uzantı için Cloud Functions yazma

Bir uzantı oluşturduğunuzda mantığını Cloud Functions kullanarak yazarsınız. Bu, yalnızca kendi projenizde kullanılacak bir işlev yazmaya benzer. İşlevlerinizi extension.yaml dosyasında tanımlarsınız ve kullanıcılar uzantınızı yüklediğinde bu işlevler projelerine dağıtılır.

Cloud Functions kullanımıyla ilgili genel bilgiler için Cloud Functions dokümanlarına bakın.

1. ve 2. nesil Cloud Functions

Firebase, hem 1. nesil hem de 2. nesilCloud Functions destekler. Ancak Firebase Uzantıları, belirli tetikleyici türleriyle hangi nesil bulut işlevini kullanabileceğiniz konusunda şu anda bazı kısıtlamalara sahiptir. Bu nedenle, birçok uzantı 1. ve 2. nesil işlevlerin bir karışımını içerir.

İşlev oluşturma desteği, her tetikleyici türü için aşağıda belirtilmiştir.

Dikkat edilmesi gereken noktalar

  • Bazı işlev tanımları, extension.yaml dosyasında da belirtilen bilgileri girmenizi gerektirir. Örneğin, Cloud Firestore'da izlenecek belge kalıbını belirten bir document() yöntemi vardır ve extension.yaml içindeki karşılık gelen bildiriminde aynı şeyi belirten bir resource alanı bulunur.

    Bu durumlarda, extension.yaml dosyasında belirtilen yapılandırma kullanılır ve işlev tanımında belirtilen yapılandırma yoksayılır.

    Belgeleme amacıyla, yapılandırılan değerin işlev tanımında belirtilmesi yaygın bir uygulamadır. Bu sayfadaki örnekler bu kalıba uyar.

  • 1. nesil SDK'da, 1. nesil işlevlerde parametreli değerlerle çalışmak için kullanabileceğiniz bir Cloud Functions 1st gen SDK has a functions.config() yöntemi ve functions:config:set CLI komutu bulunur. Bu teknik Cloud Functions sürümünde kullanımdan kaldırıldı ve uzantılarda hiç çalışmayacak. Bunun yerine functions.params modülünü (önerilir) veya process.env kullanın.

TypeScript'i kullanma

Kendi uzantınızı geliştirme ile ilgili dokümanların çoğunda, Cloud Functions for Firebase için JavaScript kullanılan iş akışları açıklanmaktadır. Ancak bunun yerine işlevlerinizi TypeScript kullanarak yazabilirsiniz.

Hatta tüm resmi Firebase uzantılar TypeScript ile yazılır. Uzantınızda TypeScript kullanmayla ilgili bazı en iyi uygulamalar için bu uzantıları inceleyebilirsiniz.

Uzantınızın işlevlerini TypeScript ile yazarsanız uzantınızı yüklemeden önce aşağıdakileri yapmanız gerekir:

  1. Uzantınızın işlev kaynak kodunu JavaScript'e derleyin.

    firebase ext:dev:init komutu işlevlerinizi yazmak için TypeScript'i seçmenize olanak tanır. Bu komut, kurulabilir bir uzantının yanı sıra npm run build ile çalıştırabileceğiniz bir derleme komut dosyası sağlar.

  2. package.json dosyanızda, main alanının oluşturulan JavaScript'i işaret ettiğinden emin olun.

  3. Uzantınızı yerel kaynaktan yüklüyorsanız veya kuruyorsanız önce TypeScript dosyalarınızı derleyin.

Desteklenen işlev tetikleyicileri

HTTP tetikleyicileri

HTTP tetikli bir işlev, herkese açık bir https uç noktasına dağıtılır ve uç noktaya erişildiğinde çalışır.

HTTP tetiklenmiş işlevler yazma hakkında bilgi edinmek için Cloud Functions dokümanlarındaki HTTP istekleriyle işlevleri çağırma bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (extension.yaml)

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

Çağrılabilir işlevler

Çağrılabilir işlevler, HTTP tarafından tetiklenen işlevlere benzer ancak istemci tarafı kodunuzdan kolayca çağrılabilmelerini sağlayan bir protokol uygular.

Çağrılabilir işlevleri kullanma hakkında bilgi edinmek için Cloud Functions dokümanlarındaki Uygulamanızdan işlev çağırma bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (extension.yaml)

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

Planlanmış işlev tetikleyicileri

Planlanmış bir işlev, özelleştirilebilir bir programa göre tekrar tekrar çalışır.

Planlanmış işlevler yazma hakkında bilgi edinmek için Cloud Functions dokümanlarındaki İşlevleri planlama bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (extension.yaml)

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

scheduleTrigger için kullanılabilen alt alanlar şunlardır:

Alan Açıklama
schedule
(zorunlu)

İşlevin çalıştırılmasını istediğiniz sıklık.

Bu alan, her iki sözdizimini de kullanan dizeleri kabul edebilir (tek tırnak içine alma zorunludur):
timeZone
(isteğe bağlı)

Programın çalışacağı saat dilimi.

Kullanıcıların, uzantınızı yüklediklerinde programı yapılandırabilmesini istiyorsanız extension.yaml dosyanıza yeni bir parametre ekleyin ve işlevinizin resource bildiriminde parametreye referans verin:

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

Görev sırası tetikleyicileri

Görev sırası işlevi, uzantınızın yaşam döngüsü etkinliklerinde tetiklenir veya Admin SDK'nın TaskQueue.enqueue() yöntemi kullanılarak uzantınızın görev sırasına manuel olarak eklendiğinde tetiklenir.

Yaşam döngüsü etkinliklerini işleyen işlevler yazma hakkında bilgi edinmek için Uzantınızın yaşam döngüsü etkinliklerini işleme başlıklı makaleyi inceleyin.

Görev sırası işlevleri yazma hakkında bilgi için Cloud Functions dokümanlarındaki Cloud Tasks ile işlevleri sıraya alma bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (extension.yaml)

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

taskQueueTrigger özelliğini {} olarak veya görev kuyruğunun hız sınırlarını ve yeniden deneme davranışını ayarlayan bir seçenekler haritası olarak ayarlayın (bkz. Görev kuyruğunu ayarlama).

İşlevinizi uzantınızın yaşam döngüsü etkinliklerinde tetiklemek istiyorsanız işlevin adını ve isteğe bağlı bir işleme mesajını içeren lifecycleEvents kayıtları ekleyin. Bu mesaj, işleme başladığında Firebase konsolunda gösterilir.

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 tarafından tetiklenen bir işlev, belirtilen bir Analytics etkinliği kaydedildiğinde çalışır.

Analytics tarafından tetiklenen işlevler yazma hakkında bilgi edinmek için Cloud Functions belgelerindeki Google Analytics tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (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: ...

Kullanıcıların, uzantınızı yüklediklerinde dinlenecek Analytics etkinliğini yapılandırabilmesini istiyorsanız extension.yaml dosyanıza yeni bir parametre ekleyin ve işlevinizin resource bildiriminde parametreye referans verin:

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

Kimlik doğrulama tarafından tetiklenen bir işlev, kullanıcı oluşturulduğunda veya silindiğinde çalışır.

Kimlik doğrulama tetikleyicili işlevler yazma hakkında bilgi için Cloud Functions belgelerindeki Firebase Authentication tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

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

Kaynak bildirimi (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: ...

Aşağıdaki tabloda, desteklenen Authentication etkinlik türlerinin her birinin nasıl belirtileceği gösterilmektedir:

Cloud Functions etkinlik tetikleyici eventType Açıklama
onCreate() providers/firebase.auth/eventTypes/user.create Yeni kullanıcı oluşturuldu
onDelete() providers/firebase.auth/eventTypes/user.delete Kullanıcı silindi

Cloud Firestore

Cloud Firestore tarafından tetiklenen bir işlev, doküman oluşturulduğunda, güncellendiğinde veya silindiğinde çalışır.

Firestore tarafından tetiklenen işlevler yazma hakkında bilgi için Cloud Functions belgelerindeki Cloud Firestore tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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.
    // ...
  });

Kaynak bildirimi (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: ...

Aşağıdaki tabloda, desteklenen Cloud Firestore etkinlik türlerinin nasıl belirtileceği gösterilmektedir:

Cloud Functions etkinlik tetikleyici eventType Açıklama
onCreate() providers/cloud.firestore/eventTypes/document.create Yeni doküman oluşturuldu
onDelete() providers/cloud.firestore/eventTypes/document.delete Doküman silindi
onUpdate() providers/cloud.firestore/eventTypes/document.update Doküman güncellendi
onWrite() providers/cloud.firestore/eventTypes/document.write Doküman oluşturulduğunda, silindiğinde veya güncellendiğinde

Kullanıcıların uzantınızı yüklerken doküman yolunu yapılandırabilmesini istiyorsanız extension.yaml dosyanıza yeni bir parametre ekleyin ve işlevinizin resource bildiriminde parametreye referans verin:

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 tarafından tetiklenen işlevler, belirli bir konuya mesaj yayınlandığında çalışır.

Pub/Sub tarafından tetiklenen işlevler yazma hakkında bilgi için Cloud Functions belgelerindeki Pub/Sub tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (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: ...

Kullanıcıların uzantınızı yüklerken Pub/Sub konusunu yapılandırabilmesini istiyorsanız extension.yaml dosyanıza yeni bir parametre ekleyin ve işlevinizin resource bildiriminde parametreye referans verin:

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 tarafından tetiklenen bir işlev, belirtilen bir kalıpla eşleşen bir yol oluşturulduğunda, güncellendiğinde veya silindiğinde çalışır.

RTDB tetiklenmiş işlevler yazma hakkında bilgi için Cloud Functions belgelerindeki Realtime Database tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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.
    // ...
  });

Kaynak bildirimi (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: ...

Aşağıdaki tabloda, desteklenen Cloud Firestore etkinlik türlerinin nasıl belirtileceği gösterilmektedir:

Cloud Functions etkinlik tetikleyici eventType Açıklama
onCreate() providers/google.firebase.database/eventTypes/ref.create Veri oluşturuldu
onDelete() providers/google.firebase.database/eventTypes/ref.delete Veriler silindi
onUpdate() providers/google.firebase.database/eventTypes/ref.update Veriler güncellendi
onWrite() providers/google.firebase.database/eventTypes/ref.write Oluşturulan, silinen veya güncellenen veriler

Kullanıcıların uzantınızı yüklerken izlenecek yolu yapılandırabilmesini istiyorsanız extension.yaml dosyanıza yeni bir parametre ekleyin ve işlevinizin resource bildiriminde parametreye referans verin:

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

Remote Config tarafından tetiklenen bir işlev, projenin parametre şablonu güncellendiğinde çalışır.

Remote Config ile tetiklenen işlevler yazma hakkında bilgi edinmek için Cloud Functions belgelerindeki Remote Config tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (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 tarafından tetiklenen işlevler, bir nesne oluşturulduğunda, arşivlendiğinde veya silindiğinde ya da meta verileri değiştiğinde çalışır.

Storage tarafından tetiklenen işlevler yazma hakkında bilgi edinmek için Cloud Functions belgelerindeki Cloud Storage tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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) => {
  // ...
});

Kaynak bildirimi (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: ...

Aşağıdaki tabloda, desteklenen Cloud Storage etkinlik türlerinin nasıl belirtileceği gösterilmektedir:

Cloud Functions etkinlik tetikleyici eventType Açıklama
onFinalize() google.storage.object.finalize Nesne oluşturuldu
onMetadataUpdate() google.storage.object.metadataUpdate Nesne meta verileri güncellendi
onArchive() google.storage.object.archive Nesne arşivlendi
onDelete() google.storage.object.delete Nesne silindi

Kullanıcıların, uzantınızı yüklerken depolama paketini yapılandırabilmesini istiyorsanız extension.yaml dosyanıza yeni bir parametre ekleyin ve parametreyi işlevinizin resource bildiriminde referans olarak kullanın:

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 tarafından tetiklenen bir işlev, test matrisi testlerini tamamladığında çalışır.

Test Lab tarafından tetiklenen işlevler yazma hakkında bilgi edinmek için Cloud Functions dokümanlarındaki Firebase Test Lab tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 1. nesil)

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

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

Kaynak bildirimi (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 uyarı tetikleyicileri

Crashlytics tarafından tetiklenen bir işlev, Crashlytics bir uyarı yayınladığında çalışır.

Uyarı tetiklemeli işlevler yazma hakkında bilgi için Cloud Functions belgelerindeki Firebase uyarı tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 2. nesil)

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) => {
  // ...
});

Kaynak bildirimi (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 için aşağıdaki değerleri kullanabilirsiniz.

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

Performance Monitoring uyarı tetikleyicileri

Performance Monitoring tetiklemeli bir işlev, Performance Monitoring bir uyarı yayınladığında çalışır.

Uyarı tetiklemeli işlevler yazma hakkında bilgi için Cloud Functions belgelerindeki Firebase uyarı tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 2. nesil)

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

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

Kaynak bildirimi (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 uyarı tetikleyicileri

App Distribution tetiklemeli bir işlev, App Distribution bir uyarı yayınladığında çalışır.

Uyarı tetiklemeli işlevler yazma hakkında bilgi için Cloud Functions belgelerindeki Firebase uyarı tetikleyicileri bölümüne bakın.

İşlev tanımı (yalnızca 2. nesil)

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

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

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

Kaynak bildirimi (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 için aşağıdaki değerleri kullanabilirsiniz.

  • appDistribution.newTesterIosDevice
  • appDistribution.inAppFeedback

Özel etkinlik tetikleyicileri (Eventarc)

Eventarc tarafından tetiklenen bir işlev, belirli bir etkinlik türü belirli bir kanalda yayınlandığında çalışır.

Eventarc tarafından tetiklenen işlevler yazma hakkında bilgi edinmek için Cloud Functions dokümanlarındaki Özel etkinlik tetikleyicileri oluşturma ve işleme başlıklı makaleyi inceleyin.

Ayrıca, kullanıcıların uzantınıza özel mantık eklemesini sağlamak için uzantılarınızdaki etkinlikleri yayınlayabilirsiniz. Uzantıda geliştirici tarafından sağlanan özel mantığı kullanma başlıklı makaleyi inceleyin.

İşlev tanımı (yalnızca 2. nesil)

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

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

Kaynak bildirimi (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: ...

Uzantınız yüklendiğinde kanalın mevcut olması gerekir. Örneğin, kanalı oluşturan başka bir uzantıdaki özel etkinliklere bağlıysanız kullanıcılarınıza önce bu uzantıyı yüklemelerini söyleyin.

Yukarıdaki örnek, us-central1 bölgesindeki "default" Firebase kanalı için özel bir etkinlik tetikleyicisi oluşturur. Parametreleri kullanarak kanal adını ve bölgeyi özelleştirebilirsiniz. Örneğin:


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}