Method: accounts.campaignReport.generate

יוצר דוח קמפיין על סמך המפרט שסופק.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
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 Overview.

CampaignReportSpec

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