Dokumentacja rozszerzeniaextension.yaml

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

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

podstawowe informacje i informacje umożliwiające identyfikację;

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/
Pola podstawowe
name
ciąg znaków
(wymagane)

Identyfikator rozszerzenia.

Może zawierać tylko małe litery, cyfry i myślniki. 40 znaków .

Uwaga: ta wartość jest używana do generowania identyfikatora instancji rozszerzenia (który jest następnie używany do generowania nazw konta usługi rozszerzenia i zasobów specyficznych dla rozszerzenia).

version
string
(wymagany)

Wersja rozszerzenia.

Musi być zgodna z obsługą wersji semver (np. 1.2.0).

specVersion
ciąg znaków
(wymagane)

Wersja specyfikacji rozszerzeń w Firebase.

Bieżąca wartość: v1beta

license
string
(opcjonalnie)

Licencja na rozszerzenie.

Rozszerzenie musi być licencjonowane przez: Apache-2.0.

billingRequired
wartość logiczna
(opcjonalnie)

Czy usługi używane przez rozszerzenie wymagają płatnego konta rozliczeniowego Firebase.

Zawsze ustawiona na true.

displayName
ciąg znaków
(opcjonalnie)

Przyjazna wyświetlana nazwa rozszerzenia (3–5 słów).

Limit znaków: 40.

description
string
(opcjonalnie)
Krótki opis zadania wykonywanego przez rozszerzenie (ok. 1 zdanie).
icon
string
(opcjonalnie)

Plik, który będzie używany jako ikona rozszerzenia extensions.dev i w konsoli Firebase.

Plik musi być kwadratowym obrazem PNG o rozmiarach od 512 x 512 do 1024 x 1024 piksele. Umieść plik w tym samym katalogu, w którym znajduje się katalog extension.yaml. Ty nie można określić podkatalogu.

Projektując ikonę dla swojej ikony, pamiętaj o następujących wytycznych: rozszerzenie:

  • Wybierz kolory tła i elementów graficznych odpowiednie dla Twojej marki.
  • Używaj prostych kolorów ikon, używając tylko 2 kolorów. Wiele kolorów może sprawić, że Twoja ikona będzie przytłaczająca.
  • Z tego samego powodu nie używaj w niej gradientów. Gradienty są trudne do rozpoznania przy małym rozmiarze i złożone.
  • Używaj prostych, unikalnych obrazów, które informują o funkcjonalności rozszerzenia.
  • Jeśli Twoja firma tworzy wiele rozszerzeń, nie używaj logo jako ikonę. Użytkownicy będą mieli trudności z odróżnieniem Twoich rozszerzeń.
  • Postaraj się, aby grafika była wyrazista i pogrubiona. Nie używaj delikatnych lub skomplikowanych grafik, które nie będą dobrze wyglądać w mniejszych rozmiarach.
  • Nie używaj słów, które opisują działanie rozszerzenia. Tekst to często nieczytelne przy mniejszych rozmiarach.
tags
lista ciągów znaków
(opcjonalnie)
tagi, które ułatwiają użytkownikom znalezienie rozszerzenia; Te tagi są mapowane na kategorie w Centrum rozszerzeń: marketing, messaging, payments search, shipping, social, utilities, ai
sourceUrl
ciąg znaków
(opcjonalnie)
Publiczny adres URL, pod którym można uzyskać dostęp do katalogu rozszerzeń.
releaseNotesUrl
string
(opcjonalnie)
Publiczny adres URL, pod którym można znaleźć informacje o wersji rozszerzenia.
author
1 obiekt autora
(opcjonalnie)

Główny autor i osoba kontaktowa ds. rozszerzenia.

author:
  authorName: Your Company
  email: extensions@example.com
  url: https://example.com/
Pola autora
authorName
ciąg znaków
(wymagane)

Imię i nazwisko autora.

Może to być osoba, firma, organizacja itp.

