Method: accounts.networkReport.generate

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

درخواست HTTP

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

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

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

پارامترها
parent

string

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

درخواست بدن

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

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

object ( NetworkReportSpec )

مشخصات گزارش شبکه

بدن پاسخگو

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

به عنوان مثال:

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         displayLabel: "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"microsValue": 6500000}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

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

نمایندگی JSON 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
فیلدها
payload میدان اتحادیه هر پیام پاسخ جریانی حاوی یک نوع بار است. payload می تواند تنها یکی از موارد زیر باشد:
header

object ( ReportHeader )

تنظیمات تولید گزارش که محتوای گزارش را توصیف می کند، مانند محدوده تاریخ گزارش و تنظیمات محلی سازی.

row

object ( ReportRow )

داده های گزارش واقعی

footer

object ( ReportFooter )

اطلاعات اضافی درباره گزارش تولید شده، مانند هشدارهای مربوط به داده ها.

محدوده مجوز

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

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

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

NetworkReportSpec

مشخصات ایجاد گزارش شبکه AdMob. برای مثال، مشخصات دریافت کلیک‌ها و درآمد تخمینی فقط برای کشورهای «ایالات متحده آمریکا» و «CN» می‌تواند مانند مثال زیر باشد:

{
  'dateRange': {
    'startDate': {'year': 2021, 'month': 9, 'day': 1},
    'endDate': {'year': 2021, 'month': 9, 'day': 30}
  },
  'dimensions': ['DATE', 'APP', 'COUNTRY'],
  'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
  'dimensionFilters': [
    {
      'dimension': 'COUNTRY',
      'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
    }
  ],
  'sortConditions': [
    {'dimension':'APP', order: 'ASCENDING'},
    {'metric':'CLICKS', order: 'DESCENDING'}
  ],
  'localizationSettings': {
    'currencyCode': 'USD',
    'languageCode': 'en-US'
  }
}

برای درک بهتر، می توانید مشخصات قبلی را مانند شبه SQL زیر در نظر بگیرید:

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
نمایندگی JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
فیلدها
dateRange

object ( DateRange )

محدوده تاریخی که گزارش برای آن تولید می شود.

dimensions[]

enum ( Dimension )

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

metrics[]

enum ( Metric )

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

dimensionFilters[]

object ( DimensionFilter )

شرح می‌دهد که کدام ردیف‌های گزارش بر اساس مقادیر ابعادشان مطابقت دارند.

sortConditions[]

object ( SortCondition )

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

localizationSettings

object ( LocalizationSettings )

تنظیمات محلی سازی گزارش

maxReportRows

integer

حداکثر تعداد ردیف های داده گزارش برای بازگشت. اگر مقدار تنظیم نشده باشد، API تا آنجایی که ممکن است ردیف‌ها را تا 100000 برمی‌گرداند. مقادیر قابل قبول 1-100000، شامل می‌شود. مقادیر بزرگتر از 100000 یک خطا برمی گرداند.

timeZone

string

منطقه زمانی گزارش مقادیر نام IANA TZ مانند "America/Los_Angeles" را می پذیرد. اگر منطقه زمانی تعریف نشده باشد، پیش فرض حساب اعمال می شود. مقدار پیش فرض را با عمل دریافت حساب بررسی کنید.

هشدار: "America/Los_Angeles" تنها مقدار پشتیبانی شده در حال حاضر است.

بعد

ابعاد گزارش شبکه ابعاد، ویژگی‌های داده‌ای هستند تا اندازه‌گیری‌های کمی (معیارها) را با ویژگی‌های خاص، مانند قالب تبلیغ یا پلتفرمی که یک تبلیغ در آن مشاهده شده است، تجزیه یا اصلاح کنند.

Enums
DIMENSION_UNSPECIFIED مقدار پیش فرض برای یک فیلد تنظیم نشده. استفاده نکنید.
DATE تاریخ در قالب YYYYMMDD (به عنوان مثال، "20210701"). درخواست ها می توانند حداکثر یک بعد زمانی را مشخص کنند.
MONTH یک ماه در قالب YYYYMM (به عنوان مثال، "202107"). درخواست ها می توانند حداکثر یک بعد زمانی را مشخص کنند.
WEEK تاریخ اولین روز هفته در قالب YYYYMMDD (به عنوان مثال، "20210701"). درخواست ها می توانند حداکثر یک بعد زمانی را مشخص کنند.
AD_UNIT شناسه منحصر به فرد واحد تبلیغات (به عنوان مثال، "ca-app-pub-1234/1234"). اگر بعد AD_UNIT مشخص شده باشد، APP به طور خودکار گنجانده می شود.
APP شناسه منحصر به فرد برنامه تلفن همراه (به عنوان مثال، "ca-app-pub-1234~1234").
AD_TYPE

نوع آگهی (به عنوان مثال، «متن» یا «تصویر»)، یک بعد تحویل آگهی.

هشدار: این بعد با معیارهای AD_REQUESTS ، MATCH_RATE و IMPRESSION_RPM سازگار نیست.

COUNTRY کد کشور CLDR مکانی که بازدیدها/کلیک‌های تبلیغاتی در آن اتفاق می‌افتد (به عنوان مثال، "US" یا "FR"). این یک بعد جغرافیایی است.
FORMAT قالب واحد تبلیغات (به عنوان مثال، "بنر"، "بومی")، یک بعد تحویل آگهی.
PLATFORM پلت فرم سیستم عامل موبایل برنامه (به عنوان مثال، "Android" یا "iOS").
MOBILE_OS_VERSION نسخه سیستم عامل موبایل، به عنوان مثال "iOS 13.5.1".
GMA_SDK_VERSION نسخه GMA SDK، به عنوان مثال "iOS 7.62.0".
APP_VERSION_NAME برای اندروید، نام نسخه برنامه را می‌توانید در versionName در PackageInfo پیدا کنید. برای iOS، نام نسخه برنامه را می توان در CFBundleShortVersionString پیدا کرد.
SERVING_RESTRICTION حالت محدودیت برای ارائه تبلیغات (به عنوان مثال "تبلیغات غیر شخصی").

متریک

معیارهای گزارش شبکه متریک ها اندازه گیری های کمی هستند که نشان می دهد کسب و کار ناشر چگونه عمل می کند. آنها از رویدادهای تبلیغاتی فردی جمع آوری شده و بر اساس ابعاد گزارش گروه بندی می شوند. مقدار متریک یا عدد صحیح یا اعشاری (بدون گرد کردن) است.

Enums
METRIC_UNSPECIFIED مقدار پیش فرض برای یک فیلد تنظیم نشده. استفاده نکنید.
AD_REQUESTS

تعداد درخواست های تبلیغاتی مقدار یک عدد صحیح است.

هشدار: معیار با بعد AD_TYPE ناسازگار است.

CLICKS تعداد دفعاتی که کاربر روی تبلیغ کلیک می کند. مقدار یک عدد صحیح است.
ESTIMATED_EARNINGS درآمد تخمینی ناشر AdMob. واحد ارز (USD، EUR، یا موارد دیگر) معیارهای درآمد توسط تنظیمات محلی سازی برای ارز تعیین می شود. مقدار بر حسب میکرو می باشد. به عنوان مثال، 6.50 دلار به عنوان 6500000 نشان داده می شود.
IMPRESSIONS تعداد کل تبلیغات نمایش داده شده به کاربران. مقدار یک عدد صحیح است.
IMPRESSION_CTR نسبت کلیک ها به نمایش ها. مقدار یک مقدار اعشاری با دقت دوگانه (تقریبی) است.
IMPRESSION_RPM

درآمد تخمینی به ازای هر هزار نمایش تبلیغات. مقدار در میکرو است. برای مثال، 1.03 دلار به عنوان 1030000 نشان داده می شود. معادل eCPM در رابط کاربری AdMob.

هشدار: معیار با بعد AD_TYPE ناسازگار است.

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

نسبت درخواست‌های آگهی منطبق بر کل درخواست‌های آگهی. مقدار یک مقدار اعشاری با دقت دوگانه (تقریبی) است.

هشدار: معیار با بعد AD_TYPE ناسازگار است.

SHOW_RATE نسبت تبلیغاتی که نسبت به آگهی‌هایی که برگردانده می‌شوند نمایش داده می‌شوند که به‌عنوان نمایش‌ها/درخواست‌های منطبق تعریف می‌شود. مقدار یک مقدار اعشاری با دقت دوگانه (تقریبی) است.

DimensionFilter

شرح می‌دهد که کدام ردیف‌های گزارش بر اساس مقادیر ابعادشان مطابقت دارند.

نمایندگی JSON 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
فیلدها
dimension

enum ( Dimension )

معیار فیلتر را در بعد مشخص شده اعمال می کند.

operator میدان اتحادیه عملگر فیلتر برای اعمال operator فقط می تواند یکی از موارد زیر باشد:
matchesAny

object ( StringList )

اگر مقدار آن برای بعد مشخص شده در یکی از مقادیر مشخص شده در این شرایط باشد، با یک ردیف مطابقت دارد.

SortCondition

جهت مرتب سازی برای اعمال بر روی یک بعد یا یک متریک.

نمایندگی JSON 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
فیلدها
order

enum ( SortOrder )

ترتیب مرتب سازی ابعاد یا متریک.

فیلد اتحادیه sort_on . مشخص می کند که کدام مقادیر باید مرتب شوند. sort_on می تواند تنها یکی از موارد زیر باشد:
dimension

enum ( Dimension )

مرتب سازی بر اساس ابعاد مشخص شده

metric

enum ( Metric )

مرتب سازی بر اساس متریک مشخص شده