קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
המדריך הזה מיועד למפתחים שרוצים להשתמש ב-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 באופן ידני.
לוחצים על CREATE CREDENTIALS > OAuth client ID (יצירת פרטי כניסה > מזהה לקוח OAuth).
אם לא הגדרתם בעבר מסך הסכמה ל-OAuth עבור הפרויקט הזה, תועברו להגדיר אותו עכשיו. לוחצים על הגדרת מסך בקשת ההסכמה. יש כמה דרכים להגדיר את מסך ההסכמה לשימוש במזהה הלקוח של OAuth 2.0.
מגדירים את סוג המשתמש כ-External ואת סטטוס הפרסום כ-Published.
לחלופין, אפשר להגדיר את סוג המשתמש כחיצוני ואת סטטוס הפרסום כבדיקה, ואז להוסיף משתמשי בדיקה על ידי בחירה באפשרות הוספת משתמשים כדי לתת להם גישה לשימוש במזהה הלקוח של OAuth 2.0.
בוחרים באפשרות 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.
[null,null,["עדכון אחרון: 2025-08-31 (שעון UTC)."],[[["\u003cp\u003eThis guide helps developers programmatically access AdMob account data using the AdMob API, requiring OAuth2 authorization for secure interactions.\u003c/p\u003e\n"],["\u003cp\u003eBefore starting, ensure you have a Google Account, an AdMob account, and familiarity with REST basics and OAuth 2.0 authorization.\u003c/p\u003e\n"],["\u003cp\u003eChoose the appropriate authentication type (Desktop or Web app) based on your app's needs and authorization process.\u003c/p\u003e\n"],["\u003cp\u003eCreate or select a Google API project and enable the AdMob API to get started, then generate OAuth2 credentials for authorization.\u003c/p\u003e\n"],["\u003cp\u003eMake your first API request using provided code examples (Java, PHP, Python, or curl) and manage token revocation for security.\u003c/p\u003e\n"]]],["To use the AdMob API, developers must authorize requests via OAuth2. Key actions include creating a project in the Google API Console and enabling the AdMob API. Developers then generate OAuth2 credentials, choosing between desktop or web app authentication types. The OAuth consent screen must be configured. Finally, with created credentials and specifying the scope (`admob.readonly` or `admob.report`), developers can use HTTP or Google API client libraries to make their first API request and start retrieving AdMob data. Shared tokens can be revoked.\n"],null,["| **Important:** New user roles and permissions will affect data returned by the AdMob API. [Learn more](//support.google.com/admob/answer/2784628)\n\nThis guide is for developers who want to use the AdMob API to\nprogrammatically get\ndata in their AdMob account.\n\nAll Google AdMob API calls must be authorized through\n[OAuth2](/identity/protocols/oauth2) so your app can interact with web services\non the user's behalf. OAuth2 enables your AdMob API client app to access a\nuser's AdMob account without having to handle or store the user's username or\npassword. For an overview of authorization, see\n[Authorization](/admob/api/v1/how-tos/authorizing).\n\nPerform the following steps to generate the OAuth2 credentials and make your\nfirst request.\n\nPrerequisites\n\n- A [Google Account](//google.com/accounts/NewAccount).\n\n- A [Google AdMob account](//admob.google.com/home/get-started).\n\n- Familiarity with [REST basics](/admob/api/v1/prereqs#rest) and [authorizing requests with\n OAuth 2.0](/admob/api/v1/how-tos/authorizing).\n\nDetermine your authentication type\n\nCheck the table below to see which **authentication type** is most appropriate\nfor your app:\n\n| Choose your OAuth2 authentication type | If ... |\n|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Desktop app** | - You're managing all of your AdMob API accounts using a single top level manager account. - You're a first-time user, or want to get started quickly with the simplest setup. - Your app only authenticates Google AdMob users from one machine. |\n| **Web app** | - You want to authenticate as a user who can grant permission to your app to access their AdMob API account data. - You want to easily generate multiple authorization credentials, to manage third-party accounts for example. - Your app requires callback URLs. Callback URLs are not supported in the desktop app flow. |\n\n| **Key Point:** You can still choose the desktop app flow even if you're developing an app to run on a server. The difference is whether the OAuth authorization is completed locally or remotely. A desktop flow requires authorization to be completed on the local machine, whereas the web-flow lets authorization be completed on Google's authorization server.\n\nCreate a project\n\nTo get started using the AdMob API, you need to first create or select a\nproject in the Google API Console and enable the API using [the setup\ntool](https://console.cloud.google.com/start/api?id=admob.googleapis.com&credential=client_key),\nwhich guides you through the process and activates the AdMob API\nautomatically. \n\nEnabling the API for an existing project\n\nThe following steps apply to users who have an existing project and prefer to\nactivate the AdMob API for it manually.\n\nTo enable an API for your project:\n\n1. [Open the API Library](https://console.developers.google.com/apis/library) in the Google API Console.\n2. If prompted, select a project, or create a new one. The API Library lists all available APIs, grouped by product family and popularity.\n3. If the API you want to enable isn't visible in the list, use search to find it, or click **View All** in the product family it belongs to.\n4. Select the API you want to enable, then click the **Enable** button.\n5. If prompted, enable billing.\n6. If prompted, read and accept the API's Terms of Service.\n\nCreate OAuth2 credentials\n\nThe following instructions guide you through the process of creating an OAuth\n2.0 client ID to use with the [installed app\nflow](/identity/protocols/OAuth2InstalledApp).\n\n1. Go to the [Clients page](https://console.developers.google.com/auth/clients).\n2. Click **CREATE CREDENTIALS \\\u003e OAuth client ID**.\n\n If you hadn't configured an OAuth consent screen for this project\n previously, you'll be directed to do so now. Click **CONFIGURE CONSENT\n SCREEN**. There are multiple ways to configure your consent screen to\n use your OAuth 2.0 client ID.\n 1. Set your user type to **External** and publishing status to **Published**.\n 2. Or, set your user type to **External** and publishing status to\n **Testing** , then add **Test users** by selecting **add users** to\n give them access to use your OAuth 2.0 client ID.\n\n See additional information on [setting up your OAuth consent\n screen](//support.google.com/cloud/answer/10311615).\n3. Select **Desktop app** or **Web Application** as the application type, give\n it a name, then click **Create**.\n\nWhen done, you are presented with an OAuth 2.0 client ID and client secret,\nwhich you can download in JSON format and save for later use.\n\nMake a request\n\nThe AdMob API is built on HTTP and JSON, so any standard HTTP client can send\nrequests to it and parse the responses. However, the [Google API client\nlibraries](/admob/api/v1/libraries) provide better language integration,\nimproved security, and support for making authorized requests. The client\nlibraries are available in a number of programming languages; by using them you\ncan avoid the need to manually set up HTTP requests and parse the responses.\n| **Note:** The first time you activate the OAuth flow, you are asked to provide your AdMob publisher ID and accept an authorization prompt in your browser. Before accepting, make sure you're signed in with a Google Account that has access to your AdMob account. Your app is then authorized to access data on behalf of whichever account is currently logged in.\n\nWith [OAuth 2.0 credentials created](#credentials), you're ready to start using\nthe AdMob API. To request access using OAuth 2.0, your app also needs scope\ninformation:\n\n\n| Scope | Meaning |\n|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `https://www.googleapis.com/auth/admob.readonly` | See all AdMob data. This may include account information, inventory and mediation settings, reports, and other data. This doesn't include sensitive data, such as payments or campaign details. |\n| `https://www.googleapis.com/auth/admob.report` | See ad performance and earnings reports. See publisher ID, timezone, and default currency code. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nMake your first request to generate a report using examples in\n[Java](/admob/api/v1/reporting#java-client-library),\n[PHP](/admob/api/v1/reporting#php-client-library),\n[Python](/admob/api/v1/reporting#python-client-library) or\n[curl](/admob/api/v1/reporting#curl-command-line).\n\nRevoke shared tokens\n\nYou can revoke shared tokens in two ways:\n\n1. Navigate to your [Google account\n permissions page](//myaccount.google.com/permissions) and revoke access from\n the relevant project.\n\n2. Alternatively, you can revoke web application tokens using the [Google\n Identity API](/identity/protocols/oauth2/web-server#tokenrevoke)."]]
