مرجع للتمديد. yaml

يحتوي ملف مواصفات الامتداد الخاص بك ( extension.yaml ) على البيانات التعريفية لامتدادك، ويعلن عن الموارد التي تم إنشاؤها بواسطة الامتداد وواجهات برمجة التطبيقات والوصول الذي يتطلبه الامتداد، ويحدد أي معلمات تم تكوينها بواسطة المستخدم يوفرها الامتداد.

تصف الجداول الموجودة في هذه الصفحة الحقول المتاحة لملف 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 وGoogle Cloud APIs

تحدد هذه الحقول واجهات برمجة تطبيقات Firebase وGoogle التي يستخدمها الامتداد. عندما يقوم المستخدمون بتثبيت الامتداد، يمكنهم اختيار تمكين واجهات برمجة التطبيقات هذه تلقائيًا في مشروعهم.

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 APIs). لا يوفر نظام 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

المعلمات السرية

يتم التعامل مع القيم السرية التي يقدمها المستخدم (مثل مفاتيح واجهة برمجة التطبيقات) بشكل مختلف:

• يتم تخزين القيم السرية باستخدام Cloud Secret Manager. يمكن فقط للعملاء المعتمدين (مثل المثيل المثبت للملحق) الوصول إلى هذه القيم.
• عندما يُطلب من المستخدمين تقديم هذه القيم، لا يتم عرض مدخلاتهم.

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

موارد وظيفة السحابة

تعلن هذه الحقول عن وظائف السحابة المضمنة في الامتداد. يبدو بناء جملة إعلان المورد مختلفًا قليلاً بين وظائف الجيل الأول والثاني، والتي يمكن أن تتواجد معًا في الامتداد.

وظائف السحابة من الجيل الأول

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

وظائف السحابة من الجيل الثاني

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