YouTube Reporting API
YouTube Reporting API به توسعه دهندگان این امکان را می دهد تا کارهای گزارش دهی را برنامه ریزی کنند و سپس گزارش های انبوه تولید شده را دانلود کنند. API از مجموعه‌ای از گزارش‌های از پیش تعریف‌شده پشتیبانی می‌کند، که هر کدام شامل مجموعه‌ای جامع از داده‌های YouTube Analytics برای یک کانال یا صاحب محتوا است.
مراحل زیر نحوه برنامه ریزی مشاغل گزارش دهی و بازیابی گزارش ها را توضیح می دهد:
- متد
reportTypes.list() را فراخوانی کنید تا فهرستی از گزارش‌هایی را که صاحب کانال یا محتوا می‌تواند بازیابی کند، بازیابی کنید. - برای شناسایی گزارشی که باید برای صاحب کانال یا محتوا ایجاد شود، متد
jobs.create() را فراخوانی کنید. متعاقباً می توانید از jobs.list() و jobs.delete() API برای بازیابی یا تغییر لیست گزارش های در حال تولید استفاده کنید. - متد
jobs.reports.list() را فراخوانی کنید تا لیستی از گزارش هایی که برای یک کار خاص تولید شده اند را بازیابی کنید. هر منبع در پاسخ حاوی یک ویژگی downloadUrl است که نشانی اینترنتی را که می توان گزارش از آن دانلود کرد را مشخص می کند. - یک درخواست
GET مجاز برای بازیابی گزارش از URL دانلود ارسال کنید.
مجوز
همه درخواست‌های YouTube Reporting API باید مجاز باشند. راهنمای مجوز نحوه استفاده از پروتکل OAuth 2.0 برای بازیابی نشانه های مجوز را توضیح می دهد.
درخواست‌های YouTube Reporting 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
کار گزارش دهی ایجاد می کند. با ایجاد یک شغل گزارش دهی، به YouTube دستور می دهید تا آن گزارش را به صورت روزانه تولید کند. این گزارش ظرف 24 ساعت از زمان ایجاد شغل در دسترس است. |
delete | DELETE /v1/jobs/{jobId}
یک کار گزارش دهی را حذف می کند. |
get | GET /v1/jobs/{jobId}
اطلاعات مربوط به یک کار گزارش دهی خاص را که برای صاحب کانال یا محتوا برنامه ریزی شده است، بازیابی می کند. |
list | GET /v1/jobs
مشاغل گزارشی را که برای مالک کانال یا محتوا برنامه ریزی شده اند فهرست می کند. هر منبع در پاسخ حاوی یک ویژگی id است که شناسه ای را که YouTube برای شناسایی منحصر به فرد کار استفاده می کند، مشخص می کند. برای بازیابی لیست گزارش هایی که برای کار ایجاد شده اند یا برای حذف کار به آن شناسه نیاز دارید. |
| مواد و روش ها |
|---|
get | GET /v1/jobs/{jobId}/reports/{reportId}
فراداده را برای یک گزارش خاص بازیابی می کند. |
list | GET /v1/jobs/{jobId}/reports
گزارش هایی را که برای کار گزارش دهی مشخص شده ایجاد شده اند فهرست می کند. |
| مواد و روش ها |
|---|
list | GET /v1/reportTypes
فهرستی از انواع گزارش را که مالک کانال یا محتوا می تواند بازیابی کند، برمی گرداند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2023-02-22 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2023-02-22 بهوقت ساعت هماهنگ جهانی."],[[["The YouTube Reporting API allows developers to schedule and download bulk reports containing comprehensive YouTube Analytics data for channels or content owners."],["Developers can use the API to retrieve a list of available reports, create jobs to generate reports, and manage these jobs through listing and deletion."],["Generated reports can be downloaded via a specified URL obtained from the API's response, after retrieving them by using the `jobs.reports.list()` method."],["The API requires OAuth 2.0 authorization, and provides scopes for viewing user activity metrics (`https://www.googleapis.com/auth/yt-analytics.readonly`) and monetary reports (`https://www.googleapis.com/auth/yt-analytics-monetary.readonly`)."]]],["Developers use the YouTube Reporting API to schedule and download bulk reports containing YouTube Analytics data. Key actions include: listing available report types via `reportTypes.list()`, creating reporting jobs with `jobs.create()`, and managing jobs using `jobs.list()` and `jobs.delete()`. To get data, retrieve generated reports for a specific job with `jobs.reports.list()`, each with a downloadable URL. Finally, you can request the download using the given URL. All actions require authorization via OAuth 2.0.\n"]]
