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