بهترین شیوه ها

با دنبال کردن این راهنماها برای طراحی افزونه، تجربه کلی کاربران خود را بهبود بخشید.

بهترین شیوه های عمومی

تشویق می‌شوید از بهترین روش‌های زیر برای همه افزونه‌هایی که ایجاد می‌کنید استفاده کنید.

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

افزونه‌ها توسط پروژه‌های Apps Script تعریف می‌شوند، که باید متعلق به یک حساب خاص باشند یا در یک درایو مشترک قرار داده شوند. قبل از کدنویسی یک افزونه، مشخص کنید که چه حسابی باید مالک پروژه باشد و چه حسابی به عنوان ناشر آن عمل می کند. همچنین تعیین کنید چه حساب‌هایی باید به عنوان همکار عمل کنند و مطمئن شوید که آن حساب‌ها به پروژه اسکریپت و پروژه Google Cloud مرتبط با آن دسترسی دارند.

Google Workspace را گسترش دهید، آن را تکرار نکنید

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

دامنه ها را محدود نگه دارید

هنگامی که محدوده های خود را به طور صریح تعریف می کنید ، همیشه مجموعه ای از محدوده های ممکن با حداقل مجاز را انتخاب کنید. به عنوان مثال، اگر افزونه فقط به دسترسی خواندن نیاز دارد، از طریق https://www.googleapis.com/auth/calendar به تقویم کاربر دسترسی کامل به تقویم کاربر نداشته باشید. برای دسترسی فقط خواندنی، https://www.googleapis.com/auth/calendar.readonly scope استفاده کنید.

از اتکای بیش از حد به کتابخانه ها خودداری کنید

استفاده از کتابخانه‌های Apps Script می‌تواند باعث کند برنامه افزودنی شما نسبت به زمانی که همه کد Apps Script در یک پروژه اسکریپت قرار می‌گرفت، کندتر اجرا شود . اگرچه کتابخانه‌های Apps Script در افزونه‌ها کار می‌کنند، در صورت استفاده از آنها ممکن است با کاهش عملکرد مواجه شوید. از گنجاندن کتابخانه های غیر ضروری در پروژه خود اجتناب کنید و راه هایی را برای کاهش اتکای افزونه خود به آنها در نظر بگیرید.

تأخیر توضیح داده شده در بالا فقط برای پروژه های Apps Script که به عنوان کتابخانه های سمت سرور استفاده می شوند، اعمال می شود. شما می توانید از کتابخانه های جاوا اسکریپت سمت کلاینت مانند jQuery آزادانه و بدون مواجهه با این تاخیر استفاده کنید.

بهترین شیوه های افزودنی ویرایشگر

بهترین روش‌های زیر فقط برای افزودنی ویرایشگر اعمال می‌شود.

HTML رابط و جاوا اسکریپت سمت سرویس گیرنده را در فایل های اسکریپت خود قرار دهید

می توانید چندین فایل اسکریپت را در یک پروژه Apps Script ایجاد کنید. اگر HTML و جاوا اسکریپتی را که نوارهای جانبی افزونه ها و دیالوگ ها را در فایل های اسکریپت اختصاص داده شده به آن ها تعریف می کند، قرار دهید، مدیریت یک افزونه پیچیده آسان تر است.

به طور کامل در حالت های مختلف مجوز تست کنید

هنگام آزمایش برافزای خود ، حتماً پیکربندی‌هایی را امتحان کنید که فایل‌های مختلف و وضعیت‌های مجوز متفاوتی دارند.