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

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

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

כדי להפעיל API בפרויקט:

  1. פותחים את API Library ב-Google API Console.
  2. אם מתבקשים, בוחרים פרויקט או יוצרים פרויקט חדש. בספריית ה-API מופיעים כל ממשקי ה-API הזמינים, שמקובצים לפי משפחת מוצרים ופופולריות.
  3. אם ה-API שרוצים להפעיל לא מופיע ברשימה, אפשר להשתמש בחיפוש כדי למצוא אותו, או ללחוץ על הצגת כל במשפחת המוצרים שאליה הוא שייך.
  4. בוחרים את ה-API שרוצים להפעיל ולוחצים על הכפתור הפעלה.
  5. אם תתבקשו, הפעילו את החיוב.
  6. אם מתבקשים לעשות זאת, קוראים את התנאים וההגבלות של ה-API ומאשרים אותם.

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

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

  1. עוברים אל דף הלקוחות.

  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. המידע הזה יכול לכלול פרטי חשבון, הגדרות של מלאי שטחי הפרסום ושל גישור, דוחות ונתונים אחרים. לא ייקרא מידע אישי רגיש כמו פרטי תשלומים או פרטי קמפיינים.
https://www.googleapis.com/auth/admob.report צפייה בדוחות על ביצועי המודעות והרווחים. מזהה בעל אפליקציה, אזור הזמן וקוד המטבע שמוגדר כברירת מחדל.

כדי ליצור את הבקשה הראשונה להפקת דוח, אפשר להשתמש בדוגמאות ב-Java,‏ PHP,‏ Python או curl.

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

יש שתי דרכים לבטל שיתוף של טוקנים:

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

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