אלפא API לדוח פעילות המודעות

הדוח 'פעילות מודעות' לקבל תמונה מלאה של ביצועי המודעות. הוא משלב בין הנתונים, המדדים מאפיינים מה-API של דוח הרשת ומה-API של דוח תהליך בחירת הרשת, וגם את נתוני הבידינג בדוח מאוחד אחד.

ה-API של דוח הפעילות במודעות מספק שיפורים נוספים בתהליך בחירת הרשת (Mediation) Report API ו-Network Report API כפי שמוצג בטבלה הבאה:

Network Report API ממשק ה-API של דוח תהליך בחירת הרשת ממשק API של דוחות פעילות מודעות
ביצועי רשת ✅ ✅ ✅
ביצועי Waterfall ✅ ✅
ביצועי בידינג ✅
ביצועי ניסוי A/B של תהליך בחירת הרשת (Mediation) ✅
דיווח לפי שעה ✅
גודל דוח 100,000 100,000 500,000

מדדים, מאפיינים ומסנני מאפיינים

המדדים הבאים נוספו ל-Ads Activity Report API ב: בנוסף למדדים רבים שזמינים ב-Network Report API ממשק ה-API של דוח תהליך בחירת הרשת.

מדד תיאור
BID_REQUEST מספר הבקשות שנשלחו אל מקור המודעות לבידינג.
BIDS_IN_AUCTION מספר הצעות המחיר שנשלחו ממקור מודעות שהשתתף במכרזי בידינג.
WINNING_BIDS מספר הצעות המחיר שזכו במכרז בידינג.

המאפיינים החדשים הבאים נכללים ב-Ads Activity Report API.

