افزونه های قدیمی Gmail و Calendar را ارتقا دهید

توجه: در حال حاضر امکان ارتقا مستقیم افزونه های ویرایشگر به افزونه های Google Workspace وجود ندارد. برای اطلاعات بیشتر، به «آیا می توانم افزونه ویرایشگر خود را ارتقا دهم» مراجعه کنید.

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

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

توجه: اگر افزونه‌های Gmail و افزونه‌های کنفرانس تقویم خود را ارتقا ندهید، به‌طور خودکار با یک صفحه اصلی عمومی به افزونه‌های Google Workspace ارتقا می‌یابند. هیچ تغییری در فهرست یا کد برنامه‌نویس شما لازم نیست و افزونه فقط در برنامه میزبان اصلی خود در دسترس خواهد بود. در Google Workspace Marketplace، افزونه‌های ارتقا یافته خودکار در بخش‌های «با Gmail کار می‌کند» یا «با تقویم کار می‌کند» با فهرست‌بندی، نصب‌ها و حفظ کاربران فهرست می‌شوند.

مرحله 1: یک کپی از پروژه Apps Script افزونه خود تهیه کنید

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

1. افزونه Gmail موجود یا پروژه برنامه افزودنی کنفرانس تقویم Apps Script را باز کنید.
2. در سمت چپ، روی نمای کلی کلیک کنید.
3. در سمت راست، روی Make a copy کلیک کنید.
4. در سمت چپ، روی تنظیمات پروژه > تغییر پروژه کلیک کنید.
5. روی شماره پروژه GCP کلیک کنید.
6. همان شماره پروژه مرتبط با پروژه افزونه منتشر شده Apps Script خود را وارد کنید.
7. روی تنظیم پروژه کلیک کنید.

هشدار: پروژه Apps Script یک افزونه عمومی را مستقیماً ارتقا ندهید. برای جدا نگه داشتن نسخه ارتقا یافته از نسخه عمومی در حین ساخت و آزمایش، باید یک کپی تهیه کنید.

مرحله 2: افزونه Google Workspace را ادغام کنید

شما باید هر ویژگی افزونه Google Workspace را که می خواهید به افزونه خود اضافه کنید، طراحی و پیاده سازی کنید.

1. برنامه‌ریزی کنید که چه محتوایی در کارت‌های صفحه اصلی افزونه شما نمایش داده شود و آیا آنها باید در Gmail، Calendar، Drive یا هر ترکیبی از این سه میزبان ظاهر شوند. اگر می‌خواهید یک صفحه اصلی در بیش از یک میزبان داشته باشید، تصمیم بگیرید که آیا می‌تواند همان صفحه اصلی باشد یا کارت‌های صفحه اصلی سفارشی برای هر میزبان می‌خواهید.
2. در پروژه کپی شده برنامه Apps Script، کارت های صفحه اصلی خود را با توابع homepageTrigger بسازید. اطمینان حاصل کنید که هر گونه توابع پشتیبانی یا منطق مورد نیاز برای کنترل رابط های صفحه اصلی جدید خود را شامل می شود.

3. اضافه کردن کارت‌های زمینه‌ای را در نظر بگیرید که توسط عملکرد کاربر فعال می‌شوند، مانند باز کردن رشته پیام Gmail یا رویداد تقویم .

   احتیاط: افزونه‌های ارتقا یافته برای پیام‌های Gmail نسبت به دریافت افزودنی‌های Gmail، مقدار شناسه متفاوتی دریافت می‌کنند. این تغییر فقط بر افزونه‌های ارتقا یافته‌ای تأثیر می‌گذارد که messageId به عنوان کلید در هر فضای ذخیره‌سازی دائمی استفاده می‌کنند. در صورت نیاز، همچنان می‌توانید مقادیر ID قدیمی را با Gmail API دریافت کنید. messages().get() Gmail API مقادیر شناسه جدید و قدیمی را می پذیرد، اما فقط مقادیر شناسه قدیمی را برمی گرداند.

