आपके एक्सटेंशन की स्पेसिफ़िकेशन फ़ाइल (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/
| बेसिक फ़ील्ड | |||||||||
|---|---|---|---|---|---|---|---|---|---|
nameस्ट्रिंग (ज़रूरी है) |
एक्सटेंशन के लिए आइडेंटिफ़ायर. इसमें सिर्फ़ छोटे अक्षर, संख्याएं, और डैश हो सकते हैं. इसमें 40 से ज़्यादा वर्ण इस्तेमाल नहीं किए जा सकते. ध्यान दें: इस वैल्यू का इस्तेमाल, एक्सटेंशन के इंस्टेंस आईडी को जनरेट करने के लिए किया जाता है. इसके बाद, इसका इस्तेमाल एक्सटेंशन के सेवा खाते और एक्सटेंशन के हिसाब से संसाधनों के नाम जनरेट करने के लिए किया जाता है. |
||||||||
versionस्ट्रिंग (ज़रूरी है) |
एक्सटेंशन का वर्शन. वर्शन के मुताबिक होना ज़रूरी है (उदाहरण के लिए, 1.2.0). |
||||||||
specVersionस्ट्रिंग (ज़रूरी है) |
Firebase एक्सटेंशन की खास बातों का वर्शन. मौजूदा वैल्यू: |
||||||||
licenseस्ट्रिंग (ज़रूरी नहीं) |
एक्सटेंशन का लाइसेंस. आपके एक्सटेंशन का लाइसेंस, |
||||||||
billingRequiredboolean (ज़रूरी नहीं) |
एक्सटेंशन की सेवाओं के लिए, पैसे चुकाकर लिए जाने वाले Firebase बिलिंग खाते की ज़रूरत है या नहीं. हमेशा |
||||||||
displayNameस्ट्रिंग (ज़रूरी नहीं) |
एक्सटेंशन के लिए आसानी से समझ आने वाला डिसप्ले नेम (3 से 5 शब्द). 40 वर्ण की सीमा. |
||||||||
descriptionस्ट्रिंग (ज़रूरी नहीं) |
आपके एक्सटेंशन के किए गए टास्क के बारे में कम शब्दों में जानकारी (~1 वाक्य). | ||||||||
iconस्ट्रिंग (ज़रूरी नहीं) |
यह फ़ाइल, 512x512 और 1024x1024 पिक्सल के बीच की स्क्वेयर PNG फ़ॉर्मैट में होनी चाहिए.
फ़ाइल को अपने एक्सटेंशन के लिए आइकॉन डिज़ाइन करते समय, इन दिशा-निर्देशों का ध्यान रखें:
|
||||||||
tagsस्ट्रिंग की सूची (ज़रूरी नहीं) |
आपका एक्सटेंशन खोजने में उपयोगकर्ताओं की मदद करने के लिए टैग.
ये टैग, एक्सटेंशन हब पर कैटगरी से मैप होते हैं:
marketing,
messaging,
payments,
search,
shipping,
social,
utilities,
ai
|
||||||||
sourceUrlस्ट्रिंग (ज़रूरी नहीं) |
वह सार्वजनिक यूआरएल जहां एक्सटेंशन डायरेक्ट्री को ऐक्सेस किया जा सकता है. | ||||||||
releaseNotesUrlस्ट्रिंग (ज़रूरी नहीं) |
वह सार्वजनिक यूआरएल जहां एक्सटेंशन के रिलीज़ नोट ऐक्सेस किए जा सकते हैं. | ||||||||
authorएक लेखक ऑब्जेक्ट (ज़रूरी नहीं) |
एक्सटेंशन का मुख्य लेखक और संपर्क करने के लिए मुख्य व्यक्ति. author: authorName: Your Company email: extensions@example.com url: https://example.com/
|
||||||||
contributorsauthor ऑब्जेक्ट की सूची (ज़रूरी नहीं) |
एक्सटेंशन में योगदान देने वाले अन्य लेखक. 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
| एपीआई फ़ील्ड | |
|---|---|
apiNameस्ट्रिंग (ज़रूरी है) |
Google API का नाम Google Cloud API Library में, हर एपीआई की खास जानकारी देने वाले पेज (उदाहरण) पर दी गई सेवा का नाम फ़ील्ड के मुताबिक होना चाहिए |
reasonस्ट्रिंग (ज़रूरी है) |
इस बारे में खास जानकारी कि एक्सटेंशन को इस एपीआई का इस्तेमाल क्यों करना है |
आईएएम की भूमिकाएं
इन फ़ील्ड से उन 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
| भूमिका वाले फ़ील्ड | |
|---|---|
roleस्ट्रिंग (ज़रूरी है) |
एक्सटेंशन के काम करने के लिए ज़रूरी IAM भूमिका का नाम |
reasonस्ट्रिंग (ज़रूरी है) |
इस बारे में कम शब्दों में जानकारी दें कि एक्सटेंशन को इस भूमिका से मिले ऐक्सेस की ज़रूरत क्यों है |
resourceस्ट्रिंग (ज़रूरी नहीं) |
भूमिका के दायरे को इस संसाधन तक सीमित करें. अगर यह वैल्यू नहीं दी गई है, तो डिफ़ॉल्ट रूप से |
बाहरी सेवाएं
इन फ़ील्ड से पता चलता है कि एक्सटेंशन, 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
| बाहरी सेवाओं के फ़ील्ड | |
|---|---|
nameस्ट्रिंग (ज़रूरी है) |
एक्सटेंशन के काम करने के लिए ज़रूरी बाहरी सेवा का नाम |
pricingUriस्ट्रिंग (ज़रूरी है) |
सेवा की कीमत की जानकारी का यूआरआई |
उपयोगकर्ता के कॉन्फ़िगर किए जा सकने वाले पैरामीटर
ये फ़ील्ड उन पैरामीटर के बारे में बताते हैं जिन्हें एक्सटेंशन, उपयोगकर्ताओं के लिए कॉन्फ़िगर करने के लिए उपलब्ध कराता है.
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
| पैरामीटर फ़ील्ड | |
|---|---|
paramस्ट्रिंग (ज़रूरी है) |
पैरामीटर का नाम. कोड में पैरामीटर की वैल्यू का रेफ़रंस देने के लिए, इस नाम का इस्तेमाल किया जाता है. |
labelस्ट्रिंग (ज़रूरी है) |
पैरामीटर के बारे में कम शब्दों में जानकारी. उपयोगकर्ता को तब दिखाया जाता है, जब उनसे पैरामीटर की वैल्यू पूछी जाती है. |
descriptionस्ट्रिंग (ज़रूरी नहीं) |
पैरामीटर के बारे में पूरी जानकारी. उपयोगकर्ता को तब दिखाया जाता है, जब उससे पैरामीटर की वैल्यू पूछी जाती है. Markdown का इस्तेमाल किया जा सकता है. |
exampleस्ट्रिंग (ज़रूरी नहीं) |
पैरामीटर के लिए वैल्यू का उदाहरण. |
defaultस्ट्रिंग (ज़रूरी नहीं) |
अगर उपयोगकर्ता पैरामीटर की वैल्यू को खाली छोड़ देता है, तो पैरामीटर की डिफ़ॉल्ट वैल्यू. |
validationRegexस्ट्रिंग (ज़रूरी नहीं) |
पैरामीटर की उपयोगकर्ता से कॉन्फ़िगर की गई वैल्यू की पुष्टि करने के लिए रेगुलर एक्सप्रेशन. Google RE2 का सिंटैक्स. |
validationErrorMessageस्ट्रिंग (ज़रूरी नहीं) |
रेगुलर एक्सप्रेशन की पुष्टि न हो पाने पर दिखने वाला गड़बड़ी का मैसेज. |
requiredboolean (ज़रूरी नहीं) |
इससे यह तय होता है कि पैरामीटर की वैल्यू के लिए कहा जाने पर, उपयोगकर्ता खाली स्ट्रिंग सबमिट कर सकता है या नहीं. डिफ़ॉल्ट रूप से, यह true पर सेट होती है.
|
immutableboolean (ज़रूरी नहीं) |
इससे यह तय होता है कि उपयोगकर्ता, इंस्टॉलेशन के बाद पैरामीटर की वैल्यू
बदल सकता है या नहीं (जैसे, अगर वह एक्सटेंशन को फिर से कॉन्फ़िगर करता है). डिफ़ॉल्ट तौर पर, यह ध्यान दें: अगर आपने अपने एक्सटेंशन के डिप्लॉय किए गए फ़ंक्शन के लिए "जगह" पैरामीटर तय किया है, तो इस फ़ील्ड को |
typeस्ट्रिंग (ज़रूरी नहीं) |
पैरामीटर टाइप. खास पैरामीटर टाइप के लिए, अतिरिक्त ज़रूरी शर्तें या यूज़र इंटरफ़ेस (यूआई) का अलग तरीका हो सकता है. यहां दिए गए सेक्शन देखें. |
चुने जा सकने वाले और एक से ज़्यादा विकल्प चुनने की सुविधा वाले पैरामीटर
चुने जा सकने वाले और एक से ज़्यादा विकल्प चुनने वाले पैरामीटर, उपयोगकर्ताओं को पहले से तय विकल्पों की सूची में से चुनने के लिए कहते हैं.
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
| एक से ज़्यादा विकल्प वाले पैरामीटर फ़ील्ड | |||||||
|---|---|---|---|---|---|---|---|
typeस्ट्रिंग |
इससे पता चलता है कि पैरामीटर में एक वैल्यू ( |
||||||
optionsविकल्पों की सूची (ज़रूरी है) |
ऐसे विकल्प जिनमें से उपयोगकर्ता कोई विकल्प चुन सकता है
|
||||||
चुने जा सकने वाले संसाधन पैरामीटर
चुने जा सकने वाले संसाधन पैरामीटर से, उपयोगकर्ताओं को उनके प्रोजेक्ट से कोई संसाधन (डेटाबेस इंस्टेंस, स्टोरेज बकेट वगैरह) चुनने के लिए कहा जाता है.
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
| रिसॉर्स पैरामीटर फ़ील्ड | |
|---|---|
typeस्ट्रिंग |
इससे पता चलता है कि पैरामीटर किसी प्रोजेक्ट के संसाधन को दिखाता है |
resourceTypeस्ट्रिंग (ज़रूरी है) |
वह संसाधन टाइप जिसे उपयोगकर्ता को चुनने के लिए कहा जाएगा. मान्य मान:
हालांकि, फ़िलहाल सिर्फ़ Cloud Storage बकेट के लिए, चुनने का यूज़र इंटरफ़ेस (यूआई) उपलब्ध है. अन्य तरह के संसाधनों को फ़्री फ़ॉर्म टेक्स्ट इनपुट फ़ील्ड के तौर पर दिखाया जाता है. |
सीक्रेट पैरामीटर
उपयोगकर्ता से मिली गोपनीय वैल्यू (जैसे, एपीआई कुंजियां) को अलग तरीके से मैनेज किया जाता है:
- सीक्रेट वैल्यू, Cloud Secret Manager का इस्तेमाल करके स्टोर की जाती हैं. सिर्फ़ अनुमति वाले क्लाइंट (जैसे कि किसी एक्सटेंशन का इंस्टॉल किया गया इंस्टेंस) इन वैल्यू को ऐक्सेस कर सकते हैं.
- जब उपयोगकर्ताओं से ये वैल्यू देने के लिए कहा जाता है, तो उनका इनपुट नहीं दिखाया जाता.
params:
- param: PARAM_ID
label: Short description of the parameter
description: >-
What is the secret value?
type: secret
| गुप्त पैरामीटर फ़ील्ड | |
|---|---|
typeस्ट्रिंग |
यह बताता है कि पैरामीटर एक गोपनीय वैल्यू है |
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
| संसाधन फ़ील्ड | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nameस्ट्रिंग (ज़रूरी है) |
एक्सपोर्ट किए गए फ़ंक्शन के लिए, उपयोगकर्ता के हिसाब से आसान नाम. अगर आपने डिप्लॉय किए गए फ़ंक्शन का आखिरी नाम, इस फ़ॉर्मैट में होगा:
|
||||||||||||||||
typeस्ट्रिंग (ज़रूरी है) |
पहले जनरेशन के फ़ंक्शन के संसाधन के लिए:
firebaseextensions.v1beta.function
|
||||||||||||||||
descriptionस्ट्रिंग (ज़रूरी है) |
इस बारे में कम शब्दों में जानकारी कि एक्सटेंशन के लिए फ़ंक्शन क्या काम करता है. |
||||||||||||||||
properties(ज़रूरी है) |
पहले-जीन Cloud Functions प्रॉपर्टी. सबसे ज़रूरी प्रॉपर्टी के बारे में यहां बताया गया है. हालांकि, Cloud Functions के रेफ़रंस में पूरी सूची देखी जा सकती है.
|
||||||||||||||||
दूसरे-जीनरेशन के 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
| संसाधन फ़ील्ड | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nameस्ट्रिंग (ज़रूरी है) |
एक्सपोर्ट किए गए फ़ंक्शन के लिए, उपयोगकर्ता के हिसाब से आसान नाम. अगर आपने डिप्लॉय किए गए फ़ंक्शन का आखिरी नाम, इस फ़ॉर्मैट में होगा:
|
||||||||||||||||||||||||||||
typeस्ट्रिंग (ज़रूरी है) |
दूसरे जनरेशन के फ़ंक्शन के संसाधन के लिए:
firebaseextensions.v1beta.v2function
|
||||||||||||||||||||||||||||
descriptionस्ट्रिंग (ज़रूरी है) |
इस बारे में कम शब्दों में जानकारी कि एक्सटेंशन के लिए फ़ंक्शन क्या काम करता है. |
||||||||||||||||||||||||||||
properties(ज़रूरी है) |
दूसरे-जीन की Cloud Functions प्रॉपर्टी. सबसे अहम प्रॉपर्टी यहां दी गई हैं. हालांकि, इनकी पूरी सूची Cloud फ़ंक्शन के रेफ़रंस में देखी जा सकती है.
ऑब्जेक्ट-टाइप के तीन फ़ील्ड भी होते हैं, जिनकी अपनी प्रॉपर्टी होती हैं:
|
||||||||||||||||||||||||||||
लाइफ़साइकल इवेंट
लाइफ़साइकल इवेंट की मदद से, ऐसे फ़ंक्शन तय किए जा सकते हैं जो उपयोगकर्ता के आपके एक्सटेंशन के इंस्टेंस को इंस्टॉल करने, अपडेट करने या कॉन्फ़िगर करने पर चलेंगे. अपने एक्सटेंशन के लाइफ़साइकल इवेंट मैनेज करना लेख पढ़ें.
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
| लाइफ़साइकल इवेंट फ़ील्ड | |||||||
|---|---|---|---|---|---|---|---|
onInstall(ज़रूरी नहीं) |
यह एक फ़ंक्शन तय करता है, जो उपयोगकर्ता के एक्सटेंशन इंस्टॉल करने पर चलता है.
|
||||||
onUpdate(ज़रूरी नहीं) |
इस नीति से एक फ़ंक्शन के बारे में पता चलता है, जो तब चलता है, जब कोई उपयोगकर्ता एक्सटेंशन को अपडेट करता है.
|
||||||
onConfigure(ज़रूरी नहीं) |
इस एट्रिब्यूट से उस फ़ंक्शन के बारे में पता चलता है जो उपयोगकर्ता के एक्सटेंशन को फिर से कॉन्फ़िगर करने पर चलता है.
|
||||||
कस्टम इवेंट (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
| कस्टम इवेंट फ़ील्ड | |
|---|---|
typeस्ट्रिंग (ज़रूरी है) |
इवेंट का टाइप आइडेंटिफ़ायर. बिंदु से अलग किए गए तीन से चार फ़ील्ड से आइडेंटिफ़ायर बनाएं: पब्लिशर आईडी, एक्सटेंशन का नाम, और इवेंट का नाम फ़ील्ड ज़रूरी हैं; वर्शन फ़ील्ड का सुझाव दिया जाता है. पब्लिश किए जाने वाले हर इवेंट टाइप के लिए, यूनीक और जानकारी देने वाला इवेंट नाम चुनें. |
descriptionस्ट्रिंग (ज़रूरी है) |
इवेंट के बारे में जानकारी. |