extensions.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 API

इन फ़ील्ड से एक्सटेंशन के ज़रिए इस्तेमाल होने वाले Firebase और 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

आईएएम की भूमिकाएं

इन फ़ील्ड से, एक्सटेंशन के लिए ज़रूरी क्लाउड आईएएम की भूमिकाओं के बारे में पता चलता है. एक्सटेंशन के लिए प्रावधान किए गए सेवा खाते को ये भूमिकाएं दी जाती हैं.

इस्तेमाल की जा सकने वाली भूमिकाओं में से सिर्फ़ एक भूमिका तय की जा सकती है.

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

सीक्रेट पैरामीटर

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

• सीक्रेट वैल्यू, Cloud Secret Manager का इस्तेमाल करके स्टोर की जाती हैं. सिर्फ़ अनुमति वाले क्लाइंट (जैसे कि किसी एक्सटेंशन का इंस्टॉल किया गया इंस्टेंस) इन वैल्यू को ऐक्सेस कर सकते हैं.
• जब उपयोगकर्ताओं से ये वैल्यू डालने के लिए कहा जाता है, तो उनके इनपुट नहीं दिखाए जाते हैं.

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

Cloud Function के संसाधन

ये फ़ील्ड, एक्सटेंशन में शामिल Cloud Functions का एलान करते हैं. 1st-gen और 2nd-gen फ़ंक्शन के बीच रिसॉर्स के एलान का सिंटैक्स थोड़ा अलग दिखता है, जो किसी एक्सटेंशन में एक साथ रह सकता है.

1st-gen Cloud के फ़ंक्शन

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

2nd-gen क्लाउड फ़ंक्शन

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