4. هرگونه دسترسی به اشیاء رویداد را در برافزای خود (در توابع پاسخ تماس ویجت یا در توابع راه‌انداز متنی) به‌روزرسانی کنید تا از ساختار شی رویداد به‌روزرسانی شده استفاده کنید. ساختار جدید همچنان حاوی همان فیلدهای شی رویداد است که توسط افزونه های کنفرانس Gmail و Calendar استفاده می شود، اما آن فیلدهای اصلی منسوخ شده اند و در نهایت حذف خواهند شد.

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

روشی که در آن اطلاعات پیکربندی در ساختار مانیفست افزونه‌های Google Workspace ذخیره می‌شود، نسبت به ساختار افزونه‌های Gmail و افزونه‌های کنفرانس تقویم به‌طور چشمگیری تغییر کرده است. همانطور که افزونه خود را ارتقا می دهید، باید فیلدهای مانیفست پروژه Apps Script افزونه خود را مطابق جداول زیر به روز کنید. شما باید تمام خصوصیات فرعی مرتبط را به ویژگی addOns جدید به روز کنید.

حتماً فیلد oauthScopes مانیفست خود را نیز در صورت نیاز به روز کنید تا مجوزهای مورد نیاز افزونه به روز شده شما را منعکس کند.

برای کسب اطلاعات بیشتر درباره مانیفست‌های افزودنی Google Workspace، به Manifests مراجعه کنید.

افزونه های جیمیل

فیلد مانیفست اصلی	اقدام لازم است
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 بروید.

مرحله 4: افزونه ارتقا یافته خود را آزمایش کنید

برای آزمایش برافزای ارتقا یافته خود قبل از انتشار، به تست افزونه‌های Google Workspace مراجعه کنید.

مرحله 5: از افزونه ارتقا یافته خود درخواست بررسی کنید

همه افزونه‌های Google Workspace، خواه یک افزونه ارتقایافته یا یک افزونه ساخته شده از ابتدا، قبل از فهرست شدن در Google Workspace Marketplace باید تأیید شوند.

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

1. اطمینان حاصل کنید که افزونه شما همه الزامات انتشار افزونه را برآورده می کند.

2. با استفاده از نسخه کدی که می خواهید منتشر کنید ، یک استقرار نسخه شده از افزونه Google Workspace خود (در پروژه Apps Script جدید) ایجاد کنید . سعی نکنید با استفاده از استقرار هد منتشر کنید.

3. اگر در حین ارتقاء برافزای خود، دامنه‌های جدیدی اضافه کرده‌اید، باید تأیید OAuth را درخواست کنید . به عنوان مثال، اگر افزونه Gmail شما در نسخه افزونه Google Workspace از حوزه‌های Drive یا Calendar جدید استفاده می‌کند، باید آن محدوده‌های جدید را برای تأیید ارسال کنید. تأیید اغلب چند روز طول می کشد تا تکمیل شود، بنابراین فرآیند را در اسرع وقت شروع کنید. قبل از رفتن به مرحله 6 مطمئن شوید که افزونه شما تأیید شده است.

مرحله 6: افزونه ارتقا یافته خود را در دسترس قرار دهید

1. Google Workspace Marketplace SDK را باز کنید.

2. در سمت چپ، روی پیکربندی کلیک کنید. این پانل حاوی فرمی است که در آن اطلاعاتی درباره افزونه خود ارائه می دهید.

3. توضیحات کوتاه، توضیحات مفصل و تصاویر صفحه فهرست خود را به روز کنید تا عملکرد جدید افزونه Google Workspace را منعکس کند.