email
ciąg znaków
(opcjonalnie)
Adres e-mail autora.
url
ciąg znaków
(opcjonalnie)
Publiczny adres URL, pod którym można uzyskać dostęp do informacji o autorze.
contributors
lista obiektów autor
(opcjonalnie)

Dodatkowych autorów pracujących nad rozszerzeniem.

contributors:
  - authorName: Your Name
  - authorName: Another Contributor
    email: colleague@example.net
    url: https://github.com/their-org/
Pola autora
authorName
ciąg znaków
(wymagane)

Imię i nazwisko autora.

Może to być osoba, firma, organizacja itp.

email
ciąg znaków
(opcjonalnie)
Adres e-mail autora.
url
ciąg znaków
(opcjonalnie)
Publiczny adres URL, pod którym można uzyskać dostęp do informacji o autorze.

Firebase i interfejsy Google Cloud API

Te pola określają interfejsy API Firebase i Google używane przez rozszerzenie. Po zainstalowaniu rozszerzenia użytkownicy mogą automatycznie włączyć te interfejsy 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
Pola interfejsu API
apiName
ciąg znaków
(wymagane)

Nazwa interfejsu API Google

Musi odpowiadać polu Nazwa usługi podaną w każdym Strona przeglądu interfejsu API (przykład) w Biblioteka interfejsów API Google Cloud

reason
ciąg znaków
(wymagane)
krótki opis, dlaczego rozszerzenie musi używać tego interfejsu API;

Role uprawnień

Te pola określają role Cloud IAM wymagane przez rozszerzenie. Usługa konto udostępnione na potrzeby rozszerzenia otrzyma te role.

Możesz podać tylko jeden 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
Pola ról
role
ciąg znaków
(wymagane)

Nazwa roli uprawnień, która jest wymagana do działania rozszerzenia

Musi być jedną z obsługiwanych ról

reason
ciąg znaków
(wymagane)
Krótki opis powodu, dla którego rozszerzenie potrzebuje dostępu przyznanego przez ta rola
resource
ciąg znaków
(opcjonalnie)

Ogranicz zakres roli do tego zasobu.

Jeśli go pominiesz, domyślna wartość to projects/${project_id}. Zapoznaj się z artykułem Ograniczanie zakresu ról.

Usługi zewnętrzne

Te pola określają usługi inne niż Firebase i inne niż Google, których używa rozszerzenie (zwykle interfejsy API REST). Platforma Firebase Extensions nie udostępnia żadnych środków do automatycznego włączania ani autoryzacji tych usług.

externalServices:
  - name: Example API
    pricingUri: https://developers.example.com/pricing
  - name: Another Example API
    pricingUri: https://developers.example.com/pricing
Pola usług zewnętrznych
name
ciąg znaków
(wymagane)
Nazwa zewnętrznej usługi, której potrzebuje rozszerzenie do działania.
pricingUri
string
(wymagany)
Identyfikator URI informacji o cenach usługi

Parametry konfigurowane przez użytkownika

Te pola określają 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
Pola parametrów
param
ciąg znaków
(wymagane)
Nazwa parametru. Ta nazwa służy do odwoływania się do parametru w kodzie.
label
string
(wymagany)
Krótki opis parametru. Wyświetlane użytkownikowi, gdy pojawi się prośba o podanie wartości parametru.
description
string
(opcjonalnie)

Szczegółowy opis parametru. Wyświetla się użytkownikowi, gdy wyświetli się prośba o podanie wartości parametru.

Obsługuje format Markdown.

example
string
(opcjonalnie)
Przykładowa wartość parametru.
default
ciąg znaków
(opcjonalnie)
wartość domyślna parametru, jeśli użytkownik pozostawi jego wartość pustą;
validationRegex
string
(opcjonalnie)
Wyrażenie regularne służące do sprawdzania wartości parametru skonfigurowanej przez użytkownika. Google RE2 .
validationErrorMessage
ciąg znaków
(opcjonalnie)
Komunikat o błędzie wyświetlany w przypadku niepowodzenia weryfikacji wyrażenia regularnego.
required
boolean
(opcjonalnie)
Określa, czy użytkownik może przesłać pusty ciąg znaków, gdy pojawi się prośba o podanie wartości parametru. Domyślna wartość to true.
immutable
boolean
(opcjonalnie)

