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 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
namestring (wymagany) |
Identyfikator rozszerzenia. Może zawierać tylko małe litery, cyfry i łączniki; limit 40 znaków. Uwaga: ta wartość jest używana do generowania identyfikatora instancji rozszerzenia (który jest następnie używany do generowania nazw kont usługi rozszerzenia i zasobów specyficznych dla rozszerzenia). |
||||||||
versionstring (wymagany) |
Wersja rozszerzenia. Musi być zgodna z wersją semver (np. 1.2.0). |
||||||||
specVersionstring (wymagany) |
Wersja specyfikacji Rozszerzeń w Firebase. Bieżąca wartość: |
||||||||
licensestring (opcjonalnie) |
Licencja na rozszerzenie. Rozszerzenie musi mieć licencję uzyskaną za pomocą |
||||||||
billingRequiredboolean (opcjonalnie) |
Czy usługi używane przez rozszerzenie wymagają płatnego konta rozliczeniowego Firebase. Zawsze ustawiona na |
||||||||
displayNamestring (opcjonalnie) |
Przyjazna nazwa wyświetlana rozszerzenia (3–5 słów). Obowiązuje limit 40 znaków. |
||||||||
descriptionstring (opcjonalnie) |
Krótki opis zadania wykonywanego przez rozszerzenie (ok. 1 zdania). | ||||||||
iconstring (opcjonalnie) |
Plik do użycia jako ikona rozszerzenia w Plik musi być kwadratowym obrazem PNG o rozmiarach od 512 x 512 do 1024 x 1024 piksele.
Umieść plik w tym samym katalogu co Podczas projektowania ikony rozszerzenia pamiętaj o tych wytycznych:
|
||||||||
tagslista 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.
|
||||||||
sourceUrlstring (opcjonalnie) |
Publiczny adres URL, pod którym można uzyskać dostęp do katalogu rozszerzeń. | ||||||||
releaseNotesUrlstring (opcjonalnie) |
Publiczny adres URL, pod którym można znaleźć informacje o wersji rozszerzenia. | ||||||||
authorjeden obiekt author (opcjonalnie) |
Główny autor i osoba kontaktowa rozszerzenia. author: authorName: Your Company email: extensions@example.com url: https://example.com/
|
||||||||
contributorslista obiektów autor (opcjonalnie) |
dodatkowych autorów, którzy przyczynili się do powstania rozszerzenia;
contributors:
- authorName: Your Name
- authorName: Another Contributor
email: colleague@example.net
url: https://github.com/their-org/
|
||||||||
Firebase i interfejsy Google Cloud API
Te pola określają interfejsy Firebase i Google, których używa 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 | |
|---|---|
apiNamestring (wymagany) |
Nazwa interfejsu Google API Musi być zgodny z polem Nazwa usługi na stronie przeglądu każdego interfejsu API (przykład) w bibliotece interfejsów API Google Cloud. |
reasonstring (wymagany) |
krótki opis, dlaczego rozszerzenie musi używać tego interfejsu API; |
Role uprawnień
Te pola określają role Cloud IAM wymagane przez rozszerzenie. Te role są przypisywane do konta usługi utworzonego dla rozszerzenia.
Możesz 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
| Pola roli | |
|---|---|
rolestring (wymagany) |
Nazwa roli uprawnień, która jest wymagana do działania rozszerzenia Musi być jedną z obsługiwanych ról |
reasonstring (wymagany) |
krótki opis, dlaczego rozszerzenie potrzebuje dostępu przyznanego przez tę rolę; |
resourcestring (opcjonalnie) |
Ogranicz zakres roli do tego zasobu. Jeśli go pominiesz, domyślnie tag będzie w wersji VAST 2.0. |
Usługi zewnętrzne
Te pola określają usługi inne niż Firebase i inne niż Google, których używa rozszerzenie (zazwyczaj interfejsy API REST). Platforma Firebase Extensions nie udostępnia żadnych sposobów 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 dotyczące usług zewnętrznych | |
|---|---|
namestring (wymagany) |
Nazwa usługi zewnętrznej, która jest wymagana do działania rozszerzenia. |
pricingUristring (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 | |
|---|---|
paramstring (wymagany) |
Nazwa parametru. Za pomocą tej nazwy możesz odwoływać się do wartości parametru w kodzie. |
labelstring (wymagany) |
Krótki opis parametru. Wyświetla się użytkownikowi, gdy zostanie poproszony o podanie wartości parametru. |
descriptionstring (opcjonalnie) |
Szczegółowy opis parametru. Wyświetla się użytkownikowi, gdy wyświetli się prośba o podanie wartości parametru. Obsługuje Markdown. |
examplestring (opcjonalnie) |
Przykładowa wartość parametru. |
defaultstring (opcjonalnie) |
wartość domyślna parametru, jeśli użytkownik pozostawi jego wartość pustą; |
validationRegexstring (opcjonalnie) |
Wyrażenie regularne służące do sprawdzania wartości parametru skonfigurowanej przez użytkownika. składnia Google RE2. |
validationErrorMessagestring (opcjonalnie) |
Komunikat o błędzie wyświetlany w przypadku nieudanej weryfikacji wyrażenia regularnego. |
requiredboolean (opcjonalnie) |
Określa, czy użytkownik może przesłać pusty ciąg znaków, gdy zostanie poproszony o wartość parametru. Domyślna wartość to true.
|
immutableboolean (opcjonalnie) |
Określa, czy użytkownik może zmienić wartość parametru po instalacji (np. jeśli zmodyfikuje konfigurację rozszerzenia). Domyślna wartość to Uwaga: jeśli zdefiniujesz parametr „location” dla funkcji rozszerzenia, które zostały wdrożone, ustaw to pole na |
typestring (opcjonalnie) |
Typ parametru. Specjalne typy parametrów mogą mieć dodatkowe wymagania lub inną prezentację w interfejsie. Zapoznaj się z sekcjami poniżej. |
Parametry do wyboru i wielokrotnego wyboru
Parametry do wyboru i wielokrotny wybór umożliwiają użytkownikom wybór 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 | |||||||
|---|---|---|---|---|---|---|---|
typeciąg znaków |
Określa, że parametr może mieć jedną wartość ( |
||||||
optionslist of options (wymagany) |
opcje, które użytkownik może wybrać;
|
||||||
Parametry zasobów do wyboru
Parametry z możliwością wyboru umożliwiają użytkownikom wybranie zasobu (instancja bazy danych, zasobnik pamięci itp.) z ich 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 zasobu | |
|---|---|
typeciąg znaków |
Wskazuje, że parametr reprezentuje zasób projektu. |
resourceTypestring (wymagany) |
Typ zasobu, który użytkownik ma wybrać. Prawidłowe wartości:
Obecnie interfejs wyboru mają tylko zasobniki Cloud Storage (inne typy zasobów są przedstawiane jako pola tekstowe do wprowadzania dowolnego tekstu). |
Parametry obiektu tajnego
Wartości tajne podawane przez użytkownika (np. klucze interfejsu API) są obsługiwane inaczej:
- 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 podanie tych wartości, ich dane 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 tajnych | |
|---|---|
typeciąg znaków |
Określa, że parametr jest wartością tajną. |
Zasoby Cloud Functions
Te pola deklarują funkcje Cloud Functions zawarte w rozszerzeniu. Składnia deklaracji zasobów różni się nieco w przypadku funkcji 1 generacji i 2 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 | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
namestring (wymagany) |
Przyjazna dla użytkownika nazwa wyeksportowanej funkcji. Jeśli nie określisz właściwości Ostateczna nazwa wdrożonej funkcji będzie miała format:
|
||||||||||||||||
typestring (wymagany) |
W przypadku zasobu funkcji 1 generacji:firebaseextensions.v1beta.function
|
||||||||||||||||
descriptionstring (wymagany) |
Krótki opis zadania wykonywanego przez funkcję w przypadku rozszerzenia. |
||||||||||||||||
properties(wymagane) |
Właściwości Cloud Functions pierwszej generacji. Najważniejsze właściwości wymieniono poniżej, ale ich pełną listę znajdziesz w dokumentacji Cloud Functions.
|
||||||||||||||||
Cloud Functions (2 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 | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
namestring (wymagany) |
Przyjazna dla użytkownika nazwa wyeksportowanej funkcji. Jeśli nie określisz właściwości Ostateczna nazwa wdrożonej funkcji będzie miała format:
|
||||||||||||||||||||||||||||
typestring (wymagany) |
W przypadku zasobu funkcji 2 generacji:firebaseextensions.v1beta.v2function
|
||||||||||||||||||||||||||||
descriptionstring (wymagany) |
Krótki opis zadania wykonywanego przez funkcję w przypadku rozszerzenia. |
||||||||||||||||||||||||||||
properties(wymagane) |
Właściwości Cloud Functions (2 generacji). Najważniejsze właściwości wymieniono poniżej, ale ich pełną listę znajdziesz w dokumentacji Cloud Functions.
Istnieją też 3 pola typu obiektu z własnymi właściwościami:
|
||||||||||||||||||||||||||||
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ę, która działa, gdy użytkownik zainstaluje rozszerzenie.
|
||||||
onUpdate(opcjonalnie) |
Określa funkcję, która jest wykonywana, gdy użytkownik zaktualizuje rozszerzenie.
|
||||||
onConfigure(opcjonalnie) |
Określa funkcję, która jest wykonywana, gdy użytkownik ponownie skonfiguruje rozszerzenie.
|
||||||
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 | |
|---|---|
typestring (wymagany) |
Identyfikator typu zdarzenia. Utwórz identyfikator z 3–4 oddzielonych kropką pól: identyfikator wydawcy, nazwa rozszerzenia i nazwa zdarzenia są wymagane, pole wersji jest zalecane. Wybierz unikalną i opisową nazwę zdarzenia dla każdego publikowanego typu zdarzenia. |
descriptionstring (wymagany) |
Opis zdarzenia. |