Method: accounts.mediationReport.generate

إنشاء تقرير توسط AdMob بناءً على مواصفات التقرير المقدمة. لعرض نتيجة RPC للبث من جهة الخادم. ويتم عرض النتيجة في تسلسل من الاستجابات.

طلب HTTP

POST https://admob.googleapis.com/v1/{parent=accounts/*}/mediationReport:generate

يستخدم عنوان URL بنية gRPC TransEncoding.

معلمات المسار

المعلَمات
parent

string

اسم مورد الحساب لإنشاء التقرير له. مثال: accounts/pub-9876543210987654

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "reportSpec": {
    object (MediationReportSpec)
  }
}
الحقول
reportSpec

object (MediationReportSpec)

مواصفات تقرير الشبكة.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

استجابة البث لتقرير توسّط AdMob حيث يحتوي الرد الأول على عنوان التقرير، ثم تدفق ردود الصف، وفي النهاية تذييلاً كرسالة الرد الأخيرة.

مثلاً:

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         "displayLabel": "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]
تمثيل JSON 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
الحقول
حقل الاتحاد payload تحتوي كل رسالة رد على البث على نوع واحد من البيانات الأساسية. لا يمكن أن يكون payload إلا واحدًا مما يلي:
header

object (ReportHeader)

إعدادات إنشاء التقرير التي تصف محتوى التقرير، مثل النطاق الزمني للتقرير وإعدادات الترجمة
row

object (ReportRow)

بيانات التقرير الفعلية
footer

object (ReportFooter)

معلومات إضافية حول التقرير الذي تم إنشاؤه، مثل التحذيرات المتعلقة بالبيانات

نطاقات الأذونات

تتطلّب أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على بروتوكول OAuth 2.0.

مواصفات تقرير التوسّط

مواصفات إنشاء تقرير توسط AdMob. على سبيل المثال، يمكن أن تظهر مواصفات الحصول على التكلفة لكل ألف ظهور المرصودة حسب مصدر الإعلان والتطبيق لكلٍّ من 'US' و 'CN' في البلدان التالية:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 9, "day": 1},
    "endDate": {"year": 2021, "month": 9, "day": 30}
  },
  "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
  "metrics": ["OBSERVED_ECPM"],
  "dimensionFilters": [
    {
      "dimension": "COUNTRY",
      "matchesAny": {"values": [{"value": "US", "value": "CN"}]}
    }
  ],
  "sortConditions": [
    {"dimension":"APP", order: "ASCENDING"}
  ],
  "localizationSettings": {
    "currencyCode": "USD",
    "languageCode": "en-US"
  }
}

لتحقيق فهم أفضل، يمكنك التعامل مع المواصفات السابقة، مثل لغة الاستعلامات البنيوية (SQL) الزائفة التالية:

SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
تمثيل JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
الحقول
dateRange

object (DateRange)

النطاق الزمني الذي يتم إنشاء التقرير له.
dimensions[]

enum (Dimension)

قائمة أبعاد التقرير. وتحدّد مجموعة قيم هذه الأبعاد صف التقرير. إذا لم يتم تحديد أي أبعاد، يعرض التقرير صفًا واحدًا من المقاييس المطلوبة للحساب بالكامل.
metrics[]

enum (Metric)

قائمة مقاييس التقرير. يجب أن يحدد التقرير مقياسًا واحدًا على الأقل.
dimensionFilters[]

object (DimensionFilter)

وصف صفوف التقرير المطلوب مطابقتها استنادًا إلى قيم الأبعاد.
sortConditions[]

object (SortCondition)

يصف ترتيب صفوف التقرير. يحدد ترتيب الشرط في القائمة أسبقيةه، وكلما كان الشرط أعلى، كانت الأولوية أعلى. إذا لم يتم تحديد أي شروط ترتيب، لن يكون ترتيب الصف محددًا.
localizationSettings

object (LocalizationSettings)

إعدادات الأقلمة للتقرير
maxReportRows

integer

الحد الأقصى لعدد صفوف بيانات التقرير المطلوب عرضها. في حال عدم ضبط القيمة، ستعرض واجهة برمجة التطبيقات أكبر عدد ممكن من الصفوف، بما يصل إلى 100,000. القيم المقبولة هي 1-100000، بما يشمل هاتين القيمتين أيضًا. تعرض القيم الأكبر من 100000 خطأ.
timeZone

