המדריך הזה מיועד למפתחים שרוצים להשתמש ב-AdMob API כדי לקבל מידע באופן פרוגרמטי על חשבון AdMob שלהם.
כל הקריאות ל-Google AdMob API חייבות לקבל אישור דרך OAuth2, כדי שהאפליקציה תוכל לקיים אינטראקציה עם שירותי אינטרנט בשמו של המשתמש. OAuth2 מאפשר לאפליקציית הלקוח של AdMob API לגשת לחשבון AdMob של משתמש בלי שתצטרכו לטפל בשם המשתמש או בסיסמה שלו או לשמור אותם. כאן תוכלו לקרוא סקירה כללית על ההרשאות.
כדי ליצור את פרטי הכניסה של OAuth2 ולשלוח את הבקשה הראשונה, מבצעים את הפעולות הבאות.
דרישות מוקדמות
קביעת סוג האימות
בטבלה שבהמשך תוכלו לראות איזה סוג אימות הכי מתאים לאפליקציה שלכם:
בחירת סוג האימות של OAuth2 | אם ... |
---|---|
אפליקציה למחשב |
|
אפליקציית אינטרנט |
|
יוצרים פרויקט
כדי להתחיל להשתמש ב-AdMob API, תחילה צריך ליצור או לבחור פרויקט ב-Google API Console ולהפעיל את ה-API באמצעות כלי ההגדרה, שמדריך אתכם בתהליך ומפעיל את AdMob API באופן אוטומטי.
הפעלת ה-API לפרויקט קיים
השלבים הבאים רלוונטיים למשתמשים שיש להם פרויקט קיים שמעדיפים להפעיל עבורו את AdMob API באופן ידני.
כדי לאפשר ממשק API לפרויקט שלך:
- Open the API Library ב Google API Console .
- If prompted, select a project, or create a new one. API Library מפרט את כל ה- APIs הזמינים, מקובצים לפי משפחת מוצרים ופופולריות.
- אם ממשק ה- API שברצונך להפעיל אינו גלוי ברשימה, השתמש בחיפוש כדי למצוא אותו או לחץ על הצג הכל במשפחת המוצרים שאליה הוא שייך.
- בחר בממשק ה- API שברצונך להפעיל ולחץ על כפתור הפעל .
- If prompted, enable billing.
- If prompted, read and accept the API's Terms of Service.
יצירת פרטי כניסה של OAuth2
בהוראות הבאות מוסבר איך ליצור מזהה לקוח ב-OAuth 2.0 לשימוש בתהליך האפליקציה שהותקנה.
- Go to the Credentials page.
לוחצים על CREATE CREDENTIALS > OAuth Client ID.
אם לא הגדרתם מסך הסכמה ל-OAuth לפרויקט הזה בעבר, תופנו לעשות זאת עכשיו. לוחצים על הגדרת מסך ההסכמה. יש כמה דרכים להגדיר את מסך ההסכמה כך שישתמש במזהה הלקוח ב-OAuth 2.0.
- מגדירים את סוג המשתמש כExternal ואת סטטוס הפרסום ל-Publish (פורסם).
לחלופין, מגדירים את סוג המשתמש כExternal ואת סטטוס הפרסום לבדיקה, ומוסיפים את האפשרות משתמשים לבדיקה על ידי בחירה באפשרות הוספת משתמשים כדי לתת להם הרשאת גישה לשימוש במזהה הלקוח שלכם ב-OAuth 2.0.
למידע נוסף על הגדרת מסך ההסכמה ל-OAuth.
בוחרים את סוג האפליקציה אפליקציית שולחן העבודה או אפליקציית אינטרנט, נותנים לה שם ולוחצים על יצירה.
בסיום התהליך יוצגו לכם מזהה לקוח וסוד לקוח של OAuth 2.0, שאפשר להוריד בפורמט JSON ולשמור אותם לשימוש במועד מאוחר יותר.
יצירת בקשה
ממשק AdMob API מבוסס על HTTP ועל JSON, כך שכל לקוח HTTP סטנדרטי יכול לשלוח אליו בקשות ולנתח את התשובות. עם זאת, ספריות הלקוח של Google API מספקות שילוב טוב יותר של שפות, אבטחה משופרת ותמיכה בשליחת בקשות מורשות. ספריות הלקוח זמינות בכמה שפות תכנות. כשמשתמשים בהן אפשר להימנע מהצורך להגדיר בקשות HTTP ולנתח את התשובות באופן ידני.
לאחר יצירת פרטי כניסה של OAuth 2.0, תוכלו להתחיל להשתמש ב-AdMob API. כדי לבקש גישה באמצעות OAuth 2.0, לאפליקציה שלכם נדרשים גם פרטי ההיקף:
היקף | משמעות |
---|---|
https://www.googleapis.com/auth/admob.readonly |
הצגת כל הנתונים ב-AdMob. הנתונים האלה יכולים לכלול פרטי חשבון, הגדרות של מלאי שטחי פרסום ותהליך בחירת הרשת (Mediation), דוחות ונתונים אחרים. לא ייקרא מידע אישי רגיש כמו פרטי תשלומים או פרטי קמפיינים. |
https://www.googleapis.com/auth/admob.report |
לראות את דוחות הרווחים וביצועי המודעות. הצגת מזהה בעל האפליקציה, אזור הזמן וקוד המטבע שמוגדר כברירת מחדל. |
הבקשה הראשונה ליצירת דוח מתבצעת באמצעות דוגמאות ב-Java, PHP, Python או curl.
ביטול אסימונים משותפים
יש שתי דרכים לבטל אסימונים משותפים:
עוברים אל דף ההרשאות בחשבון Google ומבטלים את הגישה מהפרויקט הרלוונטי.
לחלופין, אפשר לבטל אסימונים של אפליקציות אינטרנט באמצעות Google Identity API.