מדריך למפתחים בנושא Play Catalog API

ממשק ה-API של קטלוג Play מאפשר לחנויות אפליקציות של צד שלישי (3PAS) שרשומות ב-Google Play לבדוק אם יש עדכונים לקטלוג האפליקציות של Google Play. פונקציות קריאה חוזרת יכולות לאחזר פרטים מהקטלוג לגבי אפליקציות שעברו שינוי או הוסרו מאז הייצוא היומי האחרון של הקטלוג.

רשימה מלאה של נקודות קצה, שיטות וסכימות משאבים מופיעה בהפניית Play Catalog API.

לפני שתתחיל

כדי לבצע קריאות ל-Play Catalog API, צריך להשלים את השלבים במדריך הראשי תחילת העבודה להגדרת הגישה ל-API, פרטי הכניסה לשירות ופרויקט Google Cloud.


API Design & Architecture

ייצוא קטלוג Play מתבצע כל 24 שעות. ‫Play Catalog API מספק מנגנון של שליחת בקשות (polling) במהלך היום כדי לאחזר עדכונים שבוצעו מאז הייצוא האחרון:

  1. שליחת שאילתות לגבי אירועי עדכון: שולחים שאילתה אל appstorecatalog.recentUpdateEvents.list עם חלון startTime ו-endTime כדי לגלות אילו שמות חבילות שונו או נמחקו.
  2. Fetch detailed views (אחזור תצוגות מפורטות): לכל שם חבילה ששונה, קוראים ל-appstorecatalog.recentAppViews.get כדי לאחזר את המטא-נתונים המפורטים של CatalogAppView.

ה-API הוא לקריאה בלבד, והוא מוגבל להחזרת אירועים שהתרחשו ב-36 השעות האחרונות. ל-API יש מגבלת QPS של 2 שמשותפת לשתי השיטות.


1. שאילתות לגבי אירועים של עדכון הקטלוג

כדי לאחזר את רשימת החבילות שהשתנו בחלון זמן מסוים, צריך להפעיל את השיטה appstorecatalog.recentUpdateEvents.list.

מוחזרים רק אירועי עדכון של אפליקציות שעומדות בדרישות. האפליקציות שעומדות בדרישות צריכות:

  • הבעת הסכמה להכללה בקטלוג של חנות האפליקציות שקוראת לקטלוג.
  • פורסם וזמין בארצות הברית (ארה"ב) בחנות Google Play.

הסבר על סוגי העדכונים

  • MODIFICATION: מופעל כשמשנים אפליקציה שעומדת בדרישות, כשמפרסמים אותה בפעם הראשונה, כשמתחילים לטרגט אותה בארה"ב או כשמצטרפים איתה לקטלוג שלכם.
  • DELETION: מופעל כשאפליקציה מבטלת את הפרסום שלה, מוציאה את עצמה מהקטלוג, מושעית או נחסמת, או מפסיקה לטרגט את ארה"ב.

2. אחזור נתונים של צפיות באפליקציות בקטלוג

לכל חבילה שמוחזרת עם אירוע MODIFICATION, אפשר לאחזר את פרטי הקטלוג המעודכנים שלה באמצעות קריאה לשיטה appstorecatalog.recentAppViews.get.


3. שיטות מומלצות וסנכרון

כדי לשמור על עקביות במסד הנתונים של הקטלוג בחנות, חשוב לפעול לפי הנחיות השילוב הבאות:

  • סנכרון ייצוא יומי: ייבוא של הרשימה המלאה של האפליקציות שעומדות בדרישות באמצעות ייצוא קטלוג יומי.
  • (אופציונלי) סנכרון במהלך היום: שליחת שאילתות לנקודת הקצה appstorecatalog.recentUpdateEvents.list באופן קבוע (למשל, כל דקה) עם חלון זמן משתנה. חשוב לוודא שאתם מטפלים בהחלפה בין דפים באמצעות nextPageToken.
    • עדכוני תהליך:
      • כדי לאחזר את CatalogAppView המעודכן של אירועים ב-MODIFICATION, משתמשים ב-appstorecatalog.recentAppViews.get ומעדכנים את מסד הנתונים המקומי.
      • במקרה של אירועים מסוג DELETION, צריך להסיר את האפליקציה מהרשימות בחנות או להסתיר אותה מהמשתמשים.
    • טיפול באירועי שינוי חוזרים: יכול להיות שיוצגו לכם כמה אירועי MODIFICATION לאותה אפליקציה. המשמעות היא שהאפליקציה שונתה כמה פעמים בחלון הזמן שנשלח לגביו שאילתה. ‫appstorecatalog.recentAppViews.get תמיד תחזיר את תצוגת האפליקציה של השינוי האחרון.