Odniesienie do extension.yaml

Plik specyfikacji rozszerzenia ( extension.yaml ) zawiera metadane rozszerzenia, deklaruje zasoby utworzone przez rozszerzenie oraz interfejsy API i dostęp wymagany przez rozszerzenie, a także definiuje wszelkie parametry konfigurowane przez użytkownika udostępniane przez rozszerzenie.

Tabele na tej stronie opisują pola dostępne dla pliku extension.yaml .

Informacje podstawowe i identyfikacyjne

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/

Interfejsy API Firebase i Google Cloud

Te pola określają interfejsy API Firebase i Google, z których korzysta rozszerzenie. Gdy użytkownicy instalują rozszerzenie, mogą wybrać automatyczne włączenie tych interfejsów API w swoim projekcie.

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

Role IAM

Te pola określają role Cloud IAM wymagane przez rozszerzenie. Konto usługi udostępnione dla rozszerzenia otrzymuje te role.

Można określić tylko jedną z obsługiwanych ról .

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

Usługi zewnętrzne

Te pola określają usługi inne niż Firebase i inne niż Google, z których korzysta rozszerzenie (zwykle interfejsy API REST). Platforma Firebase Extensions nie zapewnia żadnych możliwości automatycznego włączania lub wykonywania autoryzacji dla tych usług.

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

Parametry konfigurowane przez użytkownika

Pola te definiują parametry, które rozszerzenie udostępnia użytkownikom do konfiguracji.

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

Parametry do wyboru i wielokrotnego wyboru

Parametry do wyboru i wielokrotnego wyboru zachęcają użytkowników do wyboru z listy predefiniowanych opcji.

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

Możliwość wyboru parametrów zasobów

Możliwość wyboru parametrów zasobów zachęca użytkowników do wybrania zasobu (instancji bazy danych, zasobnika pamięci itp.) z projektu.

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

Tajne parametry

Tajne wartości podane przez użytkownika (takie jak klucze API) są obsługiwane w różny sposób:

• Wartości tajne są przechowywane przy użyciu Cloud Secret Manager. Dostęp do tych wartości mają tylko autoryzowani klienci (tacy jak zainstalowana instancja rozszerzenia).
• Gdy użytkownicy zostaną poproszeni o podanie tych wartości, wprowadzone przez nich dane nie będą wyświetlane.

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

Zasoby funkcji chmury

W tych polach deklarowane są funkcje chmury zawarte w rozszerzeniu. Składnia deklaracji zasobów wygląda nieco inaczej w przypadku funkcji pierwszej i drugiej generacji, które mogą współistnieć w rozszerzeniu.

Funkcje chmury pierwszej generacji

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

Funkcje chmury drugiej generacji

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

Wydarzenia cyklu życia

Zdarzenia cyklu życia pozwalają określić funkcje, które będą uruchamiane, gdy użytkownik zainstaluje, zaktualizuje lub skonfiguruje wystąpienie Twojego rozszerzenia. Zobacz Obsługa zdarzeń cyklu życia rozszerzenia .

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

Zdarzenia niestandardowe (Eventarc)

Zdarzenia niestandardowe to zdarzenia emitowane przez rozszerzenie, aby umożliwić użytkownikom wstawienie własnej logiki do rozszerzenia. Zobacz sekcję Eventarc w Dodawanie haków użytkownika do rozszerzenia .

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