یک افزونه Firebase نصب کنید

می‌توانید هر یک از برنامه‌های افزودنی رسمی Firebase را با استفاده از کنسول Firebase یا Firebase CLI (واسط خط فرمان) نصب کنید (و مدیریت کنید).

مطمئن شوید که تفاوت‌های عملکردهای پشتیبانی‌شده برای Firebase CLI و Firebase کنسول را بررسی کرده‌اید.

برای نصب یا مدیریت برنامه‌های افزودنی، باید یکی از این نقش‌ها به شما اختصاص داده شود: مالک یا ویرایشگر یا مدیر Firebase .

برای نصب افزونه، پروژه شما باید در طرح Blaze (پرداخت در حین حرکت) باشد. اگرچه هزینه ای برای نصب برنامه افزودنی دریافت نمی شود، ممکن است برای استفاده از خدمات Firebase یا سرویس های Cloud مانند [Cloud Secret Manager][secret-pricing] هزینه ای دریافت کنید، اگر میزان استفاده شما از سطح رایگان سرویس ها بیشتر شود.

قبل از اینکه شروع کنی

1. اگر قبلاً این کار را نکرده‌اید، Firebase را به پروژه خود اضافه کنید .

2. اگر قبلاً این کار را نکرده‌اید، پروژه خود را به طرح Blaze ارتقا دهید.

3. آخرین نسخه Firebase CLI را نصب یا به‌روزرسانی کنید.

4. به شناسه پروژه Firebase یا نام مستعار پروژه پیکربندی شده قبلی خود توجه داشته باشید.

   • شناسه پروژه - firebase projects:list از هر نقطه از رایانه خود اجرا کنید.
   • نام مستعار پروژه - firebase use را از فهرست برنامه محلی خود اجرا کنید.

مرحله 1 : اطلاعات دقیق در مورد یک برنامه افزودنی را مشاهده کنید

این مرحله اختیاری است، اما به شدت توصیه می شود.

قبل از نصب افزونه Firebase، توصیه می‌کنیم اطلاعات دقیق در مورد افزونه را بررسی کنید، از جمله:

• نحوه کار برنامه افزودنی، هرگونه کار پیش از نصب، و جزئیات مربوط به برنامه افزودنی
• اطلاعات شناسایی عمومی و توضیحات
• آیا وظایف برنامه افزودنی به حساب صورت‌حساب نیاز دارد
• سرویس‌های Google (API) و دسترسی به نقش‌های مورد نیاز برای عملیات
• منابع ایجاد شده برای برنامه افزودنی (مانند توابع)
• توضیحات پارامترهای قابل تنظیم توسط کاربر

برای مشاهده اطلاعات دقیق یک برنامه افزودنی:

1. مطمئن شوید که محیط خود را تنظیم کرده اید و یک برنامه افزودنی را انتخاب کرده اید.

2. دستور extension-info را از هر نقطه از رایانه خود اجرا کنید:

   firebase ext:info publisher-id/extension-id

   publisher-id extension-id الزامی است و می‌توانید آن را در صفحه جزئیات نصب پیش‌نصب برنامه افزودنی پیدا کنید .

مرحله 2 : یک افزونه را نصب کنید

در طول فرآیند نصب، از شما خواسته می‌شود که مشخصات اولیه برنامه افزودنی (مانند API‌های فعال، منابع ایجاد شده، دسترسی اعطا شده و غیره) را بررسی کنید. در مورد هر گونه الزامات صورتحساب به شما اطلاع داده می شود و همچنین از شما خواسته می شود مقادیری را برای پارامترهای قابل تنظیم برنامه افزودنی مشخص کنید.

1. مطمئن شوید که محیط خود را تنظیم کرده اید و یک برنامه افزودنی را انتخاب کرده اید.

2. دستور extension-install را اجرا کنید. اگر از شما خواسته شد، مقادیر پارامتر را برای سفارشی کردن نمونه برنامه افزودنی وارد کنید.

   firebase ext:install publisher-id/extension-id --project=projectId-or-alias

   publisher-id extension-id الزامی است و می‌توانید آن را در صفحه جزئیات نصب پیش‌نصب برنامه افزودنی پیدا کنید .

   در حین نصب، از دستورات ترمینال تعاملی برای مقادیر پارامتر عبور کنید

   1. یک فایل .env ایجاد کنید (به عنوان مثال، params.env ) که مقادیر پارامتر شما را تعریف می کند. فایل را به صورت محلی ذخیره کنید.

      • هر پارامتر را با مقدار param موجود در فایل extension.yaml اعلام کنید.
      • شامل مقادیر برای تمام پارامترها.
      • دستور dotenv را دنبال کنید.

      به عنوان مثال، برای پسوند Translate Text ، می توانید این فایل .env را ایجاد کنید:

      # params.env
      
      LOCATION=us-east1
      LANGUAGES=fr,es
      COLLECTION_PATH=translations
      INPUT_FIELD_NAME=input
      OUTPUT_FIELD_NAME=output
      

   2. دستور extension-install را با پرچم --params کنید. به عنوان مثال، برای نصب پسوند Translate Text ، دستور زیر را اجرا کنید:

      firebase ext:install firebase/firestore-translate-text --params=path/to/params.env --project=projectID-or-alias

