תחילת השימוש ב-AdMob API

המדריך הזה מיועד למפתחים שרוצים להשתמש ב-AdMob API כדי לקבל נתונים בחשבון AdMob שלהם באופן פרוגרמטי.

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

כדי ליצור את פרטי הכניסה ל-OAuth2 ולשלוח את הבקשה הראשונה, מבצעים את השלבים הבאים.

דרישות מוקדמות

איך קובעים את סוג האימות

בטבלה הבאה מפורט סוג האימות המתאים ביותר לאפליקציה שלכם:

בחירת סוג האימות של OAuth2 אם ...
אפליקציה למחשב
  • כל חשבונות AdMob API שלך מנוהלים באמצעות חשבון ניהול אחד ברמה העליונה.
  • אתם משתמשים בפעם הראשונה או שאתם רוצים להתחיל במהירות עם ההגדרה הפשוטה ביותר.
  • האפליקציה מאמתת משתמשי Google AdMob רק ממחשב אחד.
אפליקציית אינטרנט
  • אתם רוצים לבצע אימות כמשתמשים שיכולים להעניק לאפליקציה הרשאה לגשת לנתוני החשבון שלהם ב-AdMob API.
  • אתם רוצים ליצור בקלות כמה פרטי כניסה עם הרשאות, למשל כדי לנהל חשבונות של צד שלישי.
  • האפליקציה שלכם דורשת כתובות URL לקריאה חוזרת. כתובות URL לקריאה חוזרת לא נתמכות בתהליך של אפליקציה למחשב.

יצירת פרויקט

כדי להתחיל להשתמש ב-AdMob API, קודם כול צריך ליצור או לבחור פרויקט במסוף Google API ולהפעיל את ה-API באמצעות כלי ההגדרה, שמדריך אתכם בתהליך ומפעיל את AdMob API באופן אוטומטי.

הפעלת ה-API בפרויקט קיים

השלבים הבאים רלוונטיים למשתמשים שיש להם פרויקט קיים והם מעדיפים להפעיל את AdMob API עבורו באופן ידני.

כדי לאפשר ממשק API לפרויקט שלך:

  1. Open the API Library ב Google API Console .
  2. If prompted, select a project, or create a new one. API Library מפרט את כל ה- APIs הזמינים, מקובצים לפי משפחת מוצרים ופופולריות.
  3. אם ממשק ה- API שברצונך להפעיל אינו גלוי ברשימה, השתמש בחיפוש כדי למצוא אותו או לחץ על הצג הכל במשפחת המוצרים שאליה הוא שייך.
  4. בחר בממשק ה- API שברצונך להפעיל ולחץ על כפתור הפעל .
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

יצירת פרטי כניסה ל-OAuth2

בהוראות הבאות מוסבר איך יוצרים מזהה לקוח ב-OAuth 2.0 לשימוש בתהליך של אפליקציה מותקנת.

  1. Go to the Credentials page.

  2. לוחצים על CREATE CREDENTIALS > OAuth client ID.

    אם לא הגדרתם בעבר מסך הסכמה ל-OAuth בפרויקט הזה, תופיע בקשה לעשות זאת עכשיו. לוחצים על Configure Consent Screen. יש כמה דרכים להגדיר את מסך ההסכמה כך שישתמש במזהה הלקוח של OAuth 2.0.

    1. מגדירים את סוג המשתמש כ-External ואת סטטוס הפרסום ל-Publish (פורסם).

    2. לחלופין, אפשר להגדיר את סוג המשתמש כחיצוני ואת סטטוס הפרסום כבדיקה, ואז להוסיף משתמשים לבדיקה על ידי בחירה באפשרות הוספת משתמשים כדי לתת להם גישה לשימוש במזהה הלקוח שלכם ב-OAuth 2.0.

      למידע נוסף על הגדרת מסך ההסכמה ל-OAuth

  3. בוחרים באפשרות Desktop app או Web Application בתור סוג האפליקציה, נותנים לה שם ולוחצים על Create.

בסיום, יוצגו לכם מזהה לקוח וסודות לקוח של 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.

ביטול טוקנים משותפים

יש שתי דרכים לבטל אסימונים משותפים:

  1. עוברים אל דף ההרשאות של חשבון Google ומבטלים את הגישה מהפרויקט הרלוונטי.

  2. לחלופין, אפשר לבטל אסימונים של אפליקציות אינטרנט באמצעות Google Identity API.