این صفحه توضیح می‌دهد که چگونه از «کیت توسعه نرم‌افزار Google Workspace Marketplace» برای پیکربندی و مدیریت برنامه خود در Google Workspace Marketplace استفاده کنید.
برای اینکه برنامه‌تان را برای استفاده دردسترس قرار دهید، باید آن را در کیت توسعه نرم‌افزار Marketplace راه‌اندازی کنید. «کیت توسعه نرم‌افزار Marketplace» ابزاری است که به شما امکان می‌دهد برنامه‌تان را در Marketplace ایجاد و کنترل کنید. از «کیت توسعه نرم‌افزار بازار» برای مدیریت تنظیمات «بازار» مثل موارد زیر استفاده می‌کنید:
- برنامه شما برای سازمان Google Workspace خاصی دردسترس است (برنامه خصوصی)، یا برای همه کاربران Marketplace دردسترس است (برنامه عمومی)
- انواع کاربران Marketplace که می‌توانند برنامه شما را نصب کنند
- برنامه(های) Google Workspace که برنامه‌تان با آن‌ها یکپارچه می‌شود
- حوزه‌های OAuth که برنامه شما نیاز دارد
- اطلاعات درباره اینکه چه کسی برنامه را ساخته و نگهداری می‌کند
صرف‌نظر از اینکه برنامه‌تان را به‌صورت خصوصی یا عمومی منتشر می‌کنید، باید از «کیت توسعه نرم‌افزار Marketplace» برای مدیریت برنامه‌تان در Marketplace استفاده کنید.
فعال کردن کیت توسعه نرم‌افزار «بازار»
اگر قبلاً این کار را نکرده‌اید، در پروژه Google Cloud خود، Marketplace SDK را فعال کنید.
پروژه Cloud خود را در کنسول Google Cloud باز کنید
اگر ازقبل باز نیست، «پروژه ابری» موردنظرتان را برای استفاده در این نمونه باز کنید:
- در کنسول Google Cloud، به صفحه انتخاب پروژه بروید.
- پروژه Google Cloud موردنظرتان را برای استفاده انتخاب کنید. یا روی ایجاد پروژه کلیک کنید و دستورالعمل‌های روی صفحه را دنبال کنید. اگر پروژه Google Cloud ایجاد کنید، ممکن است لازم باشد صورت‌حساب را برای پروژه روشن کنید.
روشن کردن «کیت توسعه نرم‌افزار بازار»
قبل‌از استفاده از «میاناهای برنامه‌سازی کاربردی Google»، باید آن‌ها را در پروژه Google Cloud روشن کنید. می‌توانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.در کنسول Google Cloud، کیت توسعه نرم‌افزار Google Workspace Marketplace را فعال کنید.
تنظیمات پیکربندی برنامه را تعیین کنید
مرجع زیر تنظیمات دردسترس در صفحه پیکربندی برنامه کیت توسعه نرم‌افزار «بازار» را شرح می‌دهد.
انتخاب کنید چه کسانی بتوانند برنامه‌تان را ببینند و نصب کنند
وقتی برنامه‌تان را پیکربندی می‌کنید، کاربرانی را که می‌توانند بااستفاده از تنظیمات زیر به برنامه‌تان دسترسی داشته باشند مشخص می‌کنید:
- رؤیت‌پذیری برنامه: اگر برنامه‌ای را در سازمان Google Workspace منتشر می‌کنید، فهرستگان برنامه شما ناموجود است، برای همه کاربران سازمانتان قابل‌مشاهده است، یا برای هر کسی که از Google Workspace استفاده می‌کند.
- تنظیمات نصب: اینکه آیا برنامه فقط می‌تواند توسط سرپرستان Google Workspace نصب شود.
صرف‌نظر از تنظیماتی که در فهرستگان برنامه‌تان مشخص می‌کنید، کاربرانی که متعلق به سازمان Google Workspace هستند ممکن است براساس تنظیمات تعیین‌شده توسط سرپرستانشان نتوانند برنامه شما را پیدا، نصب، یا استفاده کنند. سرپرستان می‌توانند به روش‌های زیر بر دردسترس بودن برنامه شما تأثیر بگذارند:
- کنترل کنید که آیا کاربرانش بتوانند برنامه‌ها را در Marketplace ببینند و برنامه‌ها را ازطرف کاربرانشان نصب کنند یا نه.
- از فهرست مجازها برای مدیریت و گلچین کردن برنامه‌ها برای سازمانشان استفاده کنند. اگر برنامه‌ای برای سازمانی توسعه می‌دهید که از فهرست مجاز استفاده می‌کند، با سرپرست درباره افزودن برنامه به فهرست مجاز مشورت کنید.
- برنامه‌های خاصی از Google Workspace را خاموش کنید، مثلاً دسترسی به Google Chat، برنامه‌های Google Chat، یا هر دو را بردارید. در این موارد، کاربران نمی‌توانند برنامه شما را از Marketplace نصب کنند.
برای آشنایی با نحوه مدیریت دسترسی به Marketplace توسط سرپرستان، راهنمای سرپرست Marketplace را ببینید.
تنظیمات رؤیت‌پذیری برنامه
اگر از حساب Google Workspace (حسابی که سازمان محل کار یا تحصیلتان ایجاد کرده است) استفاده می‌کنید، گزینه نمایان بودن برنامه را می‌بینید. اگر از حساب مصرف‌کننده (حسابی که به «@gmail.com» ختم می‌شود) استفاده می‌کنید، فقط می‌توانید به‌صورت عمومی منتشر کنید.
- عمومی: افراد خارج از دامنه‌تان می‌توانند برنامه را پیدا و نصب کنند. اگر نمایان بودن عمومی را انتخاب کنید، Google فهرستگان برنامه‌تان را قبل‌از انتشار مرور و تأیید می‌کند.
- خصوصی: فقط افراد داخل دامنه‌تان می‌توانند برنامه شما را پیدا و نصب کنند.
اگر انتخاب کنید که به‌عنوان فهرست‌نشده منتشر شود، فهرستگان برنامه در نتایج مرور یا جستجو نشان داده نمی‌شود. کاربران فقط با نشانی وب مستقیم می‌توانند به صفحه فروشگاه برنامه دسترسی داشته باشند.
اگر می‌خواهید کشورها و مناطقی را که برنامه‌تان در آن‌ها دردسترس است محدود کنید، این تنظیم را در بخش توزیع هنگام ایجاد فهرستگان فروشگاه انجام دهید.
تنظیمات نصب برنامه
گزینه تنظیمات نصب تعیین می‌کند که آیا کاربران یا سرپرستان Google Workspace می‌توانند برنامه شما را از صفحه فهرستگان فروشگاه شما در Marketplace نصب کنند یا نه.
- نصب فردی + سرپرست (پیش‌فرض): برنامه می‌تواند توسط کاربران فردی یا توسط سرپرستان برای دامنه، واحد سازمانی، یا گروهی از کاربران نصب شود. خط‌مشی‌های دامنه کاربر ممکن است مانع از نصب برنامه توسط او شود، حتی اگر نصب‌های فردی فعال باشد.
- نصب فقط سرپرست: برنامه را فقط سرپرستان می‌توانند برای دامنه، واحد سازمانی، یا گروه کاربرانشان نصب کنند. برنامه شما فقط در نتایج جستجوی «بازار کار Google Workspace» برای سرپرستان و افرادی که به سیستم «حساب Google» خود وارد نشده‌اند نشان داده می‌شود. اگر برنامه شما به نصب دامنه نیاز دارد، این گزینه را انتخاب کنید.
تنظیمات مشترک نصب و رؤیت‌پذیری
جدول زیر برخی‌از گزینه‌های پیکربندی برنامه رایج برای نصب و رؤیت‌پذیری را خلاصه می‌کند:
| کاربران برنامه موردنظر | تنظیم رؤیت‌پذیری برنامه | تنظیم نصب برنامه | چه کسانی می‌توانند برنامه من را نصب کنند؟ | چه کسانی می‌توانند از برنامه من استفاده کنند؟ | |
|---|---|---|---|---|---|
| برای برنامه‌هایی که برای سازمان Google Workspace ساخته شده‌اند | |||||
| کاربران خاص در سازمان شما | خصوصی و فهرست‌نشده | نصب فردی + سرپرست | درصورت مجاز بودن، هر کسی در سازمانتان که نشانی وب فهرستگان برنامه را داشته باشد. | درصورت مجاز بودن، هر کسی در سازمانتان که نشانی وب فهرستگان برنامه را داشته باشد. | |
| سازمان شما | خصوصی | نصب فردی + سرپرست | درصورت مجاز بودن، هر کسی در سازمانتان. | درصورت مجاز بودن، هر کسی در سازمانتان. | |
| سازمان شما | خصوصی | فقط سرپرست | سرپرست‌ها | کاربرانی که برنامه را سرپرستشان نصب کرده است. | |
| برای برنامه‌های دردسترس کاربران خارج از سازمان Google Workspace خاص | |||||
| کاربران در سازمان‌های Google Workspace | عمومی | فقط سرپرست | سرپرست‌ها | کاربرانی که برنامه را سرپرستشان نصب کرده است. | |
| همه کاربران Google Workspace | عمومی | نصب فردی + سرپرست |
|
|
|
مشخص کنید که برنامه‌تان چگونه با برنامه‌های Google Workspace ادغام می‌شود
گزینه ادغام‌های برنامه به شما امکان می‌دهد سرویس‌های Google Workspace را که برنامه یا برافزایتان برای کار با آن‌ها طراحی شده است انتخاب کنید، مانند برافزای Google Workspace یا برنامه Google Chat. باید حداقل یک گزینه را انتخاب کنید. در برخی موارد، می‌توانید چندین یکپارچه‌سازی برنامه را در فهرستگان برنامه‌تان بگنجانید. فهرست یکپارچه‌سازی‌های برنامه با هم را ببینید.
برای هر برافزای Google Workspace، صفحه وضعیت منتشرشده برای هر محصول میزبان پشتیبانی‌شده را نمایش می‌دهد. این کار به شما کمک می‌کند بفهمید کدام یکپارچه‌سازی‌ها برای کاربران شما دردسترس است. وضعیت‌های یکپارچه‌سازی برنامه زیر امکان‌پذیر است:
-
Unsaved: یکپارچه‌سازی را اضافه یا اصلاح کرده‌اید، اما تغییرات را در برگه «پیکربندی برنامه» ذخیره نکرده‌اید. Draft: تغییرات شما ذخیره شده است اما منتشر نشده است.-
Under review: ادغام برنامه به‌روزشده‌تان را برای مرور ارسال کردید. -
Published: ادغام برنامه شما در فهرستگان «بازارچه» اضافه شده است.
بسته به اینکه کدام یکپارچه‌سازی‌های برنامه را انتخاب می‌کنید، ممکن است لازم باشد اطلاعات بیشتری ارائه کنید و میاناهای برنامه‌سازی کاربردی مربوطه را در پروژه Google Cloud خود فعال کنید. جدول زیر راه‌اندازی اضافی موردنیاز برای هریک را شرح می‌دهد:
برافزای Google Workspace
برای انتشار برافزای Google Workspace، باید شناسه استقرار برافزا را ارائه دهید.
برای پیدا کردن شناسه استقرار در Apps Script، این مراحل را دنبال کنید:
- برافزای Google Workspace خود را در ویرایشگر Apps Script باز کنید.
- روی استقرار > مدیریت استقرارها کلیک کنید.
- در زیر شناسه استقرار، روی کپی کردن کلیک کنید.
برای پیدا کردن شناسه استقرار افزونه HTTP، این مراحل را دنبال کنید:
- در صفحه «پیکربندی برنامه» در بخش «برافزای Google Workspace»، روی HTTP یا دیگر استقرارها > انتخاب استقرار کلیک کنید.
- استقرار موردنظرتان را برای انتشار انتخاب کنید.
- روی انتخاب کلیک کنید.
برافزای ویرایشگر («سندنگار»، «کاربرگ‌نگار»، «اسلایدنگار»، «فرم‌نگار»)
برای انتشار یک برافزای «ویرایشگر»، باید شناسه فایل نوشتاری پروژه و نسخه موردنظرتان را برای انتشار ارائه دهید.
برای پیدا کردن شناسه دستورگان پروژه، این مراحل را دنبال کنید:
- برافزا را در ویرایشگر Apps Script باز کنید.
- در سمت راست، روی تنظیمات پروژه کلیک کنید.
- در بخش «شناسه‌ها»، شناسه نوشتار را کپی کنید.
برای پیدا کردن نسخه، این مراحل را دنبال کنید:
- برافزا را در ویرایشگر Apps Script باز کنید.
- در بالا سمت چپ، روی استقرار > مدیریت استقرارها کلیک کنید.
- شماره نسخه در بخش «پیکربندی» قرار دارد.
برنامه Google Chat
برای انتشار برنامه تعاملی Google Chat، به اسناد زیر مراجعه کنید:
- برای پیکربندی برنامه Chat در Chat API، به پیکربندی Chat API مراجعه کنید.
- اگر برنامه Chat ساخته‌اید که برافزای Google Workspace نیست، باید تنظیمات رویداد تعامل را در Chat API پیکربندی کنید. برای مراحل، به دریافت و پاسخ به تعاملات کاربر مراجعه کنید.
- اگر برنامه Chat خود را با پیکربندی خودکار AppSheet ساخته‌اید، برنامه Chat خود را بااستفاده از مراحل توضیح‌داده‌شده در اسناد AppSheet، هم‌رسانی برنامه Chat بااستفاده از پیکربندی خودکار منتشر کنید.
برنامه Drive
برای انتشار برنامه Drive، باید Google Drive API را فعال و پیکربندی کنید.
برنامه وب
برای انتشار برنامه وب، باید نشانی وب پیمایش جهانی آن را ارائه دهید، نشانی وبی که از منو برنامه‌های Google به برنامه وب اشاره می‌کند. برنامه وب شما باید در مرحله تولید باشد و کاملاً کار کند.
وقتی صفحه «فهرستگان فروشگاه» را تکمیل می‌کنید، باید نمادهای اضافی با اندازه ۹۶x۹۶ و ۴۸x۴۸ پیکسل ارائه دهید.
اگر برنامه وب خود را در Apps Script ساخته‌اید، این مراحل را برای دریافت نشانی وب پیمایش جهانی دنبال کنید:
- برافزای Google Workspace خود را در ویرایشگر Apps Script باز کنید.
- روی استقرار > استقرار جدید کلیک کنید.
- در بخش «انتخاب نوع»، روی برنامه وب کلیک کنید.
- گزینه‌ها را تکمیل کنید و روی استقرار کلیک کنید.
- روی کپی کردن کلیک کنید.
سطح دسترسی موردنیاز برنامه‌تان را مشخص کنید
در بخش محدوده‌های OAuth، فهرست کاملی از محدوده‌های OAuth 2.0 که برنامه‌تان به آن‌ها نیاز دارد ارائه دهید. محدوده‌های OAuth که در اینجا وارد می‌کنید باید با آنچه در صفحه کسب رضایت OAuth و درصورت لزوم، مانیفست Apps Script نمایش می‌دهید مطابقت داشته باشد.
اگر بیش از یک یکپارچه‌سازی برنامه اضافه می‌کنید، مطمئن شوید حوزه‌های هریک از آن‌ها را به صفحه «پیکربندی برنامه کیت توسعه نرم‌افزار Marketplace» و صفحه کسب رضایت OAuth اضافه کنید.
همیشه از محدودترین حوزه‌های ممکن استفاده کنید (برای مثال، اگر فقط به حوزه فقط‌خواندنی نیاز دارید، حوزه کامل Drive را اضافه نکنید).
برای پروژه‌های Apps Script، برای جزئیات بیشتر به محدوده‌های مجوز مراجعه کنید.
ارائه اطلاعات درباره توسعه‌دهنده نرم‌افزار
در بخش اطلاعات توسعه‌دهنده، اطلاعات تماس و جزئیات دیگر را تکمیل کنید. این فیلدها در صفحه فهرستگان فروشگاه برنامه شما نشان داده می‌شود.
| فیلدها | |
|---|---|
| وضعیت معامله‌گر |
به‌دلیل قوانین محافظت از مصرف‌کننده، مصرف‌کنندگان ساکن در «منطقه اقتصادی اروپا» (EEA) باید مطلع شوند که فروشنده در «بازار» تاجر است یا غیرتاجر:
اگر مشخص نشده باشد، «وضعیت تاجر مشخص نشده است» در صفحه فهرستگان فروشگاه برنامه شما نشان داده می‌شود. |
| نام توسعه‌دهنده | نامی که به‌عنوان نویسنده برنامه نمایش داده می‌شود. اگر تاجر هستید، نام تجاری یا نام قانونی‌تان را ارائه دهید. |
| نشانی پستی توسعه‌دهنده |
برای معامله‌گران الزامی است. برای غیرتاجران جمع‌آوری نمی‌شود. مکان کسب‌وکارتان. نشانی پستی معتبری وارد کنید که بتوان ازطریق آن با شما تماس گرفت. |
| نشانی وب‌سایت توسعه‌دهنده | وب‌سایتی که شما (یا سازمانتان) را به‌عنوان توسعه‌دهنده توصیف می‌کند. |
| ایمیل توسعه‌دهنده |
نشانی ایمیلی که باید به‌عنوان نقطه تماس استفاده شود. این در فهرستگان برنامه شما گنجانده نشده است. مطمئن شوید که این نشانی ایمیل به‌روز باشد زیرا از آن برای موارد زیر استفاده می‌شود:
|
| نشانی وب‌سایت برنامه | اختیاری. وب‌سایتی که برنامه شما را بیشتر توصیف می‌کند. |
ذخیره تنظیمات پیکربندی برنامه در «کیت توسعه نرم‌افزار Marketplace»
بااستفاده از اطلاعات بخش قبلی، پیکربندی برنامه‌تان را در «کیت توسعه نرم‌افزار بازار» ذخیره کنید:
در کنسول Google Cloud، به صفحه Marketplace SDK پیکربندی برنامه بروید:
هر بخش را براساس آنچه در بخش قبلی تعیین کرده‌اید تکمیل کنید.
روی ذخیره پیش‌نویس کلیک کنید.
(اختیاری) می‌توانید در Google Analytics درباره استفاده از برنامه تجزیه‌وتحلیل دریافت کنید. برای انجام این کار، شناسه Google Analytics را در کیت توسعه نرم‌افزار Marketplace اضافه کنید.
- به زبانه Analytics بروید.
- شناسه Google Analytics خود را وارد کنید.
- روی ذخیره کلیک کنید.
عیب‌یابی
این بخش مشکلات رایجی را که ممکن است با آن‌ها مواجه شوید شرح می‌دهد.
هنگام انتشار برنامه‌ها در «بازار»، اجازه‌های لازم وجود ندارد
نمی‌توانید برنامه‌ها را در Marketplace منتشر کنید زیرا تلاش‌ها برای پیکربندی برنامه در صفحه «پیکربندی برنامه» کیت توسعه نرم‌افزار Marketplace با پیام خطای زیر ناموفق است:
You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update
این خطا زمانی رخ می‌دهد که Marketplace SDK API فعال باشد
و هنگام استفاده از نقش IAM غیراز Editor یا Owner.
برای رفع خطا، یکی از راه‌حل‌های زیر را پیاده‌سازی کنید:
از مالک پروژه بخواهید نقش
roles/appmetadata.workspaceMarketplaceAppConfigurationAdminرا به حساب دارای اجازه‌های ازدست‌رفته اختصاص دهد تا به آن اجازه دهد برنامه را در Marketplace SDK پیکربندی و مدیریت کند.از مالک پروژه بخواهید اجازه‌های ازدست‌رفته را ازطریق صفحه مدیریت هویت و دسترسی و سرپرست > نقش‌ها در کنسول Google Cloud به نقش سفارشی اضافه کند. سپس نقش سفارشی را به حسابی که اجازه‌های لازم را ندارد اختصاص دهید.
از
roles/editorیاroles/ownerاولیه می‌توان برای انتشار برنامه‌ها استفاده کرد. بااین‌حال، مستندات استفاده ایمن از IAM این رویه بد را درنظر می‌گیرد زیرا نمی‌توان به‌راحتی دسترسی ویرایش به منابع دیگر در پروژه را محدود کرد.