Referência para extension.yaml

O arquivo de especificação da sua extensão ( extension.yaml ) contém os metadados da sua extensão, declara os recursos criados pela extensão e as APIs e o acesso exigido pela extensão e define quaisquer parâmetros configurados pelo usuário fornecidos pela extensão.

As tabelas nesta página descrevem os campos disponíveis para um arquivo extension.yaml .

Informações básicas e de identificação

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 Firebase e Google Cloud

Esses campos especificam as APIs do Firebase e do Google que a extensão usa. Quando os usuários instalam a extensão, eles podem optar por ativar automaticamente essas APIs em seus projetos.

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

Funções do IAM

Esses campos especificam os papéis do Cloud IAM exigidos pela extensão. A conta de serviço provisionada para a extensão recebe esses papéis.

Você só pode especificar uma das funções suportadas .

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

Serviços externos

Esses campos especificam os serviços que não são do Firebase e do Google que a extensão usa (normalmente APIs REST). A plataforma Firebase Extensions não fornece nenhum meio de ativar ou realizar autorização automaticamente para esses serviços.

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

Parâmetros configuráveis ​​pelo usuário

Esses campos definem os parâmetros que a extensão disponibiliza para configuração dos usuários.

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 selecionáveis ​​e multisselecionáveis

Parâmetros selecionáveis ​​e multisselecionáveis ​​solicitam que os usuários escolham em uma lista de opções 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 selecionáveis

Parâmetros de recurso selecionáveis ​​solicitam que os usuários selecionem um recurso (instância de banco de dados, intervalo de armazenamento etc.) de seu projeto.

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 secretos

Valores secretos fornecidos pelo usuário (como chaves de API) são tratados de maneira diferente:

• Os valores secretos são armazenados usando o Cloud Secret Manager. Somente clientes autorizados (como uma instância instalada de uma extensão) podem acessar esses valores.
• Quando os usuários são solicitados a fornecer esses valores, suas entradas não são exibidas.

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

Recursos do Cloud Functions

Esses campos declaram o Cloud Functions incluído em uma extensão. A sintaxe da declaração de recurso parece um pouco diferente entre funções de 1ª e 2ª geração, que podem coexistir em uma extensão.

Funções de nuvem de 1ª geração

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

Funções de nuvem de 2ª geração

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 do ciclo de vida

Os eventos de ciclo de vida permitem especificar funções que serão executadas quando um usuário instalar, atualizar ou configurar uma instância da sua extensão. Consulte Tratar os eventos do ciclo de vida da sua extensão .

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)

Eventos personalizados são eventos que sua extensão emite para permitir que os usuários insiram sua própria lógica em sua extensão. Consulte a seção Eventarc em Adicionar ganchos de usuário a uma extensão .

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