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)

بيانات تقرير الحملة من الناشر المحدّد. سيتم عرض 100,000 صف كحدّ أقصى من واجهة برمجة التطبيقات.

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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

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". إذا كانت غير محدّدة أو غير صالحة

السمة

أبعاد تقرير الحملة.

عمليات التعداد
DIMENSION_UNSPECIFIED القيمة التلقائية لسمة غير محدّدة. يُرجى عدم استخدامها.
DATE تاريخ بتنسيق YYYYMMDD (على سبيل المثال، "20210701").
CAMPAIGN_ID المعرّف الفريد للحملة، على سبيل المثال "123456789"، والذي يتوافق مع رقم تعريف الحملة من واجهة برمجة تطبيقات قائمة الحملات
CAMPAIGN_NAME اسم الحملة.
AD_ID المعرّف الفريد للإعلان، على سبيل المثال "123456789".
AD_NAME اسم الإعلان، وقد لا يكون فريدًا.
PLACEMENT_ID المعرّف الفريد الخاص بالمورّد للتطبيق الذي يظهر فيه الإعلان. على سبيل المثال، com.goog.bar لنظام Android و123456789 لتطبيقات iOS.
PLACEMENT_NAME اسم التطبيق الذي يظهر فيه الإعلان.
PLACEMENT_PLATFORM منصّة التطبيق التي يظهر فيها الإعلان.
COUNTRY اسم البلد المستهدَف.
FORMAT شكل الوحدة الإعلانية (على سبيل المثال، "بانر" أو "مدمج مع المحتوى")، وهو سمة لعرض الإعلان.

المقياس

مقاييس تقرير الحملة.

عمليات التعداد
METRIC_UNSPECIFIED القيمة التلقائية لحقل لم يتم ضبطه يُرجى عدم استخدامها.
IMPRESSIONS عدد مرّات عرض الإعلان للمستخدِم.
CLICKS عدد المرّات التي ينقر فيها المستخدِم على إعلان
CLICK_THROUGH_RATE عدد النقرات التي يتلقاها إعلان مقسومًا على عدد مرات عرض الإعلان.
INSTALLS عدد مرات تنزيل التطبيقات على الأجهزة.
ESTIMATED_COST التكلفة المقدّرة لعرض إعلان حملة بدلاً من إعلان يحقّق أرباحًا. العملة هي العملة المستخدَمة في تقارير الحملات.
AVERAGE_CPI متوسط التكلفة لكل تثبيت. هذا يعني متوسّط المبلغ الذي تم إنفاقه لاكتساب مستخدِم جديد. العملة هي العملة المستخدَمة في تقارير الحملات.
INTERACTIONS عدد المرّات التي يتفاعل فيها المستخدِم مع إعلان. ويشمل ذلك النقرات والتفاعلات.