Referencia de extension.yaml

El archivo de especificación de tu extensión (extension.yaml) contiene los metadatos de tu extensión, declara los recursos que creó la extensión y las APIs, así como el acceso que requiere la extensión, y define cualquier parámetro configurado por el usuario que proporcionó la extensión.

En las tablas de esta página, se describen los campos disponibles para un archivo extension.yaml.

Información básica y de identificación

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/

APIs de Firebase y Google Cloud

Estos campos especifican las APIs de Firebase y Google que usa la extensión. Cuando los usuarios instalan la extensión, pueden habilitar automáticamente estas APIs en tu proyecto.

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

Roles de IAM

Estos campos especifican los roles de Cloud IAM que requiere la extensión. La cuenta de servicio aprovisionada para la extensión recibe estos roles.

Solo puedes especificar uno de los roles admitidos.

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

Servicios externos

Estos campos especifican los servicios que no son de Firebase ni de Google que usa la extensión (por lo general, las APIs de REST). La plataforma de Extensiones de Firebase no proporciona ningún medio para habilitar o realizar la autorización automáticamente para estos servicios.

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

Parámetros configurables por el usuario

Estos campos definen los parámetros que la extensión pone a disposición de los usuarios para su configuración.

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

Parámetros seleccionables y multiseleccionables

Los parámetros seleccionables y seleccionables permiten a los usuarios elegir de una lista de opciones predefinidas.

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

Parámetros de recursos seleccionables

Los parámetros de recursos seleccionables requieren que los usuarios seleccionen un recurso (instancia de base de datos, bucket de almacenamiento, etc.) de su proyecto.

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

Parámetros del Secret

Los valores del Secret proporcionados por el usuario (como las claves de API) se manejan de manera diferente:

• Los valores del Secret se almacenan con Cloud Secret Manager. Solo los clientes autorizados (como una instancia instalada de una extensión) pueden acceder a estos valores.
• Cuando se les solicita a los usuarios que proporcionen estos valores, no se muestra su entrada.

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

Recursos de Cloud Function

Estos campos declaran las funciones de Cloud Functions incluidas en una extensión. La sintaxis de la declaración de recursos se ve un poco diferente entre las funciones de 1ª y 2ª gen., que pueden coexistir en una extensión.

Cloud Functions de 1ª gen.

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

Cloud Functions de 2ª gen.

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

Eventos del ciclo de vida

Los eventos del ciclo de vida te permiten especificar funciones que se ejecutarán cuando un usuario instale, actualice o configure una instancia de tu extensión. Consulta la sección Controla los eventos del ciclo de vida de tu extensió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

Eventos personalizados (Eventarc)

Los eventos personalizados son aquellos que emite tu extensión para permitir que los usuarios inserten su propia lógica en ella. Consulta la sección de Eventarc en Agrega hooks de usuario a una extensió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