extension.yaml এর জন্য রেফারেন্স

আপনার এক্সটেনশনের স্পেসিফিকেশন ফাইল ( extension.yaml ) আপনার এক্সটেনশনের মেটাডেটা ধারণ করে, এক্সটেনশনের দ্বারা তৈরি সংস্থান এবং API এবং এক্সটেনশনের জন্য প্রয়োজনীয় অ্যাক্সেস ঘোষণা করে এবং এক্সটেনশন দ্বারা প্রদত্ত যেকোন ব্যবহারকারী-কনফিগার করা প্যারামিটারগুলিকে সংজ্ঞায়িত করে৷

এই পৃষ্ঠার টেবিলগুলি 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 APIগুলি নির্দিষ্ট করে৷ যখন ব্যবহারকারীরা এক্সটেনশন ইনস্টল করেন, তখন তারা তাদের প্রকল্পে এই 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 ভূমিকা

এই ক্ষেত্রগুলি এক্সটেনশনের জন্য প্রয়োজনীয় ক্লাউড 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)। 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

গোপন পরামিতি

ব্যবহারকারী-প্রদত্ত গোপন মান (যেমন API কী) ভিন্নভাবে পরিচালনা করা হয়:

• ক্লাউড সিক্রেট ম্যানেজার ব্যবহার করে গোপন মান সংরক্ষণ করা হয়। শুধুমাত্র অনুমোদিত ক্লায়েন্টরা (যেমন একটি এক্সটেনশনের ইনস্টল করা উদাহরণ) এই মানগুলি অ্যাক্সেস করতে পারে।
• যখন ব্যবহারকারীদের এই মানগুলি প্রদান করার জন্য অনুরোধ করা হয়, তখন তাদের ইনপুট প্রদর্শিত হয় না।

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

ক্লাউড ফাংশন সম্পদ

এই ক্ষেত্রগুলি একটি এক্সটেনশনে অন্তর্ভুক্ত ক্লাউড ফাংশনগুলি ঘোষণা করে৷ রিসোর্স ডিক্লেয়ারেশন সিনট্যাক্স 1st-gen এবং 2nd-gen ফাংশনের মধ্যে একটু আলাদা দেখায়, যা একটি এক্সটেনশনে সহাবস্থান করতে পারে।

১ম-জেনার ক্লাউড ফাংশন

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