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 के एपीआई

इन फ़ील्ड से उन 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

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

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

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

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

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

Cloud Functions के संसाधन

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

पहले-जीनरेशन के Cloud Functions

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

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