- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- CampaignReportSpec
- מאפיין
- מדד
- דוגמאות
- רוצים לנסות?
יוצר דוח קמפיינים על סמך המפרטים שסופקו.
בקשת HTTP
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
שם המשאב של החשבון שעבורו יש להפיק את הדוח. לדוגמה: accounts/pub-9876543210987654 |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"reportSpec": {
object ( |
שדות | |
---|---|
reportSpec |
מפרט דוח הקמפיין. |
גוף התגובה
תגובה של Campaign Report API.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"rows": [
{
object ( |
שדות | |
---|---|
rows[] |
נתוני הדוח של הקמפיין מבעל האתר שצוין. עד 100,000 שורות יוחזרו מה-API. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
CampaignReportSpec
המפרט ליצירת דוח 'קמפיין'. לדוגמה, המפרט לקבלת CHANGES ו-CPC בפילוח לפי CAMPAIGN_ID יכול להיראות כמו הדוגמה הבאה:
{
"dateRange": {
"startDate": {"year": 2021, "month": 12, "day": 1},
"endDate": {"year": 2021, "month": 12, "day": 30}
},
"dimensions": ["CAMPAIGN_ID"],
"metrics": ["IMPRESSIONS", "CLICKS"],
}
ייצוג JSON |
---|
{ "dateRange": { object ( |
שדות | |
---|---|
dateRange |
טווח התאריכים שעבורו נוצר הדוח. הטווח המקסימלי הוא 30 יום. |
dimensions[] |
רשימת מאפייני הדוח. שילוב הערכים של המאפיינים האלה קובע את השורה בדוח. אם לא צוינו מאפיינים, הדוח יחזיר שורה אחת של המדדים המבוקשים בשביל החשבון כולו. |
metrics[] |
רשימת המדדים של הדוח. דוח חייב לציין לפחות מדד אחד. |
languageCode |
השפה שבה כתוב כל טקסט שהותאם לשוק המקומי, כמו ערכי מאפיינים מסוימים שרלוונטיים להם. תג השפה מוגדר ב-IETF BCP47. אם הערך לא צוין או לא חוקי, ברירת המחדל היא 'en-US'. |
המאפיין
המאפיינים של דוח הקמפיין.
טיפוסים בני מנייה (enums) | |
---|---|
DIMENSION_UNSPECIFIED |
ערך ברירת המחדל של מאפיין שלא צוין. אין להשתמש בו. |
DATE |
תאריך בפורמט YYYYMMDD (לדוגמה, '20210701'). |
CAMPAIGN_ID |
המזהה הייחודי של הקמפיין, לדוגמה "123456789", שתואם למזהה הקמפיין מ-API של רשימת הקמפיינים. |
CAMPAIGN_NAME |
השם של מסע הפרסום. |
AD_ID |
המזהה הייחודי של המודעה, לדוגמה "123456789". |
AD_NAME |
שם המודעה, שייתכן שאינו ייחודי. |
PLACEMENT_ID |
המזהה הייחודי הספציפי לספק של האפליקציה שבה המודעה מוצבת. לדוגמה, com.goog.bar עבור Android ו-123456789 עבור אפליקציות iOS. |
PLACEMENT_NAME |
שם האפליקציה שבה המודעה מוצבת. |
PLACEMENT_PLATFORM |
הפלטפורמה של האפליקציה שבה המודעה מוצבת. |
COUNTRY |
שם המדינה המטורגטת. |
FORMAT |
הפורמט של יחידת המודעות (למשל, "מודעת באנר", "מותאמת"), מאפיין של הצגת מודעה. |
המדד
המדדים בדוח הקמפיין.
טיפוסים בני מנייה (enums) | |
---|---|
METRIC_UNSPECIFIED |
ערך ברירת המחדל לשדה שלא הוגדר. אין להשתמש בו. |
IMPRESSIONS |
מספר הפעמים שמודעה מוצגת למשתמש. |
CLICKS |
מספר הפעמים שבהן משתמש לחץ על מודעה. |
CLICK_THROUGH_RATE |
מספר הקליקים שמודעה מקבלת חלקי מספר הפעמים שהיא מוצגת. |
INSTALLS |
מספר הפעמים שבהן אפליקציות הורדו למכשירים. |
ESTIMATED_COST |
העלות המשוערת של הצגת מודעה מקמפיין במקום מודעה שמניבה הכנסות. המטבע הוא המטבע לדיווח בקמפיינים. |
AVERAGE_CPI |
העלות הממוצעת להתקנה. זהו הסכום הממוצע שהוצאתם כדי לצרף משתמש חדש. המטבע הוא המטבע לדיווח בקמפיינים. |
INTERACTIONS |
מספר הפעמים שמשתמש ניהל אינטראקציה עם מודעה. המדד הזה כולל קליקים ואינטראקציות ראשוניות. |