افزونه های Google Workspace را بسازید

این صفحه مروری بر نحوه طراحی، ساخت و انتشار افزونه‌های Google Workspace ارائه می‌دهد. این مرور کلی مراحل زیر را توضیح می‌دهد:

  1. برنامه‌های Google Workspace را که می‌خواهید افزونه شما در دسترس کاربران قرار گیرد، تعیین کنید.
  2. پروژه‌های افزونه خود را تنظیم کنید و یک مالک و همکاران انتخاب کنید.
  3. ظاهر و رفتار افزونه خود را طراحی و پیکربندی کنید.
  4. افزونه را بسازید.
  5. دامنه‌های OAuth افزونه‌ی خود را تأیید کنید.
  6. افزونه را در یک یا چند برنامه Google Workspace آزمایش کنید.
  7. افزونه را منتشر کنید.

شما می‌توانید با Apps Script یا HTTP یک افزونه بسازید. برای مقایسه، ویدیوی «Apps Script در مقابل HTTP endpoints: کدام را باید انتخاب کنید؟ 🤔» را تماشا کنید.

برنامه‌های میزبان Google Workspace را انتخاب کنید

می‌توانید افزونه‌های Google Workspace را طوری پیکربندی کنید که در برنامه‌های میزبان Google Workspace زیر نمایش داده شوند:

  • جیمیل
  • تقویم گوگل
  • گوگل چت
  • اسناد گوگل
  • گوگل درایو
  • گوگل میت
  • صفحات گوگل
  • اسلایدهای گوگل

برای آشنایی با نحوه ساخت برنامه‌های Google Workspace، به Extend the Google Workspace UI مراجعه کنید.

پروژه‌های افزونه خود را تنظیم کنید و یک مالک و همکاران انتخاب کنید

اگر افزونه خود را با زبان Apps Script بسازید، هم یک پروژه Apps Script و هم یک پروژه Google Cloud ایجاد می‌کنید. اگر افزونه خود را با زبانی غیر از Apps Script بسازید، فقط باید یک پروژه Google Cloud ایجاد کنید.

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

پروژه‌های اسکریپت برنامه‌ها

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

شما می‌توانید فایل‌های پروژه اسکریپت برنامه‌های افزونه خود را در یک درایو مشترک ایجاد کنید تا هیچ حساب کاربری مالکیت انحصاری نداشته باشد. قرار دادن فایل اسکریپت افزونه در یک درایو مشترک، دسترسی چندین همکار به پروژه اسکریپت را تضمین می‌کند.

وقتی افزونه‌ای منتشر می‌کنید، یک حساب کاربری به عنوان ناشر عمل می‌کند. حساب کاربری منتشرکننده باید دسترسی ویرایش به پروژه اسکریپت را داشته باشد، اما نیازی نیست که مالک آن باشد.

برای ایجاد یک پروژه اسکریپت برنامه‌ها، به پروژه‌های اسکریپت مراجعه کنید.

پروژه‌های ابری گوگل

توصیه می‌کنیم که همکارانی را به پروژه ابری افزونه اضافه کنید . این کار به شما کمک می‌کند تا مطمئن شوید که یکی از اعضای تیم شما همیشه می‌تواند به تنظیمات ابری افزونه دسترسی داشته باشد.

برای ایجاد یک پروژه گوگل کلود، به ایجاد یک پروژه گوگل کلود مراجعه کنید.

ظاهر و رفتار افزونه خود را طراحی و پیکربندی کنید

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

برای راهنمایی در مورد نحوه طراحی تجربه کاربری افزونه، به راهنمای سبک افزونه Google Workspace مراجعه کنید.

پیکربندی مانیفست افزونه

بعد از اینکه افزونه خود را طراحی کردید، می‌توانید شروع به پیاده‌سازی طراحی در مانیفست افزونه کنید. مانیفست جایی است که بیشتر ظاهر و رفتار افزونه، از جمله برنامه‌های میزبان Google Workspace که افزونه از آنها پشتیبانی می‌کند را پیکربندی می‌کنید.

برای جزئیات بیشتر، به افزونه‌ی Manifests for Google Workspace مراجعه کنید.

همانطور که کد و ویژگی‌هایی را به افزونه خود اضافه می‌کنید، در صورت نیاز، مانیفست را ویرایش کنید تا ظاهر و رفتار افزونه مورد نیاز را ایجاد کنید.

ظاهر و رفتار برنامه Google Chat را پیکربندی کنید

اگر افزونه‌ای طراحی کرده‌اید که Google Chat را توسعه می‌دهد، باید از Google Chat API برای پیکربندی ظاهر و رفتار یک برنامه چت استفاده کنید. برای مراحل، به پیکربندی برنامه Google Chat مراجعه کنید.

افزونه را بسازید

شما باید یک رابط مبتنی بر کارت برای افزونه پیاده‌سازی کنید. از سرویس کارت Apps Script استفاده کنید یا اگر با زبان کد دیگری می‌نویسید، JSON با فرمت صحیح را برای رابط برگردانید تا به صورت کارت‌ها رندر شود.

شما همچنین باید هرگونه تابع فعال‌سازی مشخص‌شده در مانیفست افزونه را پیاده‌سازی کنید. اگر افزونه شما با استفاده از OAuth به یک سرویس شخص ثالث غیر از گوگل متصل می‌شود، باید OAuth را برای آن سرویس نیز پیکربندی کنید .

ساخت کارت‌ها

شما با ایجاد اشیاء Card و پر کردن آنها با ویجت‌ها ، یک رابط کاربری افزونه را تعریف می‌کنید. توابع فعال‌سازی مشخص شده در مانیفست شما باید یا یک شیء Card واحد یا آرایه‌ای از اشیاء Card را که نشان‌دهنده «صفحات» مختلف رابط افزونه هستند، برگردانند. افزونه شما همچنین می‌تواند در پاسخ به اقدامات کاربر، کارت‌های جدیدی ایجاد و نمایش دهد.

در Apps Script، شما با استفاده از کلاس CardBuilder کارت‌هایی ایجاد می‌کنید. هر کارت به یک CardHeader و یک یا چند CardSections نیاز دارد. شما باید هر بخش کارت را با ویجت‌های منحصر به فردی که رابط افزونه را تشکیل می‌دهند، پر کنید. ویجت‌های تعاملی معمولاً به اکشن‌ها متصل می‌شوند تا رفتار تعاملی خود را تعریف کنند.

بعد از اینکه تمام بخش‌ها و ویجت‌ها را از طریق CardBuilder به کارت خود اضافه کردید، باید CardBuilder.build() را برای ایجاد شیء Card مربوطه فراخوانی کنید.

شما می‌توانید از سایر سرویس‌های اسکریپت برنامه‌های داخلی مانند CalendarApp برای بازیابی اطلاعات و نمایش آنها در کارت‌های افزونه‌ای که می‌سازید استفاده کنید. می‌توانید از داده‌های واکشی شده از سرویس‌های غیر گوگل نیز استفاده کنید.

اگر افزونه شما نیاز به دسترسی به APIهای غیر گوگلی که به OAuth نیاز دارند، دارد، باید آن سرویس را پیکربندی کرده و به آن متصل شوید - برای جزئیات بیشتر به راهنمای اتصال به سرویس‌های غیر گوگل مراجعه کنید.

سفارش ساخت

هنگام ساخت کارت، باید از بالا به بالا بسازید. یعنی باید از این دستور ساخت استفاده کنید:

  1. ویجت را بسازید.
  2. ابزارک را به بخش کارت اضافه کنید.
  3. این کار را تا زمانی که بخش کارت تمام ابزارک‌های خود را داشته باشد، تکرار کنید.
  4. بخش کارت را به کارت اضافه کنید.

این مورد ضروری است زیرا وقتی یک ویجت را به یک کارت یا بخش کارت اضافه می‌کنید، در واقع یک کپی از آن ویجت را اضافه می‌کنید. هر تغییری که پس از اضافه کردن شیء ویجت در آن ایجاد کنید، در کارت نهایی منعکس نمی‌شود.

اقدامات جهانی

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

برای جزئیات بیشتر به اقدامات جهانی مراجعه کنید.

دامنه‌های OAuth افزونه را تأیید کنید

محدوده‌ها (scope) مشخص می‌کنند که افزونه مجاز است از طرف کاربر چه اقداماتی انجام دهد. بهترین روش این است که افزونه‌ها فقط محدوده‌هایی برای اقداماتی که برای عملکردشان ضروری هستند، داشته باشند و نه بیشتر.

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

برای جزئیات بیشتر به Scopeها مراجعه کنید.

افزونه را تست کنید

شما می‌توانید افزونه‌های منتشر نشده را ابتدا با نصب افزونه منتشر نشده آزمایش کنید. پس از نصب و تأیید، می‌توانید از افزونه در حساب خود استفاده کنید و ظاهر و رفتار آن را در برنامه‌های میزبانی که از آن پشتیبانی می‌کند، آزمایش کنید. باید تأیید کنید که افزونه مطابق انتظار برای زمینه‌ها و اقدامات کاربر رفتار می‌کند.

برای شروع آزمایش افزونه خود، به راهنماهای زیر مراجعه کنید:

افزونه را منتشر کنید

انتشار افزونه شما، آن را در دسترس دیگران، چه به صورت عمومی و چه فقط کاربران دامنه شما، قرار می‌دهد. قبل از شروع فرآیند انتشار، حتماً نمای کلی انتشار را بررسی کنید. انتشار فرآیندی پیچیده است که نیاز به آماده‌سازی و زمان برای تکمیل دارد.

افزونه‌های Google Workspace در بازار Google Workspace منتشر می‌شوند. افزونه‌های در دسترس عموم باید قبل از انتشار، بررسی برنامه را تکمیل کنند.

برای جزئیات بیشتر ، به انتشار افزونه‌ی Google Workspace مراجعه کنید.