מאפיין תיאור
שבוע התאריך של היום הראשון בשבוע (בהתאם לשפה) שהוזכר בהגדרות ההתאמה לשוק המקומי) בפורמט YYYYMMDD (עבור לדוגמה, '20210701'). בקשות יכולות לציין רק אחת מהאפשרויות הבאות: DATE, WEEK או MONTH מאפיין הזמן.
שעה השעה בפורמט HH לפי שעון PST. לדוגמה, '05' לשעה 5:00 לפי שעון החוף המערבי, '13' לשעה 13:00 לפי שעון החוף המערבי. יש לציין בבקשה גם את המאפיין DATE. א' כאשר מצוין המאפיין HOUR, מוחזרים נתונים מ-28 ימים לכל היותר. תאריכי התחלה של טווח תאריכים שחלו יותר מ-28 ימים לפני התאריך הנוכחי מחזירה שגיאה.
MEDIATION_AB_TEST (שם הניסוי) צפייה בביצועים לפי בדיקת A/B של תהליך בחירת הרשת (Mediation). חובה לציין אם צוין המאפיין VARIANT.
MEDIATION_AB_TEST_VARIANT (וריאנט A, וריאנט B) הצגת הביצועים לפי וריאנט בבדיקת A/B של תהליך בחירת הרשת.
שם המאפיין בממשק ה-API של דוח תהליך בחירת הרשת שם המאפיין ב-Ads Activity Report API תיאור
AD_UNIT1 AD_UNIT_ID המזהה הייחודי של יחידת המודעות (לדוגמה, 123456789).
AD_UNIT_NAME השם של יחידת המודעות.
אפליקציה1 APP_ID המזהה הייחודי של האפליקציה לנייד (לדוגמה, 1234567890).
APP_NAME שם היישום.
AD_SOURCE1 AD_SOURCE_ID המזהה הייחודי של מקור המודעות (לדוגמה, '1234567890123456789'.
AD_SOURCE_NAME השם של מקור המודעות (לדוגמה, 'רשת AdMob').
AD_SOURCE_INSTANCE1 AD_SOURCE_INSTANCE_ID המזהה הייחודי של המופע של מקור המודעות (לדוגמה, 123456789012).
AD_SOURCE_INSTANCE_NAME שם המופע של מקור המודעות (לדוגמה, 'AdMob (ברירת מחדל)').
MEDIATION_GROUP1 MEDIATION_GROUP_ID המזהה הייחודי של הקבוצה לבחירת רשת (לדוגמה, '1234567890').
MEDIATION_GROUP_NAME המזהה הייחודי של הקבוצה לבחירת רשת (לדוגמה, 'AdMob (ברירת מחדל)').

1: למידע נוסף, ראו Scalars.

המאפיינים הבאים קיבלו פורמט מעודכן.

שם המאפיין בממשק ה-API של דוח תהליך בחירת הרשת תיאור בממשק ה-API של דוח תהליך בחירת הרשת תיאור ב-Ads Activity Report API
ESTIMATED_EARNINGS הרווחים המשוערים של בעל האפליקציה ב-AdMob. יחידת המטבע (USD, EUR או אחר) של מדדי הרווחים נקבעים לפי ההתאמה לשוק המקומי. להגדרת המטבע. הסכום הוא במיליוניות השנייה. לדוגמה, $6.50 הוא שמיוצגת כ-6500000.

הרווחים המשוערים לכל קבוצה לבחירת רשת ולכל מופע של מקור מודעות הם תמיכה החל מ-20 באוקטובר 2019. רווחים משוערים מצד שלישי להציג 0 לתאריכים שלפני 20 באוקטובר 2019.

הרווחים המשוערים של בעל האפליקציה ב-AdMob. יחידת המטבע (USD, EUR או אחר) של מדדי הרווחים נקבעים לפי ההתאמה לשוק המקומי. להגדרת המטבע.
OBSERVED_ECPM הערך הממוצע המשוער של העלות בפועל לאלף חשיפות ברשת המודעות של צד שלישי. יחידת המטבע (דולר ארה"ב, אירו או אחר) של מדדי הרווחים נקבעים לפי ההתאמה לשוק המקומי להגדרת המטבע. הסכום הוא במיליוניות השנייה. לדוגמה, $2.30 הוא שמיוצגת כ-2300000.

העלות הממוצעת המשוערת בפועל לאלף חשיפות לכל קבוצה לבחירת רשת (Mediation) וברמת המופע של מקור המודעות נתמך החל מ-20 באוקטובר 2019. ממוצע משוער של צד שלישי לתאריכים שלפני 20 באוקטובר 2019 יופיע הערך 0 בעלות בפועל לאלף חשיפות.

העלות הממוצעת בפועל לאלף חשיפות של כל המודעות. יחידת המטבע (USD, EUR או אחר) של מדדי הרווחים נקבעים לפי הגדרת הלוקליזציה של המטבע.

העלות הממוצעת בפועל לאלף חשיפות לכל קבוצה לבחירת רשת ולכל מופע של מקור מודעות היא תמיכה החל מ-20 באוקטובר 2019. הערך OBSERVED_ECPM מציג את הערך 0 לתאריכים לפני 20 באוקטובר 2019.

Scalars

המאפיינים שבהמשך עודכנו ב-Ads Activity Report API ועכשיו הם בערכים סקלריים במקום אובייקטים. זה יפשט את התגובה ויפחית את את המורכבות שלו.

המאפיינים המושפעים מ-API של דוח תהליך בחירת הרשת (Mediation) ומ-Network Report API:

  • AD_UNIT
  • APP
  • AD_SOURCE
  • AD_SOURCE_INSTANCE
  • MEDIATION_GROUP
נתוני תגובות לדוחות לדוגמה
פורמט המאפיינים של 'תהליך בחירת הרשת (Mediation)' / Network API 
"AD_UNIT": {
   "value":"ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY",
   "displayLabel": "Test ad unit name"
   }
פורמט המאפיין של AAR API 
"AD_UNIT_NAME": "Test ad unit name",
"AD_UNIT_ID": "ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY"

דיווח לפי שעה

עכשיו אפשר להציג את הביצועים לפי שעה ב-AdMob API. הדיווח השעתי הוא זמינות לתקופה של עד 28 ימים.

צריך לציין גם את המאפיין DATE בבקשה לאחזור מדי שעה . מוחזר נתונים מ-28 ימים לכל היותר כאשר המאפיין HOUR שצוין. תאריכי התחלה של טווח תאריכים שחלו יותר מ-28 ימים לפני התאריך הנוכחי מחזיר שגיאה.

דוח גדול יותר

Ads Activity Report API מאפשר לכם לאחזר עד 500,000 שורות. עבור למידע נוסף, ראו מדריך בנושא מכסות.

שליחת בקשה

כדי לשלוח בקשה, צריך לפעול לפי השלבים הבאים.

curl (שורת פקודה)

בקשות באמצעות curl

  1. טוענים את קובץ סודות הלקוח ויוצרים פרטי כניסה להרשאה.

    בפעם הראשונה שתבצעו את השלב הזה, תתבקשו לאשר בקשה להרשאה בדפדפן. לפני האישור, צריך לוודא מחוברים לחשבון Google שיש לו גישה ל-AdMob API. שלך האפליקציה מורשית לגשת לנתונים בשם מחובר כרגע.

    לצורך אימות והרשאה, מומלץ להשתמש oauth2l, כלי שורת פקודה פשוט עבודה עם Google OAuth 2.0. מתקינים את oauth2l ומפעילים את הפקודה שלמטה, מחליפה את path_to_credentials_json בנתיב לקובץ credentials.json שמורידים במהלך הרישום של של ענן. בהפעלה הראשונה, הפקודה תנחה אתכם לאורך תהליך ההרשאה מסוג OAuth 2.0. בהפעלות הבאות מתבצע רענון של האסימון באופן אוטומטי.

    ~/go/bin/oauth2l header --json path_to_credentials_json \
        https://www.googleapis.com/auth/admob.readonly

  2. יצירת דוח פעילות מודעות.

    curl -X POST https://admob.googleapis.com/v1alpha/accounts/pub-XXXXXXXXXXXXXXXX/adsActivityReport:generate \
     -H "Content-Type: application/json" \
     -H "$(~/go/bin/oauth2l header --json path_to_credentials_json https://www.googleapis.com/auth/admob.readonly)"  --data @- << EOF
      {
        "report_spec": {
        "date_range": {
          "start_date": {"year": 2023, "month": 1, "day": 1},
          "end_date": {"year": 2023, "month": 1, "day": 2}
        },
        "dimensions": ["DATE", "HOUR", "MEDIATION_AB_TEST", "VARIANT", "AD_SOURCE_ID", "AD_SOURCE_NAME"],
        "metrics": ["CLICKS", "BID_REQUEST","WINNING_BIDS", "IMPRESSIONS", "ESTIMATED_EARNINGS" ],
        "dimension_filters": [{"dimension": "COUNTRY", "matches_any": {"values": ["US"]}}],
        "sort_conditions": [{"metric":"CLICKS", "order": "DESCENDING"}],
        "localization_settings": {"currency_code": "USD", "language_code": "en-US"}
        }
      }
EOF

    דוגמה לתגובה:

    {
"rows": [
  {
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant A"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 0
      },
      "BID_REQUEST": {
        "integerValue": "27"
      },
      "WINNING_BIDS": {
        "doubleValue": 0.1111111111111111
      },
      "IMPRESSIONS": {
        "integerValue": "2"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0
      }
    }
  },
{
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant B"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 1
      },
      "BID_REQUEST": {
        "integerValue": "6"
      },
      "WINNING_BIDS": {
        "doubleValue": 1
      },
      "IMPRESSIONS": {
        "integerValue": "3"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0.000427519
      }
    }
  }
]}