לפני שמתחילים לבצע קריאות ל-API, יש להגדיר גישת API לחשבון הפיתוח שלכם ב-Google Play. לשם כך, נדרשים שינויים גם ב-Google Play Console וגם ב-Google Cloud Console. ההוראות הבאות מסבירות את ארבעת השלבים הנדרשים כדי להתחיל להשתמש ב-Google Play Developer API.
- לקשר את חשבון הפיתוח לפרויקט חדש או קיים ב-Google Cloud.
- עליך להפעיל את Google Play Developer API עבור הפרויקט המקושר ב-Google Cloud.
- יש לאשר מפתח API ל-Google Play Developer API בפרויקט Google Cloud המקושר.
- יש להגדיר חשבון שירות עם הרשאות מתאימות של Google Play Console כדי לגשת ל-Google Play Developer API.
קישור החשבון והפרויקט
כדי לקבל גישה ל-Google Play Developer API, עלייך לקשר את חשבון הפיתוח שלך ב-Google Play לפרויקט ב-Google Cloud. ברוב המקרים, מומלץ ליצור פרויקט חדש ב-Google Cloud המוקדש לחשבון הפיתוח שלכם ב-Google Play, אבל אפשר לקשר פרויקט קיים. חשוב לזכור שאפשר לקשר כל חשבון פיתוח ב-Google Play רק לפרויקט אחד ב-Google Cloud. אם יש לכם כמה אפליקציות באותו חשבון פיתוח ב-Google Play, לכולם צריך להיות אותו פרויקט ב-Google Cloud.
יצירת פרויקט חדש
- נכנסים לדף גישה ל-API ב-Google Play Console.
- לוחצים על יצירת פרויקט חדש.
הפרויקט ב-Google Cloud נוצר באופן אוטומטי, והוא מקושר לחשבון הפיתוח שלכם ב-Google Play.
שימוש בפרויקט קיים
אם אתם כבר משתמשים ב-Google Cloud Console, תוכלו לבצע קישור לפרויקט הקיים שלכם ב-Google Cloud על ידי ביצוע השלבים הבאים:
- נכנסים לדף גישה ל-API ב-Google Play Console.
- בוחרים את הפרויקט שרוצים לקשר. אם הפרויקט לא מופיע ברשימה, צריך לוודא שחשבון המשתמש מוגדר כבעלים בפרויקט ב-Google Cloud שרוצים לקשר.
- לוחצים על קישור פרויקט קיים.
הפעלת ה-API
אחרי שמגדירים את הפרויקט ב-Google Cloud, צריך להפעיל את Google Play Developer API לפרויקט הזה. כדי לעשות את זה, אתם צריכים להיות הבעלים של הפרויקט ב-Google Cloud.
- נכנסים לדף גישה ל-API ב-Google Play Console.
- בקטע ממשקי API, מוצאים את ה-Google Play Developer API ולוחצים על הפעלה.
פעולה זו מעדכנת ישירות את הפרויקט ב-Google Cloud והשינוי נכנס לתוקף באופן מיידי.
אישור מפתח API
כדי להשתמש ב-API, נדרש מפתח API בפרויקט המקושר ב-Google Cloud, המורשה להשתמש ב-Google Play Developer API. תוכלו להגדיר זאת ב-Google Play Console.
הגדרת חשבונות OAuth ושירות
יש להגדיר את הגישה ל-Google Play Developer API באמצעות לקוח OAuth או חשבון שירות. ברוב המקרים, צריך להשתמש בחשבון שירות כדי לגשת ל-API.
יש להשתמש בחשבונות שירות בסביבה מאובטחת, כמו השרת שלכם. הניהול של פרטי הכניסה לחשבון השירות צריך להתבצע באופן מאובטח, כך שלא יהיה גלוי לאף אחד שלא מורשה להשתמש ב-API.
יש להשתמש ב-Client-ID של OAuth אם אתם צריכים לגשת ל-API בשם משתמש ספציפי. לדוגמה, אם האתר שלכם צריך לגשת ל-Google Play Developer API מלקוח האינטרנט, בשם המשתמש, תוכלו להשתמש במזהה הלקוח. המשתמשים יאומתו באמצעות חשבון Google שלהם במקום חשבון השירות. כך תוכלו לבצע קריאות ל-API בשם משתמש מבלי לפגוע בפרטי הכניסה לחשבון השירות.
- חשבון שירות: שירות תוכנה מאובטח יקבל גישה ל-API (השיטה הנפוצה ביותר)
- לקוחות OAuth: משתמש יקבל גישה ל-API
שימוש בחשבון שירות
תוכלו ליצור חשבון שירות מ-Google Play Console.
- נכנסים לדף גישה ל-API ב-Google Play Console.
- בקטע חשבונות שירות, לוחצים על כך יוצרים חשבונות שירות.
מבצעים את ההוראות ליצירת חשבון שירות.
במהלך יצירת החשבון, תצטרכו לתת לחשבון השירות גישה לפרויקט ב-Google Cloud, כדי שהוא יופיע ב-Google Play Console.
אחרי שיוצרים את חשבון השירות ב-Google Play Console, לוחצים על Done. הקטע 'חשבונות שירות' שבדף גישה ל-API מתרענן באופן אוטומטי, וחשבון השירות שלכם רשום.
לוחצים על הענקת גישה כדי לספק לחשבון השירות את הזכויות הדרושות לביצוע הפעולות.
כדי להשתמש בממשקי ה-API של החיוב ב-Google Play, צריך להעניק את ההרשאות הבאות:
- הצגת נתונים פיננסיים, הזמנות ותגובות לסקרים בנושא ביטול
- ניהול הזמנות ומינויים
בשלב הזה צריכה להיות לך גישה ל-Google Play Developer API דרך חשבון השירות. אפשר לקרוא מידע נוסף במאמר שימוש ב-OAuth 2.0 לשרת של אפליקציות.
שימוש בלקוחות OAuth
ניתן לאפשר למשתמשים לבצע פעולות באמצעות ה-API באמצעות פרטי הכניסה שלהם, באמצעות לקוח OAuth. הפעולות שהמשתמש מבצע מוגבלות לפעולות שמופיעות בדף משתמשים והרשאות ב-Google Play Console.
לפני שיוצרים לקוחות OAuth, צריך להגדיר את פרטי המיתוג של המוצר. למידע נוסף, ניתן לעיין במאמר הגדרה של מסך הסכמה ל-OAuth.
- נכנסים לדף גישה ל-API ב-Google Play Console.
- בקטע לקוחות OAuth, לוחצים על הגדרת מסך הסכמה ל-OAuth.
- מגדירים את פרטי המיתוג של המוצר.
- בסיום, לוחצים על רענון הסכמה ל-OAuth. הקטע יתעדכן ולא תקבלו יותר את ההודעה לגבי פרטי המיתוג.
כדי ליצור לקוח OAuth באמצעות Google Play Console:
- נכנסים לדף גישה ל-API ב-Google Play Console.
- בקטע לקוחות OAuth, לוחצים על יצירת לקוח OAuth חדש.
- פועלים לפי ההוראות המפורטות בדף כדי ליצור לקוח OAuth.
אחרי שיוצרים את לקוח ה-OAuth ב-Google Play Console, לוחצים על Done. הקטע לקוחות OAuth בדף גישה ל-API מתרענן באופן אוטומטי, ולקוח ה-OAuth מופיע ברשימה.
לפעמים לקוח ה-OAuth החדש לא מופיע בדף באופן מיידי. במקרה כזה, לוחצים על רענון לקוחות OAuth.
הפרטים של לקוח ה-OAuth החדש מוצגים ברשימה בדף הזה.
מידע נוסף
הטיפים והטריקים הבאים יעזרו לכם להתחיל להשתמש בממשק ה-API ב-Google Play.
קבלת מזהה המפתח שלך
ממשקי API מסוימים מחייבים אותך לספק מזהה מפתח ל-Google Play Console. זהו מספר ארוך שהוקצה כשנוצר חשבון הפיתוח שלך ב-Google Play. מזהה המפתח נמצא בכתובת ה-URL של כל דף ב-Google Play Console, למשל, הדף גישה ל-API.
לדוגמה, נניח שכתובת ה-URL של Google Play Console:
https://play.google.com/console/developers/1234567890123456789/api-access
בכתובת ה-URL שלמעלה, מזהה המפתח יהיה 1234567890123456789
.
הערה: אם אפליקציה מועברת מחשבון פיתוח אחד ב-Google Play לחשבון אחר, מזהה המפתח שמשויך לאפליקציה משתנה. כלומר, לאחר השלמת ההעברה, עליכם להשתמש במזהה המפתח של חשבון הפיתוח החדש ב-Google Play בקריאות ל-API של האפליקציה.
ממשקי API מיוחדים
ממשק ה-API של Google Play למפתחים מכיל כמה ממשקי API מיוחדים שמאפשרים לבצע סוגים ספציפיים של ניתוח באפליקציה:
- מענה API של ביקורות
- מאפשרת לך להציג משוב ממשתמשים לגבי האפליקציה ולהשיב למשוב הזה.
- Void Purchases API
- אפשר לבטל את הגישה למוצרים מתוך האפליקציה שמשויכים לרכישות שהמשתמש ביטל.
ספריות לקוח
סיפקנו ספריות לקוח שבהן אפשר להשתמש כדי לגשת באופן פרוגרמטי לממשקי API של REST. למידע נוסף, עיינו בספריות לקוח ודוגמאות קוד.