معرفی یک API فروشگاه وب Chrome جدید

منتشر شده: ۱۵ اکتبر ۲۰۲۵

از امروز، ما نسخه جدیدی (V2) از API فروشگاه وب کروم را منتشر می‌کنیم. استفاده از API جدید به طور قابل توجهی آسان‌تر شده است و از ویژگی‌هایی مانند حساب‌های سرویس پشتیبانی می‌کند که ادغام آن را با گردش‌های کاری سازمانی آسان‌تر می‌کند. ما همچنین قابلیت‌های بیشتری از جمله امکان کنترل درصد انتشار و لغو ارسال‌های در انتظار به صورت برنامه‌نویسی شده، اضافه کرده‌ایم.

یک API جدید بر اساس بازخورد توسعه‌دهندگان

API جدید با در نظر گرفتن بازخورد توسعه‌دهندگان ساخته شده است. ما تلاش کرده‌ایم تا نقاط پایانی و پاسخ‌های API را کاربرپسندتر کنیم.

ویژگی‌های جدید

ما همچنین ویژگی‌های جدیدی اضافه کرده‌ایم که قبلاً در API موجود نبودند.

دسترسی به وضعیت منتشر شده و پیش نویس آیتم

پیش از این، فقط امکان بازیابی آخرین نسخه پیش‌نویس برای یک آیتم وجود داشت. اکنون می‌توانید هم نسخه منتشر شده و هم نسخه در انتظار انتشار را بازیابی کنید.

curl -H "Authorization: Bearer $TOKEN" -X GET https://chromewebstore.googleapis.com/v2/publishers/PUBLISHER_ID/items/EXTENSION_ID:fetchStatus

این یک پاسخ شامل موارد زیر را برمی‌گرداند:

{
  ...,
  "publishedItemRevisionStatus": { ... },
  "submittedItemRevisionStatus": { ... },
  ...
}

لغو ارسال در حال انتظار

اکنون می‌توانید با استفاده از API، ارسال در حال انتظار را لغو کنید.

curl -H "Authorization: Bearer $TOKEN" -X POST https://chromewebstore.googleapis.com/v2/publishers/PUBLISHER_ID/items/EXTENSION_ID:cancelSubmission

اصلاح درصد انتشار

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

curl -H "Authorization: Bearer $TOKEN" -X POST -H "Content-Type: application/json" -d "{ "deployPercentage": 100 }" https://chromewebstore.googleapis.com/v2/publishers/PUBLISHER_ID/items/EXTENSION_ID:setPublishedDeployPercentage

پشتیبانی حساب کاربری خدمات

پیکربندی حساب کاربری سرویس در داشبورد توسعه‌دهندگان.
پیکربندی حساب کاربری سرویس در داشبورد توسعه‌دهندگان

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

یک آیتم را برای انتشار آماده کنید

پیش از این، نسخه‌های ارسالی با استفاده از API همیشه بلافاصله پس از گذراندن مرحله بررسی منتشر می‌شدند. اکنون، می‌توانید از فیلد publishType با STAGED_PUBLISH استفاده کنید - وقتی مورد شما از مرحله بررسی عبور می‌کند، مرحله‌بندی می‌شود و می‌تواند بعداً با استفاده از فراخوانی API دیگری یا به صورت دستی با استفاده از داشبورد توسعه‌دهنده منتشر شود.

ارگونومی بهبود یافته

API فروشگاه وب کروم اکنون یک سند اکتشاف منتشر می‌کند. این به شما امکان می‌دهد از طریق ابزارها و کتابخانه‌های مختلف گوگل با API تعامل داشته باشید. ما همچنین مفهوم بازبینی آیتم‌ها را به عنوان یک مفهوم اصلی در API به طور واضح‌تری تعریف کرده‌ایم که استفاده از API را آسان‌تر می‌کند و انعطاف‌پذیری بیشتری را برای روش‌های اضافی در آینده فراهم می‌کند.

مستندات بهبود یافته

مرجع API برای API فروشگاه وب کروم.
مرجع API برای API فروشگاه وب کروم.

ما مستندات مرجع API بسیار گسترده‌تری را منتشر کرده‌ایم که از همان ابزاری استفاده می‌کند که برای سایر APIهای گوگل استفاده می‌شود. این شامل کاوشگر API «امتحانش کنید!» نیز می‌شود که به شما امکان می‌دهد یک درخواست واحد را با استفاده از اعتبارنامه‌های حساب گوگل تأیید شده خود پیکربندی کنید.

زمین بازی OAuth

محدوده فروشگاه وب کروم در محیط OAuth 2.0 برجسته شده است.
محدوده فروشگاه وب کروم در محیط OAuth 2.0 برجسته شده است.

اکنون می‌توانید محدوده API فروشگاه وب کروم را در محیط OAuth 2.0 انتخاب کنید. این به شما امکان می‌دهد اعتبارنامه‌های آزمایشی را دریافت کرده و درخواست‌های API آزمایشی را در مرورگر انجام دهید. در حالی که این ابزار همیشه از API فروشگاه وب کروم پشتیبانی کرده است، محدوده‌ها و متدهای API به طور خودکار پیشنهاد نمی‌شوند.

کتابخانه‌های کلاینت گوگل

این به‌روزرسانی‌ها همچنین به این معنی است که API در نسخه‌های بعدی کتابخانه‌های کلاینت API گوگل در دسترس خواهد بود. این امر فراخوانی API را از زبان مورد نظر شما، از جمله جاوا اسکریپت، Node.js، پایتون و جاوا، آسان‌تر می‌کند.

چگونه مهاجرت کنیم

اکثر متدهای موجود در API نسخه ۱، متد معادلی در API نسخه ۲ دارند. کد خود را به‌روزرسانی کنید تا از نقاط پایانی و قالب درخواست جدید استفاده کند و پاسخ‌های به‌روزرسانی‌شده را مدیریت کند.

مورد استفاده نقطه پایانی API قدیمی نقطه پایانی API جدید
یک مورد دریافت کنید GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId GET https://chromewebstore.googleapis.com/v2/publishers/PUBLISHER_ID/items/EXTENSION_ID:fetchStatus
به‌روزرسانی یک مورد PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId POST https://chromewebstore.googleapis.com/upload/v2/publishers/PUBLISHER_ID/items/EXTENSION_ID:upload
انتشار یک مطلب POST https://www.googleapis.com/chromewebstore/v1.1/items/itemId/publish POST https://chromewebstore.googleapis.com/v2/publishers/PUBLISHER_ID/items/EXTENSION_ID:publish

می‌توانید درخواست‌های نمونه را در آموزش استفاده از API فروشگاه وب کروم و مستندات کامل روش‌های جدید را اینجا بیابید.

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

علاوه بر این، ما دیگر از تغییر میزان دیده شدن یک آیتم با استفاده از API پشتیبانی نمی‌کنیم. این کار برای اطمینان از تأیید هرگونه تغییر در میزان دیده شدن توسط توسعه‌دهنده در داشبورد توسعه‌دهندگان انجام می‌شود.

جدول زمانی مهاجرت

ما قصد داریم از API قدیمی تا ۱۵ اکتبر ۲۰۲۶ پشتیبانی کنیم، پس از آن برای ادامه ارسال درخواست‌ها باید به API نسخه ۲ مهاجرت کنید.

جمع بندی

ما واقعاً هیجان‌زده‌ایم که این تغییرات را با شما به اشتراک بگذاریم. مثل همیشه، اگر نظری دارید، لطفاً در فهرست پستی افزونه‌های کروم به ما اطلاع دهید.