Określa, czy użytkownik może zmienić wartość parametru po instalacji (np. gdy użytkownik zmieni konfigurację rozszerzenia). Domyślna wartość to false

Uwaga: jeśli zdefiniujesz parametr „location” dla funkcji rozszerzenia, które zostały wdrożone, ustaw to pole na true.

type
ciąg znaków
(opcjonalnie)
Typ parametru. Typy parametrów specjalnych mogą zawierać dodatkowe lub innej prezentacji UI. Zapoznaj się z sekcjami poniżej.

Parametry do wyboru i wielokrotnego wyboru

Parametry do wyboru lub do wyboru informują użytkownika o wyborze z listy wstępnie zdefiniowanych 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
Pola parametrów jednokrotnego wyboru
type
tekst

select lub multiselect

Określa, że parametr może mieć jedną wartość (select) lub kilka wartości (multiselect) wybranych ze zbioru wstępnie zdefiniowane opcje

options
list of options
(wymagany)

Opcje, które użytkownik może wybrać

Pola opcji
value
string
(wymagany)
Jedna z wartości, które może wybrać użytkownik. Oto wartość, jaką zyskujesz .
label
ciąg znaków
(opcjonalnie)
Krótki opis opcji do wyboru. W przypadku pominięcia wartości domyślne do value.

Parametry zasobu do wyboru

Parametry z możliwością wyboru umożliwiają użytkownikom wybranie zasobu (np. instancji bazy danych lub zasobnika) 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
Pola parametrów zasobów
type
tekst

selectresource

Wskazuje, że parametr reprezentuje zasób projektu.

resourceType
ciąg znaków
(wymagane)

Typ zasobu, który użytkownik ma wybrać.

Prawidłowe wartości:

  • storage.googleapis.com/Bucket
  • firestore.googleapis.com/Database
  • firebasedatabase.googleapis.com/DatabaseInstance

Jednak tylko zasobniki Cloud Storage mają obecnie interfejs wyboru (inne typy zasobów są wyświetlane jako pola do wprowadzania tekstu).

Parametry obiektu tajnego

Wartości obiektów tajnych podanych przez użytkownika (na przykład kluczy interfejsu API) są obsługiwane w inny sposób:

  • Wartości tajne są przechowywane w usłudze Cloud Secret Manager. Dostęp do tych wartości mają tylko autoryzowani klienci (np. zainstalowana instancja rozszerzenia).
  • Gdy użytkownicy są proszeni o ich podanie, dane wejściowe nie są wyświetlane.
params:
  - param: PARAM_ID
    label: Short description of the parameter
    description: >-
      What is the secret value?
    type: secret
Pola parametrów obiektu tajnego
type
tekst

secret

Określa, że parametr jest wartością obiektu tajnego

Zasoby w Cloud Functions

Te pola deklarują funkcje w Cloud Functions dostępne w rozszerzeniu. Zasób składnia deklaracji wygląda nieco inaczej w pierwszej i drugiej generacji które mogą współistnieć w rozszerzeniu.

Cloud Functions 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
Pola zasobów
name
ciąg znaków
(wymagane)

Przyjazna dla użytkownika nazwa wyeksportowanej funkcji.

Jeśli nie określisz właściwości entryPoint (zobacz poniżej), ta wartość musi być zgodna z nazwą funkcji w kodu źródłowego funkcji.

Ostateczna nazwa wdrożonej funkcji będzie miała format: ext-extension-instance-id-name.

type
ciąg znaków
(wymagane)
W przypadku zasobu funkcji 1 generacji:firebaseextensions.v1beta.function
description
string
(wymagany)

Krótki opis zadania wykonywanego przez funkcję .

properties
(wymagane)

