Tài liệu tham khảo cho extensions.yaml

Tệp thông số kỹ thuật của tiện ích (extension.yaml) chứa siêu dữ liệu của tiện ích, khai báo các tài nguyên do tiện ích tạo ra cũng như các API và quyền truy cập mà tiện ích yêu cầu, đồng thời xác định mọi tham số do người dùng định cấu hình mà tiện ích 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à thông tin 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: [email protected]
  url: https://example.com/
contributors:
  - authorName: Your Name
  - authorName: Another Contributor
    email: [email protected]
    url: https://github.com/their-org/

author:
  authorName: Your Company
  email: [email protected]
  url: https://example.com/

contributors:
  - authorName: Your Name
  - authorName: Another Contributor
    email: [email protected]
    url: https://github.com/their-org/

Firebase và API Google Cloud

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

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ò trong IAM

Các trường này chỉ định các vai trò Cloud IAM mà tiện ích yêu cầu. Tài khoản dịch vụ được cấp cho tiện ích 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 Firebase và không phải của Google mà tiện ích sử dụng (thường là API REST). Nền tảng Tiện ích Firebase không cung cấp bất kỳ phương thức nào để tự động bật hoặc thực hiện uỷ 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

Tham số có thể định cấu hình bởi người dùng

Các trường này xác định các tham số mà tiện ích 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

Thông số có thể chọn và có thể chọn nhiều

Thông số có thể chọn và nhiều thông số có thể chọn sẽ nhắc người dùng chọn trong danh sách các tuỳ 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

Thông số tài nguyên có thể chọn

Các tham số tài nguyên có thể chọn sẽ nhắc người dùng chọn một tài nguyên (phiên bản cơ sở dữ liệu, bộ chứa 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

Tham số bí mật

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

• Các giá trị bí mật được lưu trữ bằng Trình quản lý bí mật trên đám mây. Chỉ các ứng dụng được uỷ quyền (chẳng hạn như một phiên bản đã cài đặt của tiện ích) mới có thể truy cập vào các giá trị này.
• Khi người dùng được nhắc cung cấp các giá trị này, dữ liệu đầu vào của họ sẽ không 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 của Cloud Functions

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

Hàm đám mây thế hệ thứ nhất

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 thế hệ 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 trong vòng đời

Sự kiện vòng đời cho phép bạn chỉ định các hàm sẽ chạy khi người dùng cài đặt, cập nhật hoặc định cấu hình một thực thể của tiện ích. Xem phần Xử lý các sự kiện trong vòng đời của tiện ích.

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 tuỳ chỉnh (Eventarc)

Sự kiện tuỳ chỉnh là những sự kiện mà tiện ích của bạn tạo ra để cho phép người dùng chèn logic của riêng họ vào tiện ích. Xem phần Eventarc trong bài viết Thêm trình bổ trợ người dùng vào tiện ích.

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