اگر قبلاً افزونهای برای گسترش Gmail یا Calendar ساخته و منتشر کردهاید، میتوانید آن را به یک افزونه Google Workspace ارتقا دهید. دستورالعملهای موجود در این صفحه نحوه افزودن قابلیت Google Workspace به افزونههای Gmail یا Calendar موجود و سپس انتشار افزونه ارتقا یافته خود را شرح میدهد تا بتوان آن را کشف و نصب کرد.
شما میتوانید این قابلیت جدید را به افزونه اصلی خود منتقل کنید تا فهرست، نصبها و کاربران Google Workspace Marketplace خود را حفظ کنید. ارتقا همچنین به شما امکان میدهد از ویژگیهای جدید افزونه Google Workspace مانند صفحات اصلی بهرهمند شوید.
مرحله ۱: یک کپی از پروژه Apps Script افزونه خود تهیه کنید
افزونهی ارتقا یافتهی شما از همان پروژهی گوگل کلود افزونهی منتشر شده استفاده میکند، اما ایجاد و استفاده از یک کپی از پروژهی Apps Script ضروری است تا کاربران فعلی شما در حین آزمایش نسخهی ارتقا یافته تحت تأثیر قرار نگیرند. ارتقا یک کپی از پروژهی اسکریپت اصلی همچنین به این معنی است که شما همیشه میتوانید به کد اصلی دسترسی داشته باشید و در صورت لزوم میتوانید بعداً آن را مجدداً پیادهسازی کنید.
- پروژه Apps Script افزونه Gmail یا افزونه کنفرانس Calendar موجود خود را باز کنید.
- در سمت چپ، روی نمای کلی کلیک کنید.
- در سمت راست، روی «کپی کردن کلیک کنید.
- در سمت چپ، روی تنظیمات پروژه > تغییر پروژه کلیک کنید.
- روی شماره پروژه GCP کلیک کنید.
- همان شماره پروژه مرتبط با پروژه Apps Script افزونهای موجود و منتشر شده خود را وارد کنید.
- روی تنظیم پروژه کلیک کنید.
مرحله ۲: افزونه Google Workspace را ادغام کنید
شما باید هر ویژگی افزونهی Google Workspace را که میخواهید به افزونهی خود اضافه کنید، طراحی و پیادهسازی کنید.
- برنامهریزی کنید که چه محتوایی را در کارتهای صفحه اصلی افزونه خود نمایش دهید و آیا باید در Gmail، Calendar، Drive یا هر ترکیبی از این سه میزبان نمایش داده شوند. اگر میخواهید یک صفحه اصلی در بیش از یک میزبان داشته باشید، تصمیم بگیرید که آیا میتواند همان صفحه اصلی باشد یا میخواهید کارتهای صفحه اصلی سفارشی برای هر میزبان داشته باشید.
- در پروژه افزونه کپیشده Apps Script خود، کارتهای صفحه اصلی خود را با توابع
homepageTriggerبسازید. مطمئن شوید که هرگونه تابع پشتیبانی یا منطق مورد نیاز برای کنترل رابطهای صفحه اصلی جدید خود را در آن قرار دادهاید. اضافه کردن کارتهای زمینهای که با اقدام کاربر، مانند باز کردن یک رشته پیام Gmail یا رویداد تقویم، فعال میشوند را در نظر بگیرید.
هرگونه دسترسی به اشیاء رویداد را در افزونه خود (در توابع فراخوانی ویجت یا در توابع تریگر متنی) بهروزرسانی کنید تا از ساختار شیء رویداد بهروزرسانیشده استفاده شود. ساختار جدید هنوز شامل همان فیلدهای شیء رویداد است که توسط افزونههای کنفرانس Gmail و Calendar استفاده میشود، اما آن فیلدهای اصلی منسوخ شدهاند و در نهایت حذف خواهند شد.
مرحله ۳: مانیفست افزونه خود را بهروزرسانی کنید
نحوه ذخیره اطلاعات پیکربندی در ساختار مانیفست افزونههای Google Workspace نسبت به ساختار مورد استفاده افزونههای Gmail و افزونههای کنفرانس Calendar به طور قابل توجهی تغییر کرده است. همزمان با ارتقاء افزونه، باید فیلدهای مانیفست پروژه Apps Script افزونه خود را مطابق جداول زیر بهروزرسانی کنید. باید تمام زیرویژگیهای مربوط به ویژگی جدید addOns را بهروزرسانی کنید.
حتماً فیلد oauthScopes در مانیفست خود را نیز در صورت نیاز بهروزرسانی کنید تا مجوزهای مورد نیاز افزونهی بهروزرسانیشدهتان را منعکس کند.
برای کسب اطلاعات بیشتر در مورد مانیفستهای افزونهی Google Workspace، به مانیفستها مراجعه کنید.
افزونههای جیمیل
| فیلد مانیفست اصلی | اقدام لازم |
|---|---|
gmail.composeTrigger | به addOns.gmail.composeTrigger بروید. |
gmail.contextualTriggers[] | لیست را به addOns.gmail.contextualTriggers[] منتقل کنید. |
gmail.logoUrl | به addOns.common.logoUrl بروید. |
gmail.name | به addOns.common.name بروید. |
gmail.openLinkUrlPrefixes[] | لیست را به addOns.common.openLinkUrlPrefixes[] منتقل کنید. |
gmail.primaryColor | به addOns.common.layoutProperties.primaryColor بروید. |
gmail.secondaryColor | به addOns.common.layoutProperties.secondaryColor بروید. |
gmail.universalActions[] | لیست را به addOns.common.universalActions[] منتقل کنید. |
gmail.universalActions[].text | هر فیلد gmail.universalActions[].text را به فیلد متناظر addOns.common.universalActions[].label منتقل کنید. |
gmail.useLocalFromApp | به addOns.common.useLocaleFromApp بروید. |
افزونههای کنفرانس تقویم
| فیلد مانیفست اصلی | اقدام لازم |
|---|---|
calendar.createSettingsUrlFunction | به تابع addOns.calendar.createSettingsUrlFunction بروید. |
calendar.conferenceSolution[] | به addOns.calendar.conferenceSolution[] بروید. |
calendar.logoUrl | به addOns.common.logoUrl بروید. |
calendar.name | به addOns.common.name بروید. |
مرحله ۴: افزونه ارتقا یافته خود را آزمایش کنید
برای آزمایش افزونهی ارتقا یافتهی خود قبل از انتشار، به بخش آزمایش افزونههای Google Workspace مراجعه کنید.
مرحله ۵: درخواست بررسی افزونه ارتقا یافته خود را بدهید
همه افزونههای Google Workspace، چه افزونههای ارتقا یافته و چه افزونههایی که از ابتدا ساخته شدهاند، قبل از اینکه بتوانند در بازار Google Workspace فهرست شوند، باید تأیید شوند.
برای ارسال افزونه خود برای بررسی، این مراحل را دنبال کنید:
مطمئن شوید که افزونهی شما تمام الزامات انتشار افزونه را برآورده میکند.
با استفاده از نسخه کدی که میخواهید منتشر کنید، یک استقرار نسخهبندیشده از افزونهی Google Workspace خود (در پروژهی جدید Apps Script) ایجاد کنید . سعی نکنید با استفاده از استقرار سربار، آن را منتشر کنید.
اگر هنگام ارتقاء افزونه خود، محدودههای جدیدی اضافه کردهاید، باید تأیید OAuth را درخواست کنید . برای مثال، اگر افزونه Gmail شما از محدودههای جدید Drive یا Calendar در نسخه افزونه Google Workspace استفاده میکند، باید آن محدودههای جدید را برای تأیید ارسال کنید. تأیید اغلب چند روز طول میکشد، بنابراین این فرآیند را در اسرع وقت شروع کنید. قبل از رفتن به مرحله 6، مطمئن شوید که افزونه شما تأیید شده است.
مرحله ۶: افزونه ارتقا یافته خود را در دسترس قرار دهید
SDK بازار فضای کاری گوگل (Google Workspace Marketplace SDK) را باز کنید.
در سمت چپ، روی پیکربندی کلیک کنید. این پنل شامل فرمی است که در آن اطلاعاتی در مورد افزونه خود ارائه میدهید.
توضیحات کوتاه، توضیحات مفصل و تصاویر صفحه فهرست خود را بهروزرسانی کنید تا عملکرد جدید افزونه Google Workspace را منعکس کند.
در قسمت افزونهها ، روی دکمهی «ارتقا به افزونهی Google Workspace» کلیک کنید. در کادر متنی که ظاهر میشود، شناسهی استقرار جدیدی را که برای افزونهی Google Workspace خود در مرحلهی قبل ایجاد کردهاید، وارد کنید. اگر شناسهی استقرار شما معتبر باشد، فهرستی از میزبانهای پشتیبانیشده ظاهر میشود.
اگر محدودههای جدیدی به افزونهی Google Workspace خود اضافه کردهاید، مطمئن شوید که آنها را به بخش محدودههای OAuth 2.0 در صفحهی پیکربندی اضافه میکنید. محدودههای ذکر شده در آن بخش باید دقیقاً با محدودههای ذکر شده در مانیفست افزونهی شما مطابقت داشته باشند.
تأیید کنید که اطلاعاتی که در فرم وارد کردهاید صحیح است. سپس، روی ذخیره تغییرات کلیک کنید.
اگر در طول فرآیند ارتقاء افزونه Google Workspace سؤالی دارید یا با مشکلی مواجه شدید، با ما تماس بگیرید .
سوالات متداول
سوالات متداول در مورد ارتقاء افزونهها به شرح زیر است:
آیا میتوانم افزونهی ویرایشگر خود را ارتقا دهم؟
اکثر افزونههای ویرایشگر را میتوان به افزونههای Google Workspace منتقل کرد. با این حال، نمیتوان آنها را به راحتی افزونههای Gmail و Calendar به افزونههای Google Workspace ارتقا داد.
اگر میخواهید افزونهی ویرایشگر خود را به یک افزونهی Google Workspace منتقل کنید، باید رابط کاربری افزونه را از HTML به یک رابط مبتنی بر کارت بازنویسی کنید و مدیریت جاوا اسکریپت خود را برای سرویس کارت بهروزرسانی کنید.
ممکن است برخی از سرویسهای افزونهی ویرایشگر فعلی شما در سرویس کارت موجود نباشند. برای مثال، اگر افزونهی ویرایشگر شما شامل یک انتخابگر فایل باشد، معادل آن در افزونههای سرویس کارت برای گوگل ورکاسپیس موجود نیست.
آیا میتوانم یک افزونهی جداگانه برای Google Workspace بسازم و افزونهی فعلیام را نگه دارم؟
شما میتوانید افزونههای اضافی Google Workspace را با نامهای تجاری مختلف ایجاد کنید، اما ما اجازه نمیدهیم افزونههای جداگانه کنفرانس Gmail یا Calendar با همان نام تجاری افزونه Google Workspace شما ایجاد شوند. اگر سؤالی دارید یا میخواهید درخواست استثنا کنید، با ما تماس بگیرید .
آیا کاربران من پس از ارتقا، نیاز به تأیید مجدد افزونه خواهند داشت؟
تا زمانی که افزونهی Google Workspace شما از همان پروژهی زیربنایی Cloud Platform (GCP) با یک شناسهی کلاینت OAuth مرتبط استفاده کند، کاربران شما نیازی به تأیید مجدد مجوزهایی که قبلاً برای افزونهی اصلی شما مجاز کردهاند، نخواهند داشت. با این حال، اگر در طول فرآیند ارتقا، محدودههای جدیدی اضافه کنید، کاربران شما باید اولین باری که از نسخه Google Workspace افزونهی شما استفاده میکنند، آن محدودههای جدید را تأیید کنند.
آیا میتوانم افزونه کروم خود را به افزونه Google Workspace ارتقا دهم و کاربران را منتقل کنم؟
خیر. شما نمیتوانید کاربران، نصبها و نظرات مربوط به فهرست افزونههای کروم را منتقل کنید. باید یک افزونه جدید Google Workspace ایجاد کنید و کاربران افزونه کروم خود را به Google Workspace Marketplace هدایت کنید.
آیا میتوانم چندین افزونه را با افزونهی Google Workspace خود دستهبندی کنم؟
فهرست ادغام برنامهها را با هم ببینید.