Usługi w Cloud Functions pierwszej generacji. Najważniejsze właściwości wymieniono poniżej, ale ich pełną listę znajdziesz w dokumentacji funkcji Cloud Functions.

Usługi
location
(opcjonalnie)

Miejsce, w którym chcesz wdrożyć funkcję. Domyślna wartość to:us-central1

entryPoint
(opcjonalnie)
Nazwa wyeksportowanej funkcji w kodzie źródłowym funkcji których ma szukać rozszerzenie. Domyślnie jest ustawiana wartość name (patrz wyżej).
sourceDirectory
(opcjonalnie)

Katalog, który zawiera package.json w pierwiastek. Plik z kodem źródłowym funkcji musi znajdować się w tym katalogu. Domyślna wartość to functions

Uwaga: pole mainpackage.json określa plik kodu źródłowego funkcji (np. index.js).

timeout
(opcjonalnie)

Maksymalny czas wykonania funkcji.

  • Domyślnie: 60s
  • Maksymalna wartość: 540s
availableMemoryMb
(opcjonalnie)

Ilość pamięci dostępnej dla funkcji w MB.

  • Domyślnie: 256
  • Prawidłowe wartości to: 128, 256, 512, 1024 i 2048.
runtime
(zalecane)

Środowisko wykonawcze funkcji.

httpsTrigger
lub
eventTrigger
lub
scheduleTrigger
lub
taskQueueTrigger
(wymagany jest jeden z tych typów reguł funkcji)
Szczegółowe informacje o każdym typie reguły znajdziesz w artykule Tworzenie Cloud Functions dla rozszerzenia.

Cloud Functions 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

Pola zasobów
name
ciąg znaków
(wymagane)

Przyjazna dla użytkownika nazwa wyeksportowanej funkcji.

Jeśli nie określisz właściwości entryPoint (zobacz poniżej), ta wartość musi być zgodna z nazwą funkcji w kodu źródłowego funkcji.

Ostateczna nazwa wdrożonej funkcji będzie miała format: ext-extension-instance-id-name.

type
string
(wymagany)
W przypadku zasobu funkcji 2 generacji:firebaseextensions.v1beta.v2function
description
string
(wymagany)

Krótki opis zadania wykonywanego przez funkcję .

properties
(wymagane)

Właściwości Cloud Functions (2 generacji). Najważniejsze właściwości podane niżej, ale ich pełną listę znajdziesz Chmura Dokumentacja funkcji

Usługi
location
(opcjonalnie)

Lokalizacja, w której funkcja ma zostać wdrożona. Domyślna wartość to us-central1

sourceDirectory
(opcjonalnie)

Katalog, który zawiera package.json w pierwiastek. Plik z kodem źródłowym funkcji musi znajdować się w tym katalogu. Domyślna wartość to functions

Uwaga: pole mainpackage.json określa plik kodu źródłowego funkcji (np. index.js).

Istnieją też 3 pola typu obiektu z własnymi właściwościami:

Właściwości buildConfig
buildConfig.runtime
(zalecane)

Środowisko wykonawcze funkcji.

buildConfig.entryPoint
(opcjonalnie)
Nazwa wyeksportowanej funkcji w kodzie źródłowym funkcji, której rozszerzenie powinno szukać. Domyślnie jest ustawiana wartość name (patrz wyżej).
właściwości serviceConfig
serviceConfig.timeoutSeconds
(opcjonalnie)

Maksymalny czas wykonania funkcji.

  • Domyślnie: 60
  • Maksymalna wartość: 540
