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

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

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

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

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

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

فضای کاری گوگل را گسترش دهید، آن را کپی نکنید

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

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

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

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

Using Apps Script libraries can cause your add-on to run more slowly than it would if all the Apps Script code were contained within a single script project. Although Apps Script libraries work in add-ons, you might run into performance reductions if you use them. Avoid including unnecessary libraries in your project, and consider ways to reduce your add-on's reliance on them.

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

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

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

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

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

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

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