مرجع الإضافة.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 التي تستخدمها الإضافة. عندما يثبّت المستخدمون الإضافة، يمكنهم اختيار تمكين واجهات برمجة التطبيقات هذه تلقائيًا في مشروعاتهم.

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

أدوار "إدارة الهوية وإمكانية الوصول"

تحدّد هذه الحقول أدوار 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). لا يوفر نظام إضافات 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

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

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

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

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

موارد Cloud Function

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

وظائف السحابة الإلكترونية من الجيل الأول

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