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

رابط برنامه‌نویسی کاربردی کاتالوگ بازی، فروشگاه‌های اپلیکیشن شخص ثالث (3PAS) ثبت‌شده در گوگل پلی را قادر می‌سازد تا برای به‌روزرسانی‌های کاتالوگ اپلیکیشن گوگل پلی نظرسنجی کنند. تماس‌گیرندگان می‌توانند جزئیات کاتالوگ را برای برنامه‌هایی که از آخرین خروجی کاتالوگ روزانه اصلاح یا حذف شده‌اند، بازیابی کنند.

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

قبل از شروع

قبل از اینکه بتوانید API کاتالوگ Play را فراخوانی کنید، باید راهنمای شروع به کار اصلی را برای تنظیم دسترسی به API، اعتبارنامه‌های سرویس و پروژه Google Cloud خود تکمیل کنید.

طراحی و معماری API

خروجی کاتالوگ Play هر 24 ساعت یکبار ایجاد می‌شود. API کاتالوگ Play یک مکانیزم نظرسنجی درون‌روزی برای بازیابی به‌روزرسانی‌هایی که از آخرین خروجی رخ داده‌اند، ارائه می‌دهد:

  1. نظرسنجی برای رویدادهای به‌روزرسانی : شما از appstorecatalog.recentUpdateEvents.list به همراه پنجره‌های startTime و endTime پرس‌وجو می‌کنید تا ببینید کدام نام‌های بسته تغییر یافته یا حذف شده‌اند.
  2. دریافت جزئیات نماها : برای هر نام بسته‌ای که تغییر داده شده است، appstorecatalog.recentAppViews.get را برای دریافت جزئیات فراداده CatalogAppView فراخوانی می‌کنید.

این API فقط خواندنی است و محدود به بازگرداندن رویدادهایی است که در ۳۶ ساعت گذشته رخ داده‌اند. این API دارای محدودیت QPS برابر با ۲ است که بین هر دو روش مشترک است.

۱. نظرسنجی برای رویدادهای به‌روزرسانی کاتالوگ

برای بازیابی لیست بسته‌هایی که در یک بازه زمانی خاص تغییر کرده‌اند، متد appstorecatalog.recentUpdateEvents.list را فراخوانی کنید.

فقط رویدادهای به‌روزرسانی برای برنامه‌های واجد شرایط برگردانده می‌شوند. برنامه‌های واجد شرایط باید:

  • برای گنجاندن در کاتالوگ فروشگاه اپلیکیشن تماس، ثبت‌نام کردم.
  • منتشر شده و در ایالات متحده (ایالات متحده) در فروشگاه گوگل پلی در دسترس است.

درک انواع به‌روزرسانی

  • MODIFICATION : زمانی فعال می‌شود که یک برنامه واجد شرایط اصلاح شود، برای اولین بار منتشر شود، شروع به هدف قرار دادن ایالات متحده کند، یا زمانی که برنامه به تازگی به کاتالوگ شما پیوسته باشد.
  • DELETION : زمانی فعال می‌شود که یک برنامه منتشر نشده باشد، از فهرست برنامه‌ها حذف شده باشد، به حالت تعلیق درآمده یا مسدود شده باشد، یا دیگر در ایالات متحده فعالیت نداشته باشد.

۲. بازیابی نماهای برنامه کاتالوگ

برای هر بسته‌ای که با رویداد MODIFICATION برگردانده می‌شود، می‌توانید جزئیات کاتالوگ به‌روز شده‌ی آن را با فراخوانی متد appstorecatalog.recentAppViews.get دریافت کنید.

۳. بهترین شیوه‌ها و همگام‌سازی

برای حفظ یک پایگاه داده کاتالوگ منسجم در فروشگاه خود، این دستورالعمل‌های یکپارچه‌سازی را دنبال کنید:

  • همگام‌سازی خروجی روزانه : فهرست کامل برنامه‌های واجد شرایط را با استفاده از خروجی کاتالوگ روزانه وارد کنید.
  • (اختیاری) همگام‌سازی درون‌روزی : نقطه پایانی appstorecatalog.recentUpdateEvents.list را به‌طور منظم (مثلاً هر دقیقه) با یک پنجره زمانی متحرک، نظرسنجی کنید. مطمئن شوید که صفحه‌بندی را با استفاده از nextPageToken مدیریت می‌کنید.
    • به‌روزرسانی‌های فرآیند :
      • برای رویدادهای MODIFICATION ، با استفاده از appstorecatalog.recentAppViews.get CatalogAppView به‌روزرسانی‌شده را دریافت کرده و پایگاه داده محلی خود را به‌روزرسانی کنید.
      • برای رویدادهای DELETION ، برنامه را از فهرست فروشگاه خود حذف کنید یا آن را از کاربران پنهان کنید.
    • مدیریت رویدادهای اصلاح مکرر : ممکن است چندین رویداد اصلاح برای یک برنامه مشاهده کنید. این بدان معناست که برنامه چندین بار در پنجره زمان مورد نظر اصلاح شده است. appstorecatalog.recentAppViews.get همیشه نمای برنامه از آخرین اصلاح را برمی‌گرداند.