Tham chiếu cho extension.yaml

Tệp thông số tiện ích mở rộng của bạn ( extension.yaml ) chứa siêu dữ liệu của tiện ích mở rộng của bạn, khai báo các tài nguyên được tạo bởi tiện ích mở rộng và các API cũng như quyền truy cập mà tiện ích mở rộng yêu cầu, đồng thời xác định mọi tham số do người dùng định cấu hình do tiện ích mở rộng cung cấp.

Các bảng trên trang này mô tả các trường có sẵn cho tệp extension.yaml .

Thông tin cơ bản và nhận dạng

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/

API Firebase và Google Cloud

Các trường này chỉ định API Firebase và Google mà tiện ích mở rộng sử dụng. Khi người dùng cài đặt tiện ích mở rộng, họ có thể chọn tự động bật các API này trong dự án của mình.

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

Vai trò IAM

Các trường này chỉ định vai trò Cloud IAM mà tiện ích mở rộng yêu cầu. Tài khoản dịch vụ được cung cấp cho tiện ích mở rộng sẽ được cấp các vai trò này.

Bạn chỉ có thể chỉ định một trong các vai trò được hỗ trợ .

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

Dịch vụ bên ngoài

Các trường này chỉ định các dịch vụ không phải của Firebase và không phải của Google mà tiện ích mở rộng sử dụng (thường là API REST). Nền tảng Tiện ích mở rộng Firebase không cung cấp bất kỳ phương tiện nào để tự động bật hoặc thực hiện ủy quyền cho các dịch vụ này.

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

Các thông số do người dùng cấu hình

Các trường này xác định các tham số mà tiện ích mở rộng cung cấp cho người dùng định cấu hình.

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

Các thông số có thể lựa chọn và đa lựa chọn

Các tham số có thể lựa chọn và nhiều lựa chọn sẽ nhắc người dùng chọn từ danh sách các tùy chọn được xác định trước.

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

Các tham số tài nguyên có thể lựa chọn

Các tham số tài nguyên có thể lựa chọn sẽ nhắc người dùng chọn tài nguyên (phiên bản cơ sở dữ liệu, nhóm lưu trữ, v.v.) từ dự án của họ.

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

Thông số bí mật

Các giá trị bí mật do người dùng cung cấp (chẳng hạn như khóa API) được xử lý khác nhau:

• Các giá trị bí mật được lưu trữ bằng Cloud Secret Manager. Chỉ những khách hàng được ủy quyền (chẳng hạn như phiên bản đã cài đặt của tiện ích mở rộng) mới có thể truy cập các giá trị này.
• Khi người dùng được nhắc cung cấp các giá trị này, thông tin đầu vào của họ sẽ không được hiển thị.

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

Tài nguyên chức năng đám mây

Các trường này khai báo các Chức năng đám mây có trong tiện ích mở rộng. Cú pháp khai báo tài nguyên có vẻ hơi khác một chút giữa các hàm thế hệ 1 và thế hệ 2, những hàm này có thể cùng tồn tại trong một phần mở rộng.

Chức năng đám mây thế hệ 1

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

Chức năng đám mây thế hệ thứ 2

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

Sự kiện vòng đời

Sự kiện vòng đời cho phép bạn chỉ định các chức năng sẽ chạy khi người dùng cài đặt, cập nhật hoặc định cấu hình phiên bản tiện ích mở rộng của bạn. Xem Xử lý các sự kiện trong vòng đời của tiện ích mở rộng của bạ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

Sự kiện tùy chỉnh (Eventarc)

Sự kiện tùy chỉnh là các sự kiện mà tiện ích mở rộng của bạn phát ra để cho phép người dùng chèn logic của riêng họ vào tiện ích mở rộng của bạn. Xem phần Eventarc trong Thêm móc người dùng vào tiện ích mở rộng .

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