YouTube Analytics API به شما امکان می دهد داده های YouTube Analytics را برای یک کانال YouTube یا صاحب محتوا بازیابی کنید. API از پرس و جوهای بلادرنگ پشتیبانی می کند و گزارشی را بر اساس پارامترهای درخواست API تولید می کند.
API از دو نوع عملکرد پشتیبانی می کند:
بازیابی گزارش – روش
reports.queryگزارش‌های YouTube Analytics را بازیابی می‌کند.مدیریت گروه YouTube Analytics – گروه YouTube Analytics مجموعه ای سفارشی از حداکثر 500 کانال، ویدیو، لیست پخش یا دارایی است. API از چندین روش برای ایجاد، بازیابی و به‌روزرسانی گروه‌های YouTube Analytics پشتیبانی می‌کند. سپس صاحبان کانال و محتوا می‌توانند از روش
reports.queryبرای بازیابی داده‌های جمع‌آوری شده برای همه موارد در یک گروه استفاده کنند، که می‌تواند به تجزیه و تحلیل عملکرد کمک کند.
این صفحه یک نمای کلی از منابع و روش‌های API که این توابع را فعال می‌کنند ارائه می‌کند.
مجوز
همه درخواست‌های YouTube Analytics API باید مجاز باشند. راهنمای مجوز نحوه استفاده از پروتکل OAuth 2.0 برای بازیابی نشانه های مجوز را توضیح می دهد.
درخواست‌های YouTube Analytics API از حوزه‌های مجوز زیر استفاده می‌کنند:
| محدوده ها | |
|---|---|
| https://www.googleapis.com/auth/yt-analytics.readonly | گزارش‌های YouTube Analytics را برای محتوای YouTube خود مشاهده کنید. این محدوده دسترسی به معیارهای فعالیت کاربر مانند تعداد بازدید و تعداد رتبه‌بندی را فراهم می‌کند. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly | گزارش های پولی YouTube Analytics را برای محتوای YouTube خود مشاهده کنید. این محدوده دسترسی به معیارهای فعالیت کاربر و معیارهای درآمد تخمینی و عملکرد تبلیغات را فراهم می کند. |
| https://www.googleapis.com/auth/youtube | حساب YouTube خود را مدیریت کنید. در YouTube Analytics API، صاحبان کانال از این محدوده برای مدیریت گروه‌ها و موارد گروه YouTube Analytics استفاده می‌کنند. |
| https://www.googleapis.com/auth/youtubepartner | دارایی‌های YouTube و محتوای مرتبط را در YouTube مشاهده و مدیریت کنید. در YouTube Analytics API، صاحبان محتوا از این محدوده برای مدیریت گروه‌ها و موارد گروه YouTube Analytics استفاده می‌کنند. |
گزارش بازیابی
متد reports.query API به شما امکان می‌دهد گزارش‌های مختلف YouTube Analytics را بازیابی کنید. هر درخواست از پارامترهای پرس و جو برای تعیین شناسه کانال یا مالک محتوا، تاریخ شروع، تاریخ پایان و حداقل یک معیار استفاده می کند. همچنین می توانید پارامترهای پرس و جو اضافی مانند ابعاد، فیلترها و دستورالعمل های مرتب سازی را ارائه دهید.
| روش | درخواست HTTP | شرح |
|---|---|---|
URI های مربوط به https://youtubeanalytics.googleapis.com/v2 | ||
query | GET /reports | گزارش YouTube Analytics را بازیابی می کند. هر درخواست API از پارامترهای پرس و جو برای تعیین شناسه کانال یا مالک محتوا، تاریخ شروع، تاریخ پایان و حداقل یک معیار استفاده می کند. همچنین می توانید پارامترهای پرس و جو اضافی مانند ابعاد، فیلترها یا دستورالعمل های مرتب سازی را ارائه دهید.
|
مدیریت گروه
API دو منبع برای ایجاد و مدیریت گروه‌های YouTube Analytics فراهم می‌کند:
گروه ها
یک منبع group نشان دهنده یک گروه YouTube Analytics است که مجموعه ای سفارشی از حداکثر 500 کانال، ویدیو، لیست پخش یا دارایی است.
همه موارد در یک گروه باید یک نوع منبع را نشان دهند. به عنوان مثال، نمی توانید گروهی ایجاد کنید که دارای 100 ویدیو و 100 لیست پخش باشد.
یک گروه Analytics فقط می‌تواند حاوی منابعی باشد که شما آپلود یا ادعا کرده‌اید یا به کانالی که شما مدیریت می‌کنید پیوند داده شده‌اند. در نتیجه، صاحبان کانال می توانند گروه هایی از ویدیوها و لیست های پخش ایجاد کنند. صاحبان محتوا می‌توانند گروه‌هایی از ویدیوها، فهرست‌های پخش، کانال‌ها یا دارایی‌ها ایجاد کنند.
برای اطلاعات بیشتر در مورد این منبع، به نمایش منابع و فهرست خواص آن مراجعه کنید.
| روش | درخواست HTTP | شرح |
|---|---|---|
URI های مربوط به https://youtubeanalytics.googleapis.com/v2 | ||
list | GET /groups | فهرستی از گروه‌هایی را برمی‌گرداند که با پارامترهای درخواست API مطابقت دارند. برای مثال، می‌توانید همه گروه‌هایی را که کاربر احراز هویت شده متعلق به آنهاست بازیابی کنید، یا می‌توانید یک یا چند گروه را با شناسه‌های منحصربه‌فردشان بازیابی کنید. |
insert | POST /groups | یک گروه YouTube Analytics ایجاد می کند. پس از ایجاد گروه، از روش groupItems.insert برای افزودن موارد به گروه استفاده کنید. |
update | PUT /groups | ابرداده یک گروه را اصلاح می کند. در حال حاضر تنها ویژگی قابل به روز رسانی عنوان گروه است. (از groupItems.insert و groupItems.delete برای افزودن و حذف موارد گروه استفاده کنید.) |
delete | DELETE /groups | یک گروه را حذف می کند. |
GroupItems
یک منبع groupItem یک مورد را در یک گروه YouTube Analytics نشان می دهد.
برای اطلاعات بیشتر در مورد این منبع، به نمایش منابع و فهرست خواص آن مراجعه کنید.
| روش | درخواست HTTP | شرح |
|---|---|---|
URI های مربوط به https://youtubeanalytics.googleapis.com/v2 | ||
list | GET /groupItems | مجموعه ای از موارد گروهی را برمی گرداند که با پارامترهای درخواست API مطابقت دارند. |
insert | POST /groupItems | یک آیتم گروهی ایجاد می کند. |
delete | DELETE /groupItems | یک مورد را از یک گروه حذف می کند. |