4. در بخش برنامه‌های افزودنی ، روی دکمه ارتقاء به Google Workspace Add-on کلیک کنید. در کادر متنی که ظاهر می‌شود، شناسه استقرار جدیدی را که برای افزونه Google Workspace خود در مرحله قبل ایجاد کرده‌اید، وارد کنید. اگر شناسه استقرار شما معتبر باشد، لیستی از میزبان های پشتیبانی شده ظاهر می شود.

   احتیاط: ارتقاء برافزای خود به یک افزونه Google Workspace به این روش یک فرآیند یکباره است که قابل واگرد نیست.

5. اگر دامنه‌های جدیدی را به افزونه Google Workspace خود اضافه کرده‌اید، مطمئن شوید که آنها را به بخش دامنه‌های OAuth 2.0 در صفحه پیکربندی اضافه کرده‌اید. دامنه های فهرست شده در آن بخش باید دقیقاً با دامنه های فهرست شده در مانیفست افزونه شما مطابقت داشته باشد.

6. بررسی کنید که اطلاعاتی که در فرم وارد کرده اید صحیح باشد. سپس، روی ذخیره تغییرات کلیک کنید.

اگر در طول فرآیند ارتقاء افزونه Google Workspace سؤالی دارید یا با مشکلی مواجه شدید، با ما تماس بگیرید .

سوالات متداول

در زیر سوالات متداول در مورد ارتقاء افزونه وجود دارد:

آیا می توانم افزونه ویرایشگر خود را ارتقا دهم؟

اکثر افزونه های ویرایشگر را می توان به افزونه های Google Workspace منتقل کرد. با این حال، نمی‌توان آن‌ها را به سادگی افزونه‌های Gmail و Calendar به Google Workspace ارتقا داد.

اگر می‌خواهید افزونه ویرایشگر خود را به یک افزونه Google Workspace منتقل کنید، باید رابط کاربری افزونه را از HTML به یک رابط مبتنی بر کارت بازنویسی کنید و مدیریت جاوا اسکریپت خود را به سرویس کارت به‌روزرسانی کنید.

ممکن است برخی از خدمات موجود در افزونه ویرایشگر موجود در سرویس کارت در دسترس نباشد. به عنوان مثال، اگر افزونه ویرایشگر شما دارای یک انتخابگر فایل باشد، مشابه آن از سرویس کارت برای افزونه‌های Google Workspace موجود نیست.

آیا می توانم یک افزونه Google Workspace جداگانه بسازم و افزونه موجود خود را حفظ کنم؟

می‌توانید افزونه‌های Google Workspace بیشتری را با نام‌های تجاری مختلف بسازید، اما ما به افزونه‌های مجزای کنفرانس Gmail یا Calendar با همان نام تجاری افزونه Google Workspace شما اجازه نمی‌دهیم. اگر سوالی دارید یا می خواهید درخواست استثنا کنید، با ما تماس بگیرید .

آیا کاربران من باید پس از ارتقاء افزونه، مجدداً مجوز بگیرند؟

تا زمانی که برافزای Google Workspace شما از همان پروژه زیربنایی Cloud Platform (GCP) با شناسه مشتری OAuth مرتبط استفاده می‌کند، کاربران شما نیازی به مجوز مجدد مجوزهایی که قبلاً برای برافزای اصلی شما تأیید کرده‌اند، ندارند. با این حال، اگر در طول فرآیند ارتقا، دامنه‌های جدیدی اضافه کنید، کاربران شما باید در اولین باری که از نسخه Google Workspace افزونه شما استفاده می‌کنند، آن محدوده‌های جدید را تأیید کنند.

آیا می توانم افزونه Chrome خود را به افزونه Google Workspace ارتقا دهم و کاربران را انتقال دهم؟

خیر. نمی‌توانید مرورهای کاربران، نصب‌ها و فهرست‌بندی یک برنامه افزودنی Chrome را منتقل کنید. باید یک افزونه Google Workspace جدید ایجاد کنید و کاربران برنامه افزودنی Chrome خود را به بازار Google Workspace هدایت کنید.

آیا می توانم چندین افزونه را با افزونه Google Workspace خود همراه کنم؟

فهرست ادغام برنامه ها را با هم ببینید.