هنگامی که می خواهید یک افزونه Google Workspace جدید بسازید، این روش کلی را دنبال کنید:
- پروژه های افزونه خود را تنظیم کنید و مالک و همکاران خود را انتخاب کنید.
- ظاهر و رفتار افزونه خود را طراحی کنید.
- مانیفست پروژه یا منبع استقرار افزونه را پیکربندی کنید.
- برای تعریف ظاهر و رفتار افزونه کد بنویسید.
- محدوده های OAuth افزونه خود را تأیید کنید.
- افزونه را در برنامه های میزبانی که گسترش می دهد آزمایش کنید.
- افزونه را منتشر کنید.
پروژه های افزونه خود را تنظیم کنید و مالک و همکاران خود را انتخاب کنید
اگر افزونه خود را در Apps Script بسازید، هم یک پروژه Apps Script و هم یک پروژه Google Cloud ایجاد می کنید. اگر افزونه خود را به زبانی غیر از Apps Script می‌سازید، فقط باید یک پروژه Google Cloud ایجاد کنید.
قبل از شروع توسعه افزونه، یک حساب کاربری را برای مالکیت پروژه‌ها انتخاب کنید و تصمیم بگیرید کدام حساب‌های دیگر همکار هستند. صاحب پروژه ها فایل های پروژه و تنظیمات مربوطه را ایجاد و مدیریت می کند، در حالی که همکاران می توانند در کدنویسی و آزمایش کمک کنند.
پروژه های Apps Script
می توانید فایل های پروژه Apps Script افزونه خود را در یک درایو مشترک بسازید تا هیچ حسابی به تنهایی مالکیت آن را نداشته باشد. قرار دادن فایل اسکریپت الحاقی خود در یک درایو اشتراکی تضمین می کند که چندین همکار به پروژه اسکریپت دسترسی دارند.
هنگامی که یک افزونه منتشر می کنید، یک حساب کاربری به عنوان ناشر عمل می کند. حساب انتشار باید به پروژه اسکریپت دسترسی ویرایش داشته باشد، اما نیازی نیست که مالک باشد.
برای ایجاد یک پروژه Apps Script، به پروژه‌های اسکریپت مراجعه کنید.
پروژه های Google Cloud
توصیه می‌کنیم همکارانی را به پروژه Cloud افزونه اضافه کنید . این کمک می‌کند مطمئن شوید که فردی در تیم شما همیشه می‌تواند به تنظیمات Cloud این افزونه دسترسی داشته باشد.
برای ایجاد یک پروژه Google Cloud، به ایجاد پروژه Google Cloud مراجعه کنید.
ظاهر و رفتار افزودنی خود را طراحی کنید
قبل از شروع ساختن، تصمیم بگیرید که می خواهید افزونه شما چگونه باشد و چگونه باید رفتار کند. در نظر بگیرید که افزونه باید برای چه مواردی راه حل ارائه دهد. برای شروع کار ابتدا با یک طراحی ساده شروع کنید، سپس اصلاحات بیشتری اضافه کنید.
برای راهنمایی در مورد نحوه طراحی تجربه کاربری افزونه خود به راهنمای سبک Google Workspace Add-on مراجعه کنید.
مانیفست پروژه الحاقی را پیکربندی کنید
در پروژه های Apps Script، مانیفست پروژه یک فایل JSON ویژه است. جزئیات مختلفی را در مورد پروژه، مانند وابستگی های کتابخانه آن، مشخص می کند. برای افزودنی‌های Google Workspace، مانیفست همچنین اطلاعات اولیه‌ای را که برنامه میزبان برای نمایش صحیح افزونه نیاز دارد، ارائه می‌کند.
برای جزئیات نحوه پیکربندی مانیفست افزونه در Apps Script به Manifests مراجعه کنید.
همانطور که کد و ویژگی را به افزونه خود اضافه می کنید، مانیفست را در صورت نیاز ویرایش کنید تا ظاهر و رفتار افزونه مورد نیاز را ایجاد کنید.
افزونه را کدنویسی کنید
شما باید یک رابط مبتنی بر کارت برای افزونه پیاده سازی کنید. از سرویس Apps Script's Card استفاده کنید یا اگر به زبان کد دیگری می نویسید، JSON با فرمت مناسب را برای رابط به عنوان کارت بازگردانید.
همچنین باید هر توابع تریگر مشخص شده در مانیفست افزودنی را پیاده سازی کنید. اگر افزونه شما با استفاده از OAuth به یک سرویس شخص ثالث و غیر Google متصل می شود، باید OAuth را برای آن سرویس نیز پیکربندی کنید .
ساخت کارت
شما با ایجاد اشیاء Card و پر کردن آنها با ویجت ها ، یک رابط کاربری افزودنی تعریف می کنید. توابع راه‌اندازی که در مانیفست شما مشخص شده‌اند باید یک شی Card یا آرایه‌ای از اشیاء Card را برگردانند که «صفحه‌های» مختلف رابط افزودنی را نشان می‌دهند. افزونه شما همچنین می‌تواند کارت‌های جدیدی را در پاسخ به اقدامات کاربر ایجاد و نمایش دهد.
در Apps Script، با استفاده از کلاس CardBuilder کارت ایجاد می کنید. هر کارت به یک CardHeader و یک یا چند CardSections نیاز دارد. شما باید هر بخش کارت را با ویجت های جداگانه ای که رابط الحاقی را تشکیل می دهند پر کنید. ویجت‌های تعامل معمولاً به اقداماتی مرتبط می‌شوند تا رفتار تعاملی خود را تعریف کنند.
پس از اینکه تمام بخش‌ها و ابزارک‌ها را از طریق CardBuilder به کارت خود اضافه کردید، باید CardBuilder.build() برای ایجاد شی Card مربوطه فراخوانی کنید.
می‌توانید از دیگر سرویس‌های داخلی Apps Script مانند CalendarApp برای بازیابی اطلاعات برای نمایش در کارت‌های افزودنی که می‌سازید استفاده کنید. می‌توانید از داده‌های واکشی شده از سرویس‌های غیر Google استفاده کنید.
اگر افزونه شما نیاز به دسترسی به APIهای غیر Google دارد که به OAuth نیاز دارند، باید آن سرویس را پیکربندی کرده و به آن متصل شوید—برای جزئیات بیشتر به راهنمای اتصال به خدمات غیر Google مراجعه کنید.
سفارش ساخت و ساز
هنگام ساخت کارت، باید از بالا به بالا بسازید. یعنی باید از این دستور ساخت استفاده کنید:
- ویجت را بسازید.
- ویجت را به بخش کارت اضافه کنید.
- این کار را تا زمانی تکرار کنید که بخش کارت تمام ویجت های خود را داشته باشد.
- بخش کارت را به کارت اضافه کنید.
این مورد ضروری است زیرا وقتی یک ویجت را به بخش کارت یا کارت اضافه می کنید، در واقع یک کپی از آن ویجت را اضافه می کنید. هر تغییری که پس از افزودن شی ویجت روی آن ایجاد می کنید در کارت نهایی منعکس نمی شود.
اقدامات جهانی
می توانید از اقدامات جهانی برای ارائه عملکرد مستقل از زمینه استفاده کنید. کنش‌های جهانی، آیتم‌های منو هستند که بدون توجه به اینکه چه کارتی نمایش داده می‌شود، در رابط کاربری افزودنی موجود است. همه اقدامات جهانی تعریف شده همیشه در منوی کارت افزونه ظاهر می شوند.
برای جزئیات بیشتر به اقدامات جهانی مراجعه کنید.
دامنه های OAuth افزودنی را تأیید کنید
محدوده ها مشخص می کنند که افزونه مجاز است چه اقداماتی را از طرف کاربر انجام دهد. این بهترین تمرین برای افزونه‌ها است که فقط محدوده‌هایی برای اقداماتی داشته باشند که باید انجام دهند و نه بیشتر.
در پروژه های الحاقی، صراحتاً دامنه های افزودنی را تنظیم کنید تا مطمئن شوید که افزونه از حداقل مجموعه دامنه های ممکن استفاده می کند. شما تعیین می کنید که افزونه شما از چه محدوده هایی در مانیفست افزونه استفاده کند.
برای جزئیات بیشتر به Scopes مراجعه کنید.
افزونه را تست کنید
می‌توانید با نصب افزونه منتشر نشده، افزونه‌های منتشر نشده را آزمایش کنید. پس از نصب و مجوز، می توانید از افزونه در حساب خود استفاده کنید و ظاهر و رفتار آن را در برنامه های میزبانی که گسترش می دهد آزمایش کنید. باید بررسی کنید که افزونه برای زمینه ها و اقدامات کاربر مطابق انتظار رفتار می کند.
برای جزئیات بیشتر به تست افزونه‌های Google Workspace مراجعه کنید.
افزونه را منتشر کنید
انتشار برافزای شما آن را در دسترس دیگران، چه به صورت عمومی و چه فقط برای کاربران دامنه شما، می کند. قبل از شروع فرآیند انتشار، حتماً نمای کلی انتشارات را مرور کنید. انتشار فرآیند پیچیده ای است که برای تکمیل آن به آمادگی و زمان نیاز دارد.
افزونه‌های Google Workspace در بازار Google Workspace منتشر می‌شوند. افزونه‌های در دسترس عموم باید قبل از انتشار بررسی برنامه را کامل کنند.
برای جزئیات بیشتر به انتشار افزونه Google Workspace مراجعه کنید.
،هنگامی که می خواهید یک افزونه Google Workspace جدید بسازید، این روش کلی را دنبال کنید:
- پروژه های افزونه خود را تنظیم کنید و مالک و همکاران خود را انتخاب کنید.
- ظاهر و رفتار افزونه خود را طراحی کنید.
- مانیفست پروژه یا منبع استقرار افزونه را پیکربندی کنید.
- برای تعریف ظاهر و رفتار افزونه کد بنویسید.
- محدوده های OAuth افزونه خود را تأیید کنید.
- افزونه را در برنامه های میزبانی که گسترش می دهد آزمایش کنید.
- افزونه را منتشر کنید.
پروژه های افزونه خود را تنظیم کنید و مالک و همکاران خود را انتخاب کنید
اگر افزونه خود را در Apps Script بسازید، هم یک پروژه Apps Script و هم یک پروژه Google Cloud ایجاد می کنید. اگر افزونه خود را به زبانی غیر از Apps Script می‌سازید، فقط باید یک پروژه Google Cloud ایجاد کنید.
قبل از شروع توسعه افزونه، یک حساب کاربری را برای مالکیت پروژه‌ها انتخاب کنید و تصمیم بگیرید کدام حساب‌های دیگر همکار هستند. صاحب پروژه ها فایل های پروژه و تنظیمات مربوطه را ایجاد و مدیریت می کند، در حالی که همکاران می توانند در کدنویسی و آزمایش کمک کنند.
پروژه های Apps Script
می توانید فایل های پروژه Apps Script افزونه خود را در یک درایو مشترک بسازید تا هیچ حسابی به تنهایی مالکیت آن را نداشته باشد. قرار دادن فایل اسکریپت الحاقی خود در یک درایو اشتراکی تضمین می کند که چندین همکار به پروژه اسکریپت دسترسی دارند.
هنگامی که یک افزونه منتشر می کنید، یک حساب کاربری به عنوان ناشر عمل می کند. حساب انتشار باید به پروژه اسکریپت دسترسی ویرایش داشته باشد، اما نیازی نیست که مالک باشد.
برای ایجاد یک پروژه Apps Script، به پروژه‌های اسکریپت مراجعه کنید.
پروژه های Google Cloud
توصیه می‌کنیم همکارانی را به پروژه Cloud افزونه اضافه کنید . این کمک می‌کند مطمئن شوید که فردی در تیم شما همیشه می‌تواند به تنظیمات Cloud این افزونه دسترسی داشته باشد.
برای ایجاد یک پروژه Google Cloud، به ایجاد پروژه Google Cloud مراجعه کنید.
ظاهر و رفتار افزودنی خود را طراحی کنید
قبل از شروع ساختن، تصمیم بگیرید که می خواهید افزونه شما چگونه باشد و چگونه باید رفتار کند. در نظر بگیرید که افزونه باید برای چه مواردی راه حل ارائه دهد. برای شروع کار ابتدا با یک طراحی ساده شروع کنید، سپس اصلاحات بیشتری اضافه کنید.
برای راهنمایی در مورد نحوه طراحی تجربه کاربری افزونه خود به راهنمای سبک Google Workspace Add-on مراجعه کنید.
مانیفست پروژه الحاقی را پیکربندی کنید
در پروژه های Apps Script، مانیفست پروژه یک فایل JSON ویژه است. جزئیات مختلفی را در مورد پروژه، مانند وابستگی های کتابخانه آن، مشخص می کند. برای افزودنی‌های Google Workspace، مانیفست همچنین اطلاعات اولیه‌ای را که برنامه میزبان برای نمایش صحیح افزونه نیاز دارد، ارائه می‌کند.
برای جزئیات نحوه پیکربندی مانیفست افزونه در Apps Script به Manifests مراجعه کنید.
همانطور که کد و ویژگی را به افزونه خود اضافه می کنید، مانیفست را در صورت نیاز ویرایش کنید تا ظاهر و رفتار افزونه مورد نیاز را ایجاد کنید.
افزونه را کدنویسی کنید
شما باید یک رابط مبتنی بر کارت برای افزونه پیاده سازی کنید. از سرویس Apps Script's Card استفاده کنید یا اگر به زبان کد دیگری می نویسید، JSON با فرمت مناسب را برای رابط به عنوان کارت بازگردانید.
همچنین باید هر توابع تریگر مشخص شده در مانیفست افزودنی را پیاده سازی کنید. اگر افزونه شما با استفاده از OAuth به یک سرویس شخص ثالث و غیر Google متصل می شود، باید OAuth را برای آن سرویس نیز پیکربندی کنید .
ساخت کارت
شما با ایجاد اشیاء Card و پر کردن آنها با ویجت ها ، یک رابط کاربری افزودنی تعریف می کنید. توابع راه‌اندازی که در مانیفست شما مشخص شده‌اند باید یک شی Card یا آرایه‌ای از اشیاء Card را برگردانند که «صفحه‌های» مختلف رابط افزودنی را نشان می‌دهند. افزونه شما همچنین می‌تواند کارت‌های جدیدی را در پاسخ به اقدامات کاربر ایجاد و نمایش دهد.
در Apps Script، با استفاده از کلاس CardBuilder کارت ایجاد می کنید. هر کارت به یک CardHeader و یک یا چند CardSections نیاز دارد. شما باید هر بخش کارت را با ویجت های جداگانه ای که رابط الحاقی را تشکیل می دهند پر کنید. ویجت‌های تعامل معمولاً به اقداماتی مرتبط می‌شوند تا رفتار تعاملی خود را تعریف کنند.
پس از اینکه تمام بخش‌ها و ابزارک‌ها را از طریق CardBuilder به کارت خود اضافه کردید، باید CardBuilder.build() برای ایجاد شی Card مربوطه فراخوانی کنید.
می‌توانید از دیگر سرویس‌های داخلی Apps Script مانند CalendarApp برای بازیابی اطلاعات برای نمایش در کارت‌های افزودنی که می‌سازید استفاده کنید. می‌توانید از داده‌های واکشی شده از سرویس‌های غیر Google استفاده کنید.
اگر افزونه شما نیاز به دسترسی به APIهای غیر Google دارد که به OAuth نیاز دارند، باید آن سرویس را پیکربندی کرده و به آن متصل شوید—برای جزئیات بیشتر به راهنمای اتصال به خدمات غیر Google مراجعه کنید.
سفارش ساخت و ساز
هنگام ساخت کارت، باید از بالا به بالا بسازید. یعنی باید از این دستور ساخت استفاده کنید:
- ویجت را بسازید.
- ویجت را به بخش کارت اضافه کنید.
- این کار را تا زمانی تکرار کنید که بخش کارت تمام ویجت های خود را داشته باشد.
- بخش کارت را به کارت اضافه کنید.
این مورد ضروری است زیرا وقتی یک ویجت را به بخش کارت یا کارت اضافه می کنید، در واقع یک کپی از آن ویجت را اضافه می کنید. هر تغییری که پس از افزودن شی ویجت روی آن ایجاد می کنید در کارت نهایی منعکس نمی شود.
اقدامات جهانی
می توانید از اقدامات جهانی برای ارائه عملکرد مستقل از زمینه استفاده کنید. کنش‌های جهانی، آیتم‌های منو هستند که بدون توجه به اینکه چه کارتی نمایش داده می‌شود، در رابط کاربری افزودنی موجود است. همه اقدامات جهانی تعریف شده همیشه در منوی کارت افزونه ظاهر می شوند.
برای جزئیات بیشتر به اقدامات جهانی مراجعه کنید.
دامنه های OAuth افزودنی را تأیید کنید
محدوده ها مشخص می کنند که افزونه مجاز است چه اقداماتی را از طرف کاربر انجام دهد. این بهترین تمرین برای افزونه‌ها است که فقط محدوده‌هایی برای اقداماتی داشته باشند که باید انجام دهند و نه بیشتر.
در پروژه های الحاقی، صراحتاً دامنه های افزودنی را تنظیم کنید تا مطمئن شوید که افزونه از حداقل مجموعه دامنه های ممکن استفاده می کند. شما تعیین می کنید که افزونه شما از چه محدوده هایی در مانیفست افزونه استفاده کند.
برای جزئیات بیشتر به Scopes مراجعه کنید.
افزونه را تست کنید
می‌توانید با نصب افزونه منتشر نشده، افزونه‌های منتشر نشده را آزمایش کنید. پس از نصب و مجوز، می توانید از افزونه در حساب خود استفاده کنید و ظاهر و رفتار آن را در برنامه های میزبانی که گسترش می دهد آزمایش کنید. باید بررسی کنید که افزونه برای زمینه ها و اقدامات کاربر مطابق انتظار رفتار می کند.
برای جزئیات بیشتر به تست افزونه‌های Google Workspace مراجعه کنید.
افزونه را منتشر کنید
انتشار برافزای شما آن را در دسترس دیگران، چه به صورت عمومی و چه فقط برای کاربران دامنه شما، می کند. قبل از شروع فرآیند انتشار، حتماً نمای کلی انتشارات را مرور کنید. انتشار فرآیند پیچیده ای است که برای تکمیل آن به آمادگی و زمان نیاز دارد.
افزونه‌های Google Workspace در بازار Google Workspace منتشر می‌شوند. افزونه‌های در دسترس عموم باید قبل از انتشار بررسی برنامه را کامل کنند.
برای جزئیات بیشتر به انتشار افزونه Google Workspace مراجعه کنید.