extension.yaml에 대한 참조

확장 프로그램의 사양 파일(extension.yaml)은 확장 프로그램의 메타데이터를 포함하고, 확장 프로그램에서 생성한 리소스와 확장 프로그램에 필요한 API 및 액세스를 선언하고, 확장 프로그램에서 제공하는 사용자 구성 매개변수를 정의합니다.

이 페이지의 표에서는 extension.yaml 파일에 사용할 수 있는 필드를 설명합니다.

기본 및 식별 정보

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/

Firebase API 및 Google Cloud API

이 필드는 확장 프로그램에서 사용하는 Firebase API 및 Google API를 지정합니다. 사용자는 확장 프로그램을 설치할 때 프로젝트에서 이러한 API를 자동으로 사용 설정하도록 선택할 수 있습니다.

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

IAM 역할

이 필드는 확장 프로그램에 필요한 Cloud IAM 역할을 지정합니다. 확장 프로그램에 프로비저닝된 서비스 계정에는 이러한 역할이 부여됩니다.

지원되는 역할 중 하나만 지정할 수 있습니다.

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

외부 서비스

이 필드는 확장 프로그램에서 사용하는 Firebase 이외의 서비스와 Google 이외의 서비스(일반적으로 REST API)를 지정합니다. Firebase Extensions 플랫폼은 이러한 서비스를 자동으로 사용 설정하거나 승인할 수 있는 방법을 제공하지 않습니다.

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

사용자가 구성할 수 있는 매개변수

이 필드는 확장 프로그램에서 사용자가 구성할 수 있는 매개변수를 정의합니다.

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

선택 가능한 매개변수 및 다중 선택 가능한 매개변수

선택 가능한 매개변수 및 다중 선택 가능한 매개변수는 사용자에게 사전 정의된 옵션 목록에서 선택하라는 메시지를 표시합니다.

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

선택 가능한 리소스 매개변수

선택 가능한 리소스 매개변수는 사용자에게 프로젝트에서 리소스(데이터베이스 인스턴스, 스토리지 버킷 등)를 선택하라는 메시지를 표시합니다.

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

보안 비밀 매개변수

사용자가 제공한 보안 비밀 값(예: API 키)은 다르게 처리됩니다.

• 보안 비밀 값은 Cloud Secret Manager를 사용하여 저장됩니다. 승인된 클라이언트(예: 확장 프로그램의 설치된 인스턴스)만 이러한 값에 액세스할 수 있습니다.
• 사용자에게 이러한 값을 입력하라는 메시지가 표시될 때 입력 내용은 표시되지 않습니다.

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

Cloud 함수 리소스

이러한 필드는 확장 프로그램에 포함된 Cloud Functions를 선언합니다. 리소스 선언 구문은 확장 프로그램에서 공존할 수 있는 1세대 함수와 2세대 함수 간에 약간 다르게 보입니다.

1세대 Cloud Functions

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

2세대 Cloud Functions

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

수명 주기 이벤트

수명 주기 이벤트를 사용하면 사용자가 확장 프로그램의 인스턴스를 설치, 업데이트, 구성할 때 실행할 함수를 지정할 수 있습니다. 확장 프로그램의 수명 주기 이벤트 처리를 참조하세요.

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

커스텀 이벤트(Eventarc)

커스텀 이벤트는 사용자가 확장 프로그램에 자체 로직을 삽입할 수 있도록 확장 프로그램에서 내보내는 이벤트입니다. 확장 프로그램에 사용자 후크 추가에서 Eventarc 섹션을 참조하세요.

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