serviceConfig.availableMemory
(opcjonalnie)
Ilość pamięci dostępnej dla funkcji. Domyślna wartość to 256M Obsługiwane jednostki to k, M, G, Mi, Gi. Jeśli nie podasz jednostki, wartość zostanie zinterpretowana jako bajty.
właściwości eventTrigger
eventTrigger.eventType
(wymagane)
Typ nasłuchiwanego zdarzenia. Typy zdarzeń dostępne w poszczególnych usługach znajdziesz w artykule Tworzenie funkcji Cloud Functions w rozszerzeniu.
eventTrigger.eventFilters
(opcjonalnie)
Filtry, które dodatkowo ograniczają zdarzenia do nasłuchiwania. Przykład: można było nasłuchiwać tylko zdarzeń pasujących do określonego zasobu wzorcem. Informacje o filtrowaniu poszczególnych typów zdarzeń znajdziesz w artykule Tworzenie funkcji Cloud Functions w rozszerzeniu.
eventTrigger.channel
(opcjonalnie)
Nazwa kanału powiązanego z regułą w projects/{project}/locations/{location}/channels/{channel} . Jeśli pominiesz tę właściwość, funkcja będzie nasłuchiwać na domyślnym kanale projektu.
eventTrigger.triggerRegion
(opcjonalnie)
Reguła będzie otrzymywać tylko zdarzenia pochodzące z tego regionu. Może to być ten sam region co funkcja, inny region, region wielostrefowy lub region globalny. Jeśli nie zostanie podana, domyślna wartość to w tym samym regionie co funkcja.

Zdarzenia cyklu życia

Zdarzenia cyklu życia umożliwiają określenie funkcji, które będą wykonywane, gdy użytkownik zainstaluje, zaktualizuje lub skonfiguruje instancję rozszerzenia. Zobacz, jak obsługiwać zdarzenia 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
Pola zdarzeń cyklu życia
onInstall
(opcjonalnie)

Określa funkcję uruchamianą po zainstalowaniu przez użytkownika .

Specyfikacja funkcji
function
string
(wymagany)

Nazwa funkcji aktywowanej przez kolejkę zadań, która obsługuje do zdarzenia.

Funkcja musi być zadeklarowana w sekcji resources i mieć zdefiniowaną kolejkę zadań taskQueue.

processingMessage
ciąg znaków
(wymagane)
Komunikat wyświetlany w konsoli Firebase podczas wykonywania zadania postęp.
onUpdate
(opcjonalnie)

Określa funkcję uruchamianą, gdy użytkownik aktualizuje .

Specyfikacja funkcji
function
string
(wymagany)

Nazwa funkcji aktywowanej przez kolejkę zadań, która obsługuje do zdarzenia.

Funkcja musi być zadeklarowana w sekcji resources i mieć zdefiniowaną kolejkę zadań taskQueue.

processingMessage
ciąg znaków
(wymagane)
Komunikat wyświetlany w konsoli Firebase podczas wykonywania zadania postęp.
onConfigure
(opcjonalnie)

Określa funkcję, która jest wykonywana, gdy użytkownik ponownie skonfiguruje rozszerzenie.

Specyfikacja funkcji
function
string
(wymagany)

Nazwa funkcji aktywowanej przez kolejkę zadań, która obsługuje do zdarzenia.

Funkcja musi być zadeklarowana w sekcji resources i mieć zdefiniowaną kolejkę zadań taskQueue.

processingMessage
ciąg znaków
(wymagane)
Komunikat wyświetlany w konsoli Firebase podczas wykonywania zadania.

Zdarzenia niestandardowe (Eventarc)

Zdarzenia niestandardowe to zdarzenia emitowane przez Twoje rozszerzenie, które umożliwiają użytkownikom wstawianie do niego własnej logiki. Zobacz sekcję Eventarc w artykule Dodawanie elementów wywołujących w rozszerzeniu.

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
Pola zdarzeń niestandardowych
type
string
(wymagany)
Identyfikator typu zdarzenia. Utwórz identyfikator na skali 3–4 pola rozdzielane kropkami: identyfikator wydawcy, nazwa rozszerzenia i nazwa zdarzenia; pola są wymagane; zalecamy użycie pola wersji. Wybierz unikalną i opisową nazwę zdarzenia dla każdego publikowanego typu zdarzenia.
description
string
(wymagany)
Opis zdarzenia.