string

منطقة زمنية للتقرير. تقبل قيم اسم IANA TZ، مثل "America/Los_Angeles&" وفي حال عدم تحديد منطقة زمنية، سيتم تفعيل الإعداد التلقائي للحساب. تحقّق من القيمة التلقائية من خلال إجراء الحصول على الحساب.

تحذير: &"America/Los_Angeles" هي القيمة الوحيدة المسموح بها في الوقت الحالي.

البُعد

أبعاد تقرير التوسط. السمات هي سمات البيانات لتحليل المقاييس أو مقاييسها أو تنقيحها حسب سمات معيّنة، مثل شكل الإعلان أو المنصة التي تم عرض الإعلان عليها.

عمليات التعداد
DIMENSION_UNSPECIFIED القيمة التلقائية لحقل لم يتم ضبطه يجب عدم استخدامها.
DATE تاريخ بتنسيق YYYYMMDD (على سبيل المثال، "20210701"). يمكن أن تحدّد الطلبات بُعدًا زمنيًا واحدًا على الأكثر.
MONTH شهر بتنسيق YYYYMM (مثل، "202107"). يمكن أن تحدّد الطلبات بُعدًا زمنيًا واحدًا على الأكثر.
WEEK تاريخ اليوم الأول من الأسبوع بالتنسيق YYYYMMDD (على سبيل المثال، "20210701"). يمكن أن تحدّد الطلبات بُعدًا زمنيًا واحدًا على الأكثر.
AD_SOURCE رقم التعريف الفريد لمصدر الإعلان (على سبيل المثال، "5450213213286189855"&&;;شبكة AdMob" كقيمة للتصنيف).
AD_SOURCE_INSTANCE المعرّف الفريد لمثيل مصدر الإعلان (على سبيل المثال، "ca-app-pub-1234:asi:5678"&&;;AdMob (تلقائي)" كقيمة للتصنيف.
AD_UNIT المعرّف الفريد للوحدة الإعلانية (على سبيل المثال، "ca-app-pub-1234/8790"). إذا تم تحديد البُعد AD_UNIT، سيتم تضمين APP تلقائيًا.
APP المعرّف الفريد للتطبيق المتوافق مع الأجهزة الجوّالة (على سبيل المثال، "ca-app-pub-1234~1234").
MEDIATION_GROUP المعرّف الفريد لمجموعة التوسط (على سبيل المثال، "ca-app-pub-1234:mg:1234"&&;;;;AdMob (التلقائية)" كقيمة للتصنيف)
COUNTRY رمز بلد CLDR للمكان الذي تتم فيه مشاهدة/نقرات الإعلان (على سبيل المثال، "US" أو "FR") هذا أحد الأبعاد الجغرافية.
FORMAT شكل الوحدة الإعلانية (مثل &quot؛إعلان بانر&;;&&;;;&&&;;;;)؛ مختلف عن عرض الإعلانات.
PLATFORM النظام الأساسي لنظام تشغيل الجوّال للتطبيق (على سبيل المثال، "Android" أو "iOS").
MOBILE_OS_VERSION إصدار نظام تشغيل الجوّال، على سبيل المثال، &quot؛الإصدار 13.5.1&iOS. تحذير: المكوّن غير متوافق مع مقاييس estimatedD_EARNINGS وOBSERVED_ECPM.
GMA_SDK_VERSION إصدار حزمة تطوير البرامج (SDK) في "إعلانات Google" على الأجهزة الجوّالة (GMA)، مثل "iOS; 7.62.0". تحذير: المكوّن غير متوافق مع مقاييس estimatedD_EARNINGS وOBSERVED_ECPM.
APP_VERSION_NAME بالنسبة إلى تطبيقات Android، يمكن العثور على اسم إصدار التطبيق في versionName في PackageInfo. بالنسبة إلى نظام التشغيل iOS، يمكن العثور على اسم إصدار التطبيق في CFBundleShortVersionString. تحذير: المكوّن غير متوافق مع مقاييس estimatedD_EARNINGS وOBSERVED_ECPM.
SERVING_RESTRICTION وضع تقييد عرض الإعلانات (مثلاً &&عرض إعلانات غير مخصّصة) تحذير: المكوّن غير متوافق مع مقياس estimatedD_EARNINGS.

مقياس متري

مقاييس تقرير التوسّط. المقاييس هي قياسات كمية توضّح مستوى أداء النشاط التجاري للناشر. ويتم تجميعها من أحداث الإعلانات الفردية ويتم تجميعها حسب أبعاد التقرير. تكون قيمة المقياس إما عددًا صحيحًا أو رقمًا عشريًا (بدون التقريب).

عمليات التعداد
METRIC_UNSPECIFIED القيمة التلقائية لحقل لم يتم ضبطه يجب عدم استخدامها.
AD_REQUESTS عدد الطلبات. القيمة هي عدد صحيح.
CLICKS عدد المرات التي ينقر فيها المستخدم على الإعلان. القيمة هي عدد صحيح.
ESTIMATED_EARNINGS

الأرباح المقدّرة لناشر AdMob. يتم تحديد وحدة العملة (الدولار الأمريكي أو اليورو أو غيرها) من مقاييس تحقيق الربح حسب إعداد الأقلمة للعملة. القيمة بوحدات المايكرو. على سبيل المثال، سيتم تمثيل 6.50 دولار أمريكي على النحو التالي: 6500000.

يتم دعم الأرباح المقدّرة لكل مجموعة توسط ولكل مستوى مثال لمصدر إعلان يعود إلى 20 تشرين الأول (أكتوبر) 2019. ستعرض الأرباح المقدّرة من الطرف الثالث صفرًا للتواريخ التي تسبق 20 تشرين الأول (أكتوبر) 2019.
IMPRESSIONS إجمالي عدد الإعلانات التي تظهر للمستخدمين. القيمة هي عدد صحيح.
IMPRESSION_CTR نسبة النقرات على مرات الظهور. القيمة هي قيمة عشرية مزدوجة (تقريبية).
MATCHED_REQUESTS عدد مرات عرض الإعلانات استجابةً لطلب معيّن. القيمة هي عدد صحيح.
MATCH_RATE نسبة طلبات الإعلان المُطابقة مقارنةً بإجمالي طلبات الإعلان. القيمة هي قيمة عشرية مزدوجة (تقريبية).
OBSERVED_ECPM

متوسط التكلفة الفعلية المقدّرة لكل ألف ظهور على شبكة المواقع الإعلانية التابعة لطرف ثالث. يتم تحديد وحدة العملة (الدولار الأمريكي أو اليورو أو غيرها) من مقاييس تحقيق الربح حسب إعداد الأقلمة للعملة. القيمة بوحدات المايكرو. على سبيل المثال، سيتم تمثيل 2.30 دولار أمريكي على النحو التالي: 2300000.

يعود متوسط التكلفة الفعلية المقدّرة لكل ألف ظهور لكل مجموعة توسط ولكل مستوى مثال لمصدر إعلان إلى 20 تشرين الأول (أكتوبر) 2019. سيعرض متوسط التكلفة الفعلية لكل ألف ظهور المقدّر من الطرف الثالث صفرًا للتواريخ التي تسبق 20 تشرين الأول (أكتوبر) 2019.

فلتر المكوّن

وصف صفوف التقرير المطلوب مطابقتها استنادًا إلى قيم الأبعاد.

تمثيل JSON 
{
  "dimension": enum (Dimension),
  "matchesAny": {
    object (StringList)
  }
}
الحقول
dimension

enum (Dimension)

تطبيق معيار الفلتر على المكوّن المحدّد
matchesAny

object (StringList)

يطابق صفًا إذا كانت قيمته للمكوّن المحدد موجودة في إحدى القيم المحددة في هذا الشرط.

حالة الترتيب

ترتيب الاتجاهات المراد تطبيقها على بُعد أو مقياس

تمثيل JSON 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
الحقول
order

enum (SortOrder)

ترتيب ترتيب البُعد أو المقياس
حقل الاتحاد sort_on تحدّد القيم التي يجب ترتيبها. لا يمكن أن يكون sort_on إلا واحدًا مما يلي:
dimension

enum (Dimension)

الترتيب حسب السمة المحددة
metric

enum (Metric)

الترتيب حسب المقياس المحدد