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)

مواصفات تقرير الحملة

نص الاستجابة

استجابة واجهة برمجة التطبيقات لتقرير الحملة

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

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

السمة

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

عمليات التعداد
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 عدد المرّات التي يتفاعل فيها المستخدم مع إعلان. ويشمل ذلك النقرات والتفاعلات.