extension.yaml için referans

Uzantınızın belirtim dosyası ( extension.yaml ) uzantınızın meta verilerini içerir, uzantı tarafından oluşturulan kaynakları, API'leri ve uzantının gerektirdiği erişimi bildirir ve uzantı tarafından sağlanan kullanıcı tarafından yapılandırılan parametreleri tanımlar.

Bu sayfadaki tablolar extension.yaml dosyası için mevcut alanları açıklamaktadır.

Temel ve tanımlayıcı bilgiler

name: your-extension-name
version: 1.0.0         # Semantic versioning (semver)
specVersion: v1beta    # Always "v1beta"
license: Apache-2.0    # Always "Apache-2.0" (required to publish on extensions.dev)
billingRequired: true  # Always "true"

displayName: Your extension name
description: >-
  Description of the extension. (One or two
  sentences.)
icon: icon.png
tags: [tag, anothertag]

sourceUrl: https://github.com/your-org/your-repo   # GitHub repo URL
releaseNotesUrl: https://github.com/your-org/your-repo/blob/main/CHANGELOG.md

author:
  authorName: Your Company
  email: extensions@example.com
  url: https://example.com/
contributors:
  - authorName: Your Name
  - authorName: Another Contributor
    email: colleague@example.net
    url: https://github.com/their-org/

author:
  authorName: Your Company
  email: extensions@example.com
  url: https://example.com/

contributors:
  - authorName: Your Name
  - authorName: Another Contributor
    email: colleague@example.net
    url: https://github.com/their-org/

Firebase ve Google Cloud API'leri

Bu alanlar, uzantının kullandığı Firebase ve Google API'lerini belirtir. Kullanıcılar uzantıyı yüklediğinde bu API'leri projelerinde otomatik olarak etkinleştirmeyi seçebilirler.

apis:
  - apiName: apiname.googleapis.com
    reason: Explanation of why the extension uses this API
  - apiName: anotherapiname.googleapis.com
    reason: Explanation of why the extension uses this API

IAM rolleri

Bu alanlar, uzantının gerektirdiği Cloud IAM rollerini belirtir. Uzantı için sağlanan hizmet hesabına bu roller verilir.

Desteklenen rollerden yalnızca birini belirtebilirsiniz.

roles:
  - role: product.role
    reason: Explanation of why the extension needs this level of access
  - role: anotherproduct.role
    resource: projects/${project_id}/resource_type/*
    reason: Explanation of why the extension needs this level of access

Dış Hizmetler

Bu alanlar, uzantının kullandığı Firebase dışı ve Google dışı hizmetleri (genellikle REST API'leri) belirtir. Firebase Extensions platformu, bu hizmetleri otomatik olarak etkinleştirmeye veya yetkilendirmeyi gerçekleştirmeye yönelik herhangi bir araç sağlamaz.

externalServices:
  - name: Example API
    pricingUri: https://developers.example.com/pricing
  - name: Another Example API
    pricingUri: https://developers.example.com/pricing

Kullanıcı tarafından yapılandırılabilen parametreler

Bu alanlar, uzantının kullanıcıların yapılandırmasına sunduğu parametreleri tanımlar.

params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      What do you want to set PARAM_ID to?
      This is a longer description of the parameter, often phrased as a prompt
      to the user.
  - param: ANOTHER_PARAM_ID
    label: Short description of the parameter
    description: >
      What do you want to set ANOTHER_PARAM_ID to?
      This is a longer description of the parameter.
    example: example-input
    validationRegex: "^[a-zA-Z][a-zA-Z-]*[a-zA-Z]?$"
    validationErrorMessage:
      Must be a hyphen-delimited string of alphabetic characters
    default: default-value
    required: false
    immutable: true

Seçilebilir ve çoklu seçilebilir parametreler

Seçilebilir ve çoklu seçilebilir parametreler, kullanıcıları önceden tanımlanmış seçenekler listesinden seçim yapmaya yönlendirir.

params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      Do you want to enable the option?
    type: select
    options:
      - label: Yes
        value: true
      - label: No
        value: false
  - param: ANOTHER_PARAM_ID
    label: Short description of the parameter
    description: >-
      Which options do you want to enable?
    type: multiselect
    options:
      - value: red
      - value: green
      - value: blue

Seçilebilir kaynak parametreleri

Seçilebilir kaynak parametreleri, kullanıcılardan projelerinden bir kaynak (veritabanı örneği, depolama grubu vb.) seçmelerini ister.

params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      Which resource do you want to use?
    type: selectresource
    resourceType: product.googleapis.com/ResourceType

Gizli parametreler

Kullanıcı tarafından sağlanan gizli değerler (API anahtarları gibi) farklı şekilde işlenir:

• Gizli değerler Cloud Secret Manager kullanılarak depolanır. Yalnızca yetkili istemciler (bir uzantının yüklü örneği gibi) bu değerlere erişebilir.
• Kullanıcılardan bu değerleri sağlamaları istendiğinde girişleri görüntülenmez.

params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      What is the secret value?
    type: secret

Bulut İşlevi kaynakları

Bu alanlar, bir uzantıya dahil edilen Bulut İşlevlerini bildirir. Kaynak bildirimi sözdizimi, bir uzantıda bir arada bulunabilen 1. nesil ve 2. nesil işlevler arasında biraz farklı görünür.

1. Nesil Bulut İşlevleri

resources:
  - name: functionName
    type: firebaseextensions.v1beta.function
    description: >-
      Description of what the function does. (One or two
      sentences.)
    properties:
      runtime: runtime-version
      eventTrigger:
        eventType: google.product.event
        resource: projects/_/resource/specifier

2. Nesil Bulut İşlevleri

resources:
  - name: functionName
    type: firebaseextensions.v1beta.v2function
    description: >-
      Description of what the function does. (One or two
      sentences.)
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: crashlytics.newFatalIssue

Yaşam döngüsü etkinlikleri

Yaşam döngüsü etkinlikleri, bir kullanıcı uzantınızın bir örneğini yüklediğinde, güncellediğinde veya yapılandırdığında çalışacak işlevleri belirtmenize olanak tanır. Uzantınızın yaşam döngüsü olaylarını yönetme konusuna bakın.

lifecycleEvents:
  onInstall:
    function: myTaskFunction
    processingMessage: Describes the task being completed
  onUpdate:
    function: myOtherTaskFunction
    processingMessage: Describes the task being completed
  onConfigure:
    function: myOtherTaskFunction
    processingMessage: Describes the task being completed

Özel etkinlikler (Eventarc)

Özel etkinlikler, kullanıcıların uzantınıza kendi mantıklarını eklemelerine olanak sağlamak için uzantınızın yayınladığı etkinliklerdir. Bir uzantıya kullanıcı kancaları ekleme bölümündeki Eventarc bölümüne bakın.

events:
  - type: publisher-id.extension-name.version.event-name
    description: Description of the event
  - type: publisher-id.extension-name.version.another-event-name
    description: Description of the other event