YouTube Reporting API

API گزارش‌دهی یوتیوب به توسعه‌دهندگان این امکان را می‌دهد که گزارش‌های خود را زمان‌بندی کرده و سپس گزارش‌های انبوه تولید شده را دانلود کنند. این API از مجموعه‌ای از گزارش‌های از پیش تعریف شده پشتیبانی می‌کند که هر کدام شامل مجموعه‌ای جامع از داده‌های YouTube Analytics برای صاحب کانال یا محتوا هستند.

مراحل زیر نحوه‌ی زمان‌بندی گزارش‌گیری و بازیابی گزارش‌ها را توضیح می‌دهد:

  1. برای بازیابی لیستی از گزارش‌هایی که یک مالک کانال یا محتوا می‌تواند بازیابی کند، متد reportTypes.list() را فراخوانی کنید.
  2. برای شناسایی گزارشی که باید برای مالک کانال یا محتوا تولید شود، متد jobs.create() را فراخوانی کنید. متعاقباً می‌توانید از jobs.list() و jobs.delete() مربوط به API برای بازیابی یا تغییر لیست گزارش‌های تولید شده استفاده کنید.
  3. برای بازیابی لیستی از گزارش‌هایی که برای یک کار خاص تولید شده‌اند، متد jobs.reports.list() را فراخوانی کنید. هر منبع در پاسخ شامل یک ویژگی downloadUrl است که URL ای را که گزارش از آن قابل دانلود است، مشخص می‌کند.
  4. یک درخواست GET مجاز برای بازیابی گزارش از URL دانلود ارسال کنید.

مجوز

تمام درخواست‌های API گزارش یوتیوب باید تأیید شوند. راهنمای تأیید، نحوه استفاده از پروتکل OAuth 2.0 برای بازیابی توکن‌های تأیید را توضیح می‌دهد.

درخواست‌های API گزارش یوتیوب از حوزه‌های مجوز زیر استفاده می‌کنند:

محدوده توضیحات
https://www.googleapis.com/auth/yt-analytics.readonly گزارش‌های YouTube Analytics را برای محتوای YouTube خود مشاهده کنید. این دامنه دسترسی به معیارهای فعالیت کاربر، مانند تعداد بازدیدها و تعداد رتبه‌بندی‌ها را فراهم می‌کند.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly گزارش‌های مالی YouTube Analytics را برای محتوای YouTube خود مشاهده کنید. این بخش دسترسی به معیارهای فعالیت کاربر و معیارهای تخمینی درآمد و عملکرد تبلیغات را فراهم می‌کند.

انواع منابع

بخش‌های زیر توضیحات کلی در مورد منابع و متدهای API ارائه می‌دهند. تمام URIهای متد نشان داده شده در جداول مربوط به https://youtubereporting.googleapis.com هستند.

مشاغل

روش‌ها
create POST /v1/jobs
یک گزارش ایجاد می‌کند. با ایجاد یک گزارش، شما به یوتیوب دستور می‌دهید که آن گزارش را روزانه تولید کند. این گزارش ظرف ۲۴ ساعت پس از ایجاد کار در دسترس است.
delete DELETE /v1/jobs/{jobId}
یک کار گزارش‌دهی را حذف می‌کند.
get GET /v1/jobs/{jobId}
اطلاعات مربوط به یک کار گزارش‌دهی خاص که برای یک کانال یا مالک محتوا برنامه‌ریزی شده است را بازیابی می‌کند.
list GET /v1/jobs
لیست گزارش کارهایی که برای یک کانال یا مالک محتوا برنامه‌ریزی شده‌اند را نشان می‌دهد. هر منبع در پاسخ شامل یک ویژگی id است که شناسه‌ای را که یوتیوب برای شناسایی منحصر به فرد کار استفاده می‌کند، مشخص می‌کند. شما برای بازیابی لیست گزارش‌هایی که برای کار ایجاد شده‌اند یا برای حذف کار به آن شناسه نیاز دارید.

گزارش‌های شغلی

روش‌ها
get GET /v1/jobs/{jobId}/reports/{reportId}
فراداده‌های یک گزارش خاص را بازیابی می‌کند.
list GET /v1/jobs/{jobId}/reports
گزارش‌هایی را که برای کار گزارش‌دهی مشخص‌شده ایجاد شده‌اند، فهرست می‌کند.

انواع گزارش

روش‌ها
list GET /v1/reportTypes
فهرستی از انواع گزارش‌هایی را که مالک کانال یا محتوا می‌تواند بازیابی کند، برمی‌گرداند.