مرحله 3 : راه اندازی پس از نصب را کامل کنید

برخی از برنامه‌های افزودنی دارای مراحل لازم یا اختیاری هستند که باید قبل از استفاده از آنها تکمیل کنید. این دستورالعمل ها را در صفحه جزئیات پس از نصب برنامه افزودنی خود در داشبورد Extensions کنسول Firebase بیابید (پیوند خاص داشبورد پس از نصب در ترمینال نمایش داده می شود).

همچنین می‌توانید این دستورالعمل‌ها را در فایل POSTINSTALL.md موجود در فهرست منبع برنامه افزودنی بیابید.

منابع Firebase را ایجاد کنید

اگر افزونه را برای استفاده از منابع Firebase (مجموعه‌های Cloud Firestore، مسیرهای پایگاه داده بی‌درنگ، سطل‌های Cloud Storage) که قبلاً وجود ندارند، پیکربندی کرده‌اید، قبل از استفاده از برنامه افزودنی، آنها را ایجاد کنید.

کنترل کننده رویداد Eventarc را ایجاد کنید

برخی از برنامه‌های افزودنی زمانی که رویدادهای مهم در حین اجرا اتفاق می‌افتند، در Eventarc منتشر می‌شوند. اگر یک برنامه افزودنی رویدادها را منتشر می کند و شما رویدادها را در حین نصب فعال کرده اید، می توانید توابعی بنویسید که با منطق سفارشی خود به این رویدادها واکنش نشان می دهند. این می تواند مفید باشد، به عنوان مثال، برای اطلاع دادن به کاربران هنگام تکمیل وظایف طولانی مدت، یا برای پس پردازش خروجی یک تابع برنامه افزودنی.

برای مشاهده لیست رویدادهایی که منتشر می کند (در صورت وجود) به مستندات برنامه افزودنی مراجعه کنید.

سپس، برای اطلاعات در مورد نوشتن کنترل کننده رویداد Eventarc، به محرک های رویداد سفارشی مراجعه کنید.

چند نمونه برنامه افزودنی را نصب کنید

شما می توانید یک افزونه را بیش از یک بار در همان پروژه نصب کنید. هر نمونه نصب شده می تواند پیکربندی سفارشی شده و منابع برنامه افزودنی خود را داشته باشد. شما هر نمونه نصب شده را با استفاده از شناسه نمونه آن شناسایی کرده و به آن ارجاع می دهید که در پروژه شما منحصر به فرد است. از شما خواسته می شود شناسه نمونه هر نمونه اضافی از برنامه افزودنی را که نصب می کنید تأیید یا ویرایش کنید.

مراحل بعدی

• جزئیات و پیکربندی افزونه نصب شده خود را در کنسول Firebase مشاهده کنید.

• فعالیت برنامه افزودنی نصب شده خود، از جمله بررسی سلامت، استفاده و گزارش‌های آن را نظارت کنید.

• با استفاده از Firebase CLI، برنامه افزودنی نصب شده خود را مدیریت کنید. می توانید برنامه افزودنی خود را مجددا پیکربندی یا حذف نصب کنید و همچنین برنامه افزودنی خود را به آخرین نسخه به روز کنید.

• با استفاده از کنسول Firebase، برنامه افزودنی نصب شده خود را مدیریت کنید. برای افزونه‌های رسمی Firebase، می‌توانید برنامه افزودنی خود را مجدداً پیکربندی یا حذف نصب کنید، و همچنین برنامه افزودنی خود را به آخرین نسخه به‌روزرسانی کنید.

• به عنوان بهترین روش برای همه پروژه ها، مطمئن شوید که هشدارهای بودجه را برای پروژه خود تنظیم کرده و داشبورد استفاده و صورتحساب خود را در کنسول Firebase نظارت کنید.