با نحوه طراحی، ساختن، و منتشر کردن برافزاهای Google Workspace آشنا شوید:
- برنامه‌های Google Workspace را که می‌خواهید برافزایتان در آن‌ها برای کاربران دردسترس باشد تعیین کنید.
- پروژه‌های برافزایتان را راه‌اندازی کنید و مالک و مشارکت‌کنندگان را انتخاب کنید.
- ظاهر و رفتار برافزایتان را طراحی و پیکربندی کنید.
- برافزا را بسازید.
- محدوده‌های OAuth برافزایتان را درستی‌سنجی کنید.
- برافزا را در یک یا چند برنامه Google Workspace آزمایش کنید.
- برافزا را منتشر کنید.
برافزایی با Apps Script یا HTTP بسازید. برای مقایسه این دو، ویدیو «Apps Script دربرابر نقاط پایانی HTTP: کدام را باید انتخاب کنید؟» را تماشا کنید. 🤔".
انتخاب برنامه‌های میزبان Google Workspace
می‌توانید برافزاهای Google Workspace را پیکربندی کنید تا در برنامه‌های میزبان Google Workspace زیر نشان داده شوند:
- Gmail
- تقویم Google
- Google Chat
- سندنگار Google
- Google Drive
- Google Meet
- کاربرگ‌نگار Google
- اسلایدنگار Google
برای ساختن برنامه‌های Google Workspace، به گسترش واسط کاربر Google Workspace مراجعه کنید.
پروژه‌های برافزایتان را راه‌اندازی کنید و مالک و مشارکت‌کنندگان را انتخاب کنید
اگر برافزایتان را در Apps Script بسازید، هم پروژه Apps Script و هم پروژه Google Cloud ایجاد می‌کنید. اگر برافزایتان را به زبانی غیراز Apps Script بسازید، فقط باید پروژه Google Cloud ایجاد کنید.
برای ساختن برافزا، باید هم پروژه نوشتار و هم پروژه Cloud را پیکربندی کنید.
قبل‌از شروع توسعه برافزا، یک حساب کاربری واحد برای مالکیت پروژه‌ها انتخاب کنید و تصمیم بگیرید کدام حساب‌های دیگر همیار باشند. مالک پروژه‌ها فایل‌های پروژه و تنظیمات مرتبط را ایجاد و مدیریت می‌کند، درحالی‌که مشارکت‌کنندگان می‌توانند در کدنویسی و آزمایش کمک کنند.
پروژه‌های Apps Script
پیش‌از ساختن برافزایتان، سهمیه‌ها و محدودیت‌های Apps Script را مرور کنید تا طراحی پروژه‌تان را با این رهنمودها هماهنگ کنید. Apps Script برای توسعه سبک افزونه‌های شخصی یا داخلی با پایگاه کاربری کوچک بهترین گزینه است. اگر برافزای شما به پشتیبانی برای کاربران زیاد، تأخیر کم، یا کنترل کامل بر زیرساخت نیاز دارد، از زمان اجرای دیگری استفاده کنید.
فایل‌های پروژه Apps Script برافزای خود را در درایو مشترک بسازید تا هیچ حسابی مالکیت انحصاری نداشته باشد. قرار دادن فایل نوشتار برافزای شما در درایو مشترک تضمین می‌کند که همه همیاران به پروژه نوشتار دسترسی داشته باشند.
وقتی برافزایی را منتشر می‌کنید، یک حساب کاربری واحد ناشر است. حساب انتشار باید به پروژه نوشتار دسترسی ویرایش داشته باشد، اما لازم نیست مالک باشد.
برای ایجاد پروژه Apps Script، پروژه‌های نوشتار را ببینید.
پروژه‌های Google Cloud
همیارانی به پروژه Cloud برافزا اضافه کنید. این کار تضمین می‌کند که تیم شما همیشه بتواند به تنظیمات Cloud برافزای موردنظر دسترسی داشته باشد.
برای ایجاد پروژه Google Cloud، به ایجاد پروژه Google Cloud مراجعه کنید.
طراحی و پیکربندی ظاهر و رفتار برافزا
پیش‌از ساختن برافزا، تصمیم بگیرید برافزای شما چه شکلی باشد و چگونه عمل کند. درنظر بگیرید که برافزا چه موارد استفاده‌ای را حل می‌کند. ابتدا با یک طراحی ساده شروع کنید تا کارتان را شروع کنید، و سپس اصلاحات را اضافه کنید.
برای دریافت دستورالعمل‌های مربوط به نحوه طراحی تجربه کاربری برافزای خود، به راهنمای سبک برافزای Google Workspace مراجعه کنید.
پیکربندی مانیفست برافزا
طراحی را در مانیفست برافزا پیاده‌سازی کنید. پیکربندی ظاهر و رفتار برافزا در مانیفست، ازجمله برنامه‌های میزبان Google Workspace که برافزا آن‌ها را گسترش می‌دهد.
برای جزئیات، مانیفست‌های برافزای Google Workspace را ببینید.
هم‌زمان با افزودن کد و ویژگی، مانیفست را درصورت نیاز به‌روز کنید تا ظاهر و رفتار موردنیاز برافزا را تعریف کنید.
پیکربندی ظاهر و عملکرد برنامه Google Chat
اگر برافزایی طراحی می‌کنید که Google Chat را گسترش می‌دهد، از Google Chat API برای پیکربندی ظاهر و رفتار برنامه Chat استفاده کنید. برای مراحل، به استفاده از Google Chat API مراجعه کنید.
ساختن برافزا
رابط مبتنی بر کارت برای برافزا پیاده‌سازی کنید. از خدمات کارت استفاده کنید یا اگر از زبان کد دیگری استفاده می‌کنید، JSON قالب‌بندی‌شده برای میانای کاربری برگردانید تا به‌عنوان کارت ارائه شود.
هر تابع راه‌اندازی مشخص‌شده در مانیفست برافزا را پیاده‌سازی کنید. اگر برافزای شما بااستفاده از OAuth به سرویس طرف سوم متصل می‌شود، OAuth را برای آن سرویس پیکربندی کنید.
ساخت کارت‌ها
با ایجاد
Card شیء و افزودن
ابزارک، میانای کاربر برافزا را تعریف کنید. توابع راه‌انداز مشخص‌شده در
مانیفست شما باید یا یک
Card شیء واحد یا آرایه‌ای از
Card اشیایی را برگردانند که
«صفحه‌های» مختلف رابط برافزا را نشان می‌دهند. برافزا
همچنین می‌تواند کارت‌های جدیدی را در پاسخ به اقدامات کاربر ایجاد و نمایش دهد.
در Apps Script، بااستفاده از کلاس
CardBuilder کارت بسازید. هر کارت به CardHeader
و یک یا چند
CardSections نیاز دارد. هر بخش کارت را با ابزاره‌های مجزایی که رابط را تشکیل می‌دهند پر کنید.
ابزارک‌های تعامل معمولاً به کنش‌ها پیوند داده می‌شوند تا رفتار تعاملی آن‌ها را تعریف کنند.
پس‌از اینکه همه بخش‌ها و ابزارک‌ها را ازطریق
CardBuilder به کارتتان اضافه کردید،
CardBuilder.build
را فراخوانی کنید تا شیء Card مربوطه ایجاد شود.
از سرویس‌های داخلی Apps Script
مثل
CalendarApp برای بازیابی
اطلاعات برای نمایش در کارت‌های برافزا استفاده کنید. از داده‌های
سرویس‌های غیرGoogle استفاده کنید.
اگر برافزایتان به میاناهای برنامه‌سازی کاربردی غیر Google که به OAuth نیاز دارند دسترسی دارد، آن سرویس را پیکربندی و به آن متصل کنید—به راهنمای اتصال به سرویس‌های غیر Google مراجعه کنید.
سفارش ساخت‌وساز
وقتی کارتی می‌سازید، از بالا به پایین بسازید. از این ترتیب ساخت استفاده کنید:
- ابزاره را بسازید.
- ابزاره را به بخش کارت اضافه کنید.
- این کار را تکرار کنید تا بخش کارت همه ابزارک‌هایش را داشته باشد.
- بخش کارت را به کارت اضافه کنید.
دلیل این است که وقتی ابزاره‌ای را به کارت یا بخش کارت اضافه می‌کنید، درواقع کپی آن ابزاره را اضافه می‌کنید. هر تغییری که پس‌از افزودن شیء ابزارک ایجاد کنید در کارت نهایی منعکس نمی‌شود.
کنش‌های جهانی
از کنش‌های جهانی برای ارائه عملکرد مستقل از زمینه استفاده کنید. کنش‌های جهانی عناصر منویی هستند که در واسط کاربر برافزا صرف‌نظر از کارت دردسترس هستند. همه کنش‌های جهانی تعریف‌شده در منو کارت برافزا ظاهر می‌شود.
برای جزئیات بیشتر، کنش‌های جهانی را ببینید.
درستی‌سنجی دامنه‌های OAuth برافزا
محدوده‌ها کنش‌هایی را که برافزا می‌تواند ازطرف کاربر انجام دهد تعریف می‌کنند. برافزاها باید فقط محدوده‌هایی را که برای عملکردشان نیاز دارند داشته باشند.
در پروژه‌های برافزا، محدوده‌های برافزا را تنظیم کنید تا مطمئن شوید برافزا از کمترین مجموعه محدوده‌های مجاز ممکن استفاده می‌کند. محدوده‌ها را در مانیفست برافزایی تعریف کنید.
برای جزئیات بیشتر، محدوده‌ها را ببینید.
آزمایش برافزا
می‌توانید برافزاهای منتشرنشده را با نصب کردن برافزای منتشرنشده آزمایش کنید. پس‌از نصب و مجاز کردن، از برافزا در حسابتان استفاده کنید تا ظاهر و رفتار آن را در برنامه‌های میزبان که گسترش می‌دهد آزمایش کنید. تأیید کنید که برافزا در بافت‌ها و کنش‌های کاربر طبق انتظار عمل می‌کند.
برای شروع آزمایش افزونه، راهنماهای زیر را ببینید:
- آزمایش و اشکال‌زدایی برافزاهای Apps Script در Google Workspace
- آزمایش و اشکال‌زدایی برافزاهای HTTP Google Workspace
- آزمایش ویژگی‌های تعاملی برای برنامه‌های Google Chat
انتشار برافزا
با انتشار، برافزایتان برای دیگران دردسترس قرار می‌گیرد. پیش‌از انتشار، نمای کلی نشریه را مرور کنید. انتشار یک فرایند پیچیده است که نیاز به آماده‌سازی دارد.
برافزاهای Google Workspace در Google Workspace Marketplace منتشر می‌شوند. برافزاهای دردسترس عموم قبل‌از انتشار به بازبینی برنامه نیاز دارند.
برای جزئیات بیشتر، انتشار برافزای Google Workspace را ببینید.