Method: accounts.campaignReport.generate

המערכת יוצרת דוח לקמפיינים על סמך המפרט שסופקו.

בקשת HTTP

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

שם המשאב של החשבון שעבורו רוצים להפיק את הדוח. לדוגמה: accounts/pub-9876543210987654

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
שדות
reportSpec

object (CampaignReportSpec)

מפרט דוח של קמפיינים.

גוף התשובה

תגובת Campaign Report API.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
שדות
rows[]

object (ReportRow)

נתוני הדוח של הקמפיין מבעל האתר שצוין. מה-API יוחזרו לכל היותר 100,000 שורות.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

CampaignReportSpec

המפרט ליצירת דוח 'קמפיינים'. לדוגמה, המפרט לקבלת חשיפות ו-CLICKS בפילוח לפי 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)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
שדות
dateRange

object (DateRange)

טווח התאריכים שעבורו מופק הדוח. הטווח המקסימלי הוא 30 יום.
dimensions[]

enum (Dimension)

רשימת מאפיינים של הדוח. שילוב הערכים של המאפיינים האלה קובע את השורה של הדוח. אם לא ציינתם מאפיינים, הדוח יחזיר שורה אחת של המדדים המבוקשים לחשבון כולו.
metrics[]

enum (Metric)

רשימת המדדים בדוח. הדוח חייב לציין לפחות מדד אחד.
languageCode

string

השפה של כל טקסט שהותאם לשוק המקומי, כמו ערכי מאפיינים רלוונטיים מסוימים. תג השפה מוגדר בתקן IETF BCP47. ברירת המחדל היא 'en-US' אם הוא לא צוין או לא חוקי.

מאפיין

המאפיינים של דוח הקמפיין.

טיפוסים בני מנייה (enum)
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 הפורמט של יחידת המודעות (לדוגמה, 'באנר', 'מותאם'), מאפיין של הצגת מודעות.

מדד

המדדים בדוח של הקמפיין.

טיפוסים בני מנייה (enum)
METRIC_UNSPECIFIED ערך ברירת המחדל של שדה לא מוגדר. אין להשתמש בו.
IMPRESSIONS מספר הפעמים שמודעה מוצגת למשתמש.
CLICKS מספר הפעמים שבהן משתמש לחץ על מודעה.
CLICK_THROUGH_RATE מספר הקליקים שמודעה מקבלת חלקי מספר הפעמים שהיא מוצגת.
INSTALLS מספר הפעמים שבוצעה הורדה של אפליקציות למכשירים.
ESTIMATED_COST העלות המשוערת של הצגת מודעה מתוך קמפיין במקום מודעה שמניבה הכנסות. המטבע הוא המטבע לדיווח בקמפיינים.
AVERAGE_CPI העלות הממוצעת להתקנה. זהו הסכום הממוצע שהמערכת הוציאה כדי לצרף משתמש חדש. המטבע הוא המטבע לדיווח בקמפיינים.
INTERACTIONS מספר הפעמים שבהן משתמש קיים אינטראקציה עם מודעה. המדד הזה מתבסס על קליקים ואינטראקציות.