Method: accounts.campaignReport.generate

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
parent

string

نام منبع حساب برای ایجاد گزارش. مثال: accounts/pub-9876543210987654

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

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

object ( CampaignReportSpec )

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

بدن پاسخگو

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

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

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

object ( ReportRow )

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

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

CampaignReportSpec

مشخصات برای ایجاد گزارش کمپین. برای مثال، مشخصات دریافت IMPRESSIONS و CLICKS برش‌شده توسط 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» تبدیل می‌شود.

بعد

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

Enums
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 قالب واحد تبلیغات (به عنوان مثال، "بنر"، "بومی")، یک بعد تحویل آگهی.

متریک

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

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