การอ้างอิงสำหรับ extensions.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: [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 และ Google Cloud API

ช่องเหล่านี้ระบุ Firebase และ 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 ไม่มีวิธีเปิดใช้หรือให้สิทธิ์บริการเหล่านี้โดยอัตโนมัติ

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) แตกต่างกันดังนี้

• ระบบจะจัดเก็บค่าข้อมูลลับโดยใช้ Secret Manager ของ Cloud เฉพาะไคลเอ็นต์ที่ได้รับอนุญาตเท่านั้น (เช่น อินสแตนซ์ที่ติดตั้งไว้ของส่วนขยาย) ที่จะเข้าถึงค่าเหล่านี้ได้
• เมื่อระบบแจ้งให้ผู้ใช้ระบุค่าเหล่านี้ ระบบจะไม่แสดงข้อมูลที่ป้อน

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

ทรัพยากร Cloud Function

ช่องเหล่านี้จะประกาศ Cloud Function ที่รวมอยู่ในส่วนขยาย ไวยากรณ์การประกาศทรัพยากรของฟังก์ชันรุ่นที่ 1 และรุ่นที่ 2 จะแตกต่างกันเล็กน้อย ซึ่งสามารถอยู่ร่วมกันได้ในชิ้นงาน

Cloud Functions รุ่นที่ 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

Cloud Functions รุ่นที่ 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

เหตุการณ์ในวงจร

เหตุการณ์ในวงจรช่วยให้คุณระบุฟังก์ชันที่จะทำงานเมื่อผู้ใช้ติดตั้ง อัปเดต หรือกำหนดค่าอินสแตนซ์ของส่วนขยาย ดูจัดการเหตุการณ์ในวงจรชีวิตของส่วนขยาย

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