एक्सटेंशन के लिए संदर्भ। 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/

फायरबेस और गूगल क्लाउड एपीआई

ये फ़ील्ड एक्सटेंशन द्वारा उपयोग किए जाने वाले फ़ायरबेस और Google 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 भूमिकाएँ निर्दिष्ट करते हैं। विस्तार के लिए प्रावधानित सेवा खाते को ये भूमिकाएँ प्रदान की जाती हैं।

आप समर्थित भूमिकाओं में से केवल एक ही निर्दिष्ट कर सकते हैं.

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

वाह्य सेवाएँ

ये फ़ील्ड उन गैर-फ़ायरबेस और गैर-Google सेवाओं को निर्दिष्ट करते हैं जिनका एक्सटेंशन उपयोग करता है (आमतौर पर REST API)। फायरबेस एक्सटेंशन प्लेटफ़ॉर्म इन सेवाओं के लिए स्वचालित रूप से सक्षम करने या प्राधिकरण निष्पादित करने का कोई साधन प्रदान नहीं करता है।

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

गुप्त पैरामीटर

उपयोगकर्ता द्वारा प्रदत्त गुप्त मान (जैसे एपीआई कुंजियाँ) को अलग तरीके से नियंत्रित किया जाता है:

• गुप्त मान क्लाउड सीक्रेट मैनेजर का उपयोग करके संग्रहीत किए जाते हैं। केवल अधिकृत ग्राहक (जैसे किसी एक्सटेंशन का स्थापित उदाहरण) ही इन मानों तक पहुंच सकते हैं।
• जब उपयोगकर्ताओं को ये मान प्रदान करने के लिए कहा जाता है, तो उनका इनपुट प्रदर्शित नहीं होता है।

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

कस्टम इवेंट (इवेंटार्क)

कस्टम ईवेंट वे ईवेंट हैं जो आपका एक्सटेंशन उपयोगकर्ताओं को आपके एक्सटेंशन में अपना तर्क डालने की अनुमति देने के लिए उत्सर्जित करता है। किसी एक्सटेंशन में उपयोगकर्ता हुक जोड़ें में इवेंटआर्क अनुभाग देखें।

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