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

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

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

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

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

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

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

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

יצירת פרויקט

כדי להתחיל להשתמש ב-AdMob API, קודם צריך ליצור פרויקט ב-Google API Console או לבחור פרויקט קיים ולהפעיל את ה-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 מוצגת רשימה של כל ממשקי ה-API הזמינים, מקובצים לפי משפחת מוצרים ופופולריות.
  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).

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

    1. מגדירים את סוג המשתמש כExternal ואת סטטוס הפרסום כPublished.

    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.