Method: accounts.campaignReport.generate

گزارش کمپین را بر اساس مشخصات ارائه شده تولید می‌کند.

درخواست HTTP

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
parent

string

نام منبع حسابی که گزارش برای آن تولید می‌شود. مثال: accounts/pub-9876543210987654

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
فیلدها
reportSpec

object ( CampaignReportSpec )

مشخصات گزارش کمپین

بدنه پاسخ

پاسخ API گزارش کمپین.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
فیلدها
rows[]

object ( ReportRow )

داده‌های گزارش کمپین از ناشر مشخص شده. حداکثر ۱۰۰۰۰۰ ردیف از API بازگردانده خواهد شد.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

مشخصات گزارش کمپین

مشخصات لازم برای تولید گزارش کمپین. به عنوان مثال، مشخصات لازم برای دریافت تعداد نمایش‌ها و کلیک‌ها به تفکیک 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 )

محدوده تاریخی که گزارش برای آن تولید می‌شود. حداکثر محدوده ۳۰ روز است.

dimensions[]

enum ( Dimension )

فهرست ابعاد گزارش. ترکیب مقادیر این ابعاد، ردیف گزارش را تعیین می‌کند. اگر هیچ بعدی مشخص نشده باشد، گزارش یک ردیف از معیارهای درخواستی را برای کل حساب برمی‌گرداند.

metrics[]

enum ( Metric )

فهرست معیارهای گزارش. یک گزارش باید حداقل یک معیار را مشخص کند.

languageCode

string

زبان مورد استفاده برای هر متن محلی، مانند مقادیر ابعاد خاص قابل اجرا. برچسب زبان در IETF BCP47 تعریف شده است. در صورت عدم مشخص شدن یا نامعتبر بودن، به طور پیش‌فرض روی 'en-US' تنظیم می‌شود.

ابعاد

ابعاد گزارش کمپین.

انوم‌ها
DIMENSION_UNSPECIFIED مقدار پیش‌فرض با ابعاد نامشخص. استفاده نکنید.
DATE یک تاریخ با فرمت YYYYMMDD (برای مثال، "20210701").
CAMPAIGN_ID شناسه منحصر به فرد کمپین، برای مثال "123456789"، که با شناسه کمپین از api لیست کمپین‌ها سازگار است.
CAMPAIGN_NAME نام کمپین.
AD_ID شناسه منحصر به فرد تبلیغ، برای مثال "123456789".
AD_NAME نام آگهی، که ممکن است منحصر به فرد نباشد.
PLACEMENT_ID شناسه منحصر به فرد فروشنده برنامه‌ای که تبلیغ در آن قرار دارد. به عنوان مثال، com.goog.bar برای اندروید و 123456789 برای برنامه‌های iOS.
PLACEMENT_NAME نام برنامه‌ای که تبلیغ در آن قرار داده شده است.
PLACEMENT_PLATFORM پلتفرم اپلیکیشن که تبلیغ در آن قرار می‌گیرد.
COUNTRY نام کشور هدف.
FORMAT قالب واحد تبلیغاتی (برای مثال، «بنر»، «بومی»)، بُعد ارائه تبلیغ.

متریک

معیارهای گزارش کمپین.

انوم‌ها
METRIC_UNSPECIFIED مقدار پیش‌فرض برای فیلد تنظیم نشده. استفاده نکنید.
IMPRESSIONS تعداد دفعاتی که یک تبلیغ به کاربر نشان داده می‌شود.
CLICKS تعداد دفعاتی که کاربر روی یک تبلیغ کلیک می‌کند.
CLICK_THROUGH_RATE تعداد کلیک‌هایی که روی یک تبلیغ می‌شود تقسیم بر تعداد دفعات نمایش آن تبلیغ.
INSTALLS تعداد دفعاتی که برنامه‌ها روی دستگاه‌ها دانلود شده‌اند.
ESTIMATED_COST هزینه تخمینی ارائه یک تبلیغ کمپین به جای تبلیغی که درآمد کسب می‌کند. واحد پول، واحد پول گزارش‌دهی برای کمپین‌ها است.
AVERAGE_CPI میانگین هزینه به ازای هر نصب. این به معنی میانگین مبلغی است که برای جذب یک کاربر جدید هزینه شده است. واحد پول، واحد پول گزارش‌شده برای کمپین‌ها است.
INTERACTIONS تعداد دفعاتی که کاربر با یک تبلیغ تعامل می‌کند. این شامل کلیک‌ها و تعاملات می‌شود.