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)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات 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

اللغة المستخدمة لأي نص مترجم، مثل قيم سمات معيّنة قابلة للتطبيق يتم تحديد علامة اللغة في BCP47 لمجموعة مهندسي شبكة الإنترنت (IETF) يتم ضبط القيمة تلقائيًا على "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 عدد المرات التي يتفاعل فيها المستخدم مع إعلان. ويشمل ذلك النقرات والتفاعلات.