این صفحه تغییرات API و بهروزرسانیهای اسناد را برای YouTube Reporting API و YouTube Analytics API فهرست میکند. هر دو API به توسعه دهندگان امکان می دهند به داده های YouTube Analytics دسترسی داشته باشند، البته به روش های مختلف. در این تغییرات ثبت نام کنید .
15 نوامبر 2024
توجه: تغییر زیر از 18 نوامبر 2024 لازم الاجرا است.
اسناد API YouTube Analytics (Targeted Queries) بهروزرسانی شده است تا توجه داشته باشید که برای گزارشهای Traffic Source ، روش reports.query
API اکنون یک خطا برمیگرداند اگر حاصل ضرب # ویدیوی درخواست شده X # روز در محدوده تاریخ از 50000 بیشتر شود. برای مثال، درخواستی که دادههای 500 شناسه ویدیو را بازیابی میکند، میتواند حداکثر 100 روز دادهها را درخواست کند.
این تغییر بر گزارشها برای کانالها و صاحبان محتوا تأثیر میگذارد.
برای کاهش تعداد ردیفهایی که یک درخواست برمیگرداند، درخواست خود را به چند پرسوجو تقسیم کنید که ویدیوهای کمتری را مشخص میکنند یا محدوده تاریخ کوتاهتری را تنظیم میکنند. به عنوان یک قاعده، گزارش های انبوه برای مجموعه داده های بزرگ توصیه می شود.
6 مه 2024
API YouTube Analytics (Targeted Queries) از سه گزارش جدید برای کانال ها پشتیبانی می کند:
گزارش فعالیت کاربر توسط DMA یک گزارش جغرافیایی است که آمار فعالیت کاربر را بر اساس منطقه بازار تعیین شده (DMA) ارائه می دهد. برای این گزارش، باید مقدار پارامتر
filters
را رویcountry==US
تنظیم کنید.گزارش بینندگان همزمان تعداد بینندگان همزمان را برای بخشهای مختلف یک ویدیوی پخششده زنده نشان میدهد.
گزارش لغو اعضا آماری را ارائه می دهد که نشان می دهد چرا کاربران عضویت کانال خود را لغو کردند.
این گزارش از بعد
membershipsCancellationSurveyReason
جدیدCancellationSurveyReason استفاده میکند، که مشخص میکند چرا کاربر عضویت کانال را لغو کرده است. همچنین از معیار جدیدmembershipsCancellationSurveyResponses
استفاده میکند که نشان میدهد چند عضویت کانال به همین دلیل لغو شدهاند.
علاوه بر این، گزارش حفظ مخاطب برای پشتیبانی از سه معیار جدید بهبود یافته است:
7 آوریل 2024
API YouTube Analytics (Targeted Queries) بهروزرسانیهای متعددی مرتبط با گزارشهای فهرست پخش مالک محتوا دارد. بهروزرسانیها مانند بهروزرسانیهای مربوط به گزارشهای فهرست پخش کانال است که در ۱۹ ژانویه ۲۰۲۴ اعلام شد.
ورودی تاریخچه بازبینی زیر تقریباً همان اطلاعات ورودی 19 ژانویه 2024 را ارائه میکند. با این حال، توجه داشته باشید که گزارشهای فهرست پخش مالک محتوا تا 31 دسامبر 2024 از بعد isCurated
پشتیبانی میکند، در حالی که این بعد برای گزارشهای فهرست پخش کانال تا تاریخ پشتیبانی میشود. 30 ژوئن 2024.
توجه: این یک اعلامیه منسوخ شدن است.
بعد
isCurated
برای گزارشهای فهرست پخش مالک محتوا منسوخ شده است. دیگر در 31 دسامبر 2024 یا پس از آن پشتیبانی نمیشود. تعریف آن بعد بر این اساس بهروزرسانی شده است.برای حفظ سازگاری به عقب هنگام حذف بعد
isCurated
، باید کد خود را نیز به روز کنید تا متریکplaylistViews
را به جای معیارviews
فقط برای گزارشهای فهرست پخش بازیابی کنید. از آنجایی که معیارviews
همچنان برای گزارشهای فهرست پخش پشتیبانی میشود، البته با معنایی متفاوت، اگر نام متریک را بهروزرسانی نکنید، API همچنان دادهها را برمیگرداند. البته، می توانید برنامه خود را طوری تغییر دهید که همviews
و همplaylistViews
بازیابی و نمایش دهد.علاوه بر بعد
isCurated
، عملکرد API زیر دیگر در گزارشهای جدید پشتیبانی نمیشود:- فیلترهای مکان، مانند
continent
وsubcontinent
برای گزارشهای فهرست پخش کانال جدید پشتیبانی نمیشوند. - معیارهای
redViews
وestimatedRedMinutesWatched
دیگر برای گزارشهای فهرست پخش کانال جدید پشتیبانی نمیشوند. این معیارها در YouTube Studio در دسترس نبوده اند، بنابراین این تغییر عملکرد API را با عملکرد موجود در برنامه استودیو هماهنگ می کند. - ابعاد
subscribedStatus
وyoutubeProduct
دیگر به عنوان فیلتر برای گزارشهای فهرست پخش کانال پشتیبانی نمیشوند. این فیلترها در YouTube Studio در دسترس نبوده اند، بنابراین این تغییر عملکرد API را با عملکرد موجود در برنامه استودیو هماهنگ می کند.
- فیلترهای مکان، مانند
بخش گزارشهای فهرست پخش در اسناد گزارشهای مالک محتوا بهروزرسانی شده است تا انواع معیارهایی را که برای گزارشهای فهرست پخش پشتیبانی میشوند توضیح دهد:
- سنجههای ویدیوی انبوه، معیارهای فعالیت و تأثیر کاربر را ارائه میکنند که برای همه ویدیوهای موجود در فهرستهای پخش مالک محتوا که متعلق به آن مالک محتوا نیز هستند، جمعآوری میشوند. معیارهای ویدیوی انبوه فقط برای درخواستهای API که از بعد
isCurated
استفاده نمیکنند پشتیبانی میشوند. - معیارهای درون لیست پخش، فعالیت و تعامل کاربر را در زمینه صفحه لیست پخش منعکس می کند. این معیارها شامل دادههایی میشود که شامل بازدیدهای ویدیوهای غیرمالک در فهرست پخش نیز میشود، اما فقط زمانی که این بازدیدها در زمینه فهرست پخش رخ داده باشند.
- بخش معیارهای لیست پخش پشتیبانی شده ، معیارهای ویدئویی انبوه و معیارهای درون لیست پخش را که برای گزارشهای فهرست پخش پشتیبانی میشوند، شناسایی میکند.
- سنجههای ویدیوی انبوه، معیارهای فعالیت و تأثیر کاربر را ارائه میکنند که برای همه ویدیوهای موجود در فهرستهای پخش مالک محتوا که متعلق به آن مالک محتوا نیز هستند، جمعآوری میشوند. معیارهای ویدیوی انبوه فقط برای درخواستهای API که از بعد
معیارهای جدید در فهرست پخش زیر برای گزارشهای فهرست پخش برای صاحبان محتوا پشتیبانی میشوند. توجه داشته باشید که این معیارها تنها در صورتی پشتیبانی میشوند که درخواست API برای بازیابی گزارشها از بعد
isCurated
استفاده نکند . برای تعاریف هر معیار به مستندات معیارها مراجعه کنید:رفتار معیار
views
اکنون به این بستگی دارد که آیا درخواست API که گزارش لیست پخش را بازیابی کرده است از بعدisCurated
استفاده کرده است یا خیر:- وقتی درخواستی شامل بعد
isCurated
میشود، معیارviews
معیاری در فهرست پخش است که تعداد دفعاتی را که ویدیوها در زمینه فهرستهای پخش مالک محتوا مشاهده شدهاند را نشان میدهد. - وقتی درخواستی شامل بعد
isCurated
نمیشود، معیارviews
یک متریک ویدیوی انبوه است که تعداد کل دفعاتی را که ویدیوهای موجود در فهرستهای پخش مالک محتوا مشاهده شدهاند را مشخص میکند، صرفنظر از اینکه آیا این بازدیدها در زمینه فهرست پخش انجام شده است یا خیر. مجموع جمعآوری شده فقط شامل بازدیدهایی از ویدیوهایی است که متعلق به مالک محتوای مرتبط با کانالی است که فهرست پخش را دارد.
در این گزارشها، که از بعدisCurated
استفاده نمیکنند، متریکplaylistViews
تعداد دفعاتی را که ویدیوها در زمینه فهرست پخش مشاهده شدهاند را نشان میدهد. این معیار تعداد بازدیدها را برای همه ویدیوهای موجود در فهرست پخش، بدون توجه به اینکه کدام کانال مالک آنها است، میشمارد.
- وقتی درخواستی شامل بعد
برای هر گزارش فهرست پخش، اسناد گزارش مالک محتوا اکنون شامل جداولی است که معیارهای پشتیبانی شده برای آن گزارش را بسته به اینکه درخواست API شامل بعد
isCurated
باشد نشان میدهد. برای مثال به بخش تعریف گزارش های لیست پخش مبتنی بر زمان مراجعه کنید.
19 ژانویه 2024
API YouTube Analytics (Targeted Queries) بهروزرسانیهای متعددی مرتبط با گزارشهای فهرست پخش کانال دارد. بهروزرسانیها شامل یک بعد منسوخ و چندین معیار جدید و بهروز میشوند:
توجه: این یک اعلامیه منسوخ شدن است.
بعد
isCurated
برای گزارش های کانال منسوخ شده است. دیگر در 30 ژوئن 2024 یا بعد از آن پشتیبانی نمیشود. تعریف آن بعد بر این اساس بهروزرسانی شده است.برای حفظ سازگاری به عقب هنگام حذف بعد
isCurated
، باید کد خود را نیز به روز کنید تا متریکplaylistViews
را به جای معیارviews
فقط برای گزارشهای فهرست پخش بازیابی کنید. از آنجایی که معیارviews
همچنان برای گزارشهای فهرست پخش پشتیبانی میشود، البته با معنایی متفاوت، اگر نام متریک را بهروزرسانی نکنید، API همچنان دادهها را برمیگرداند. البته، می توانید برنامه خود را طوری تغییر دهید که همviews
و همplaylistViews
بازیابی و نمایش دهد.علاوه بر بعد
isCurated
، عملکرد API زیر دیگر در گزارشهای جدید پشتیبانی نمیشود:- فیلترهای مکان، مانند
continent
وsubcontinent
برای گزارشهای فهرست پخش کانال جدید پشتیبانی نمیشوند. - معیارهای
redViews
وestimatedRedMinutesWatched
دیگر برای گزارشهای فهرست پخش کانال جدید پشتیبانی نمیشوند. این معیارها در YouTube Studio در دسترس نبوده اند، بنابراین این تغییر عملکرد API را با عملکرد موجود در برنامه استودیو هماهنگ می کند. - ابعاد
subscribedStatus
وyoutubeProduct
دیگر به عنوان فیلتر برای گزارشهای فهرست پخش کانال پشتیبانی نمیشوند. این فیلترها در YouTube Studio در دسترس نبوده اند، بنابراین این تغییر عملکرد API را با عملکرد موجود در برنامه استودیو هماهنگ می کند.
- فیلترهای مکان، مانند
بخش گزارشهای فهرست پخش در اسناد گزارشهای کانال بهروزرسانی شده است تا انواع معیارهایی را که برای گزارشهای فهرست پخش پشتیبانی میشوند، به طور کامل توضیح دهد:
- سنجههای ویدیوی انبوه، معیارهای فعالیت و تأثیر کاربر را ارائه میکنند که برای همه ویدیوهای موجود در فهرستهای پخش کانال که متعلق به آن کانال نیز هستند، جمعآوری میشوند. معیارهای ویدیوی انبوه فقط برای درخواستهای API که از بعد
isCurated
استفاده نمیکنند پشتیبانی میشوند. - معیارهای درون لیست پخش، فعالیت و تعامل کاربر را در زمینه صفحه لیست پخش منعکس می کند. این معیارها شامل دادههایی میشود که شامل بازدیدهای ویدیوهای غیرمالک در فهرست پخش نیز میشود، اما فقط زمانی که این بازدیدها در زمینه فهرست پخش رخ داده باشند.
- بخش معیارهای لیست پخش پشتیبانی شده ، معیارهای ویدئویی انبوه و معیارهای درون لیست پخش را که برای گزارشهای فهرست پخش پشتیبانی میشوند، شناسایی میکند.
- سنجههای ویدیوی انبوه، معیارهای فعالیت و تأثیر کاربر را ارائه میکنند که برای همه ویدیوهای موجود در فهرستهای پخش کانال که متعلق به آن کانال نیز هستند، جمعآوری میشوند. معیارهای ویدیوی انبوه فقط برای درخواستهای API که از بعد
معیارهای جدید در فهرست پخش زیر برای گزارشهای فهرست پخش برای کانالها پشتیبانی میشوند. این معیارها هنوز برای گزارشهای مالک محتوا پشتیبانی نمیشوند. توجه داشته باشید که این معیارها تنها در صورتی پشتیبانی میشوند که درخواست API برای بازیابی گزارشها از بعد
isCurated
استفاده نکند . برای تعاریف هر معیار به مستندات معیارها مراجعه کنید:رفتار معیار
views
اکنون به این بستگی دارد که آیا درخواست API که گزارش لیست پخش را بازیابی کرده است از بعدisCurated
استفاده کرده است یا خیر:- وقتی درخواستی شامل بعد
isCurated
میشود، معیارviews
معیاری درون فهرست پخش است که تعداد دفعاتی را که ویدیوها در فهرستهای پخش کانال مشاهده شدهاند را نشان میدهد. - وقتی درخواستی شامل بعد
isCurated
نمیشود، معیارviews
یک متریک ویدیوی انبوه است که تعداد کل دفعاتی که آن ویدیو در فهرستهای پخش کانال مشاهده شده است را مشخص میکند، صرف نظر از اینکه آیا این بازدیدها در زمینه فهرست پخش انجام شده است یا خیر. مجموع جمعآوری شده فقط شامل بازدیدهایی از ویدیوهایی است که متعلق به کانالی است که فهرست پخش را دارد.
در این گزارشها، که از بعدisCurated
استفاده نمیکنند، متریکplaylistViews
تعداد دفعاتی را که ویدیوها در زمینه فهرست پخش مشاهده شدهاند را نشان میدهد. این معیار تعداد بازدیدها را برای همه ویدیوهای موجود در فهرست پخش، بدون توجه به اینکه کدام کانال مالک آنها است، میشمارد.
- وقتی درخواستی شامل بعد
برای هر گزارش فهرست پخش، اسناد گزارشهای کانال اکنون شامل جداولی است که معیارهای پشتیبانی شده برای آن گزارش را بسته به اینکه درخواست API شامل بعد
isCurated
باشد نشان میدهد. برای مثال به بخش تعریف گزارش های لیست پخش مبتنی بر زمان مراجعه کنید.
04 دسامبر 2023
API YouTube Analytics (Targeted Queries) برای ادغام دو مقدار ابعاد insightTrafficSourceType
به روز شده است. قبلاً، بعد بین ویدیوهای پخش شده به عنوان بخشی از فهرست پخش ( PLAYLIST
) و بازدیدهایی که از صفحهای که همه ویدیوهای موجود در فهرست پخش را فهرست میکند ( YT_PLAYLIST_PAGE
) نشات میگرفت. در ادامه، هر دو نوع نما با مقدار بعد PLAYLIST
مرتبط خواهند شد.
15 دسامبر 2022
API YouTube Analytics (Targeted Queries) از دو بعد جدید و یک گزارش جدید پشتیبانی می کند:
یک گزارش جدید فعالیت کاربر را بر اساس شهر ارائه می دهد. این گزارش برای کانال ها و صاحبان محتوا در دسترس است. این گزارش شامل بعد
city
جدید است که تخمین یوتیوب از شهری که فعالیت کاربر در آن انجام شده را مشخص می کند.بعد
creatorContentType
جدید نوع محتوای YouTube را که با معیارهای فعالیت کاربر در ردیف داده مرتبط است، مشخص می کند. مقادیر پشتیبانی شده عبارتند ازLIVE_STREAM
،SHORTS
،STORY
وVIDEO_ON_DEMAND
.بعد
creatorContentType
به عنوان یک بعد اختیاری برای همه گزارشهای ویدیویی مالک کانال و محتوا پشتیبانی میشود.راهنمای نمونه درخواستهای API YouTube Analytics اکنون شامل نمونههایی برای هر دو بعد جدید است.
ارجاع به ابعاد
7DayTotals
و30DayTotals
از مستندات حذف شده است. منسوخ شدن این ابعاد در اکتبر 2019 اعلام شد.
26 آگوست 2022
API YouTube Analytics (Targeted Queries) و YouTube Reporting (گزارشهای انبوه) هر دو از مقدار جزئیات منبع ترافیک جدید پشتیبانی میکنند:
- در API YouTube Analytics API (پرسمانهای هدفمند)، اگر مقدار بعد
insightTrafficSourceType
SUBSCRIBER
باشد، میتوان مقدارinsightTrafficSourceDetail
را رویpodcasts
تنظیم کرد که نشان میدهد ترافیک از صفحه مقصد پادکست ارجاع شده است. - در API گزارشهای YouTube (گزارشهای انبوه)، اگر مقدار بعد
traffic_source_type
3
باشد، میتوان مقدارtraffic_source_detail
را رویpodcasts
تنظیم کرد که نشان میدهد ترافیک از صفحه مقصد پادکست ارجاع شده است.
11 فوریه 2022
مجموعه مقادیر معتبر برای بعد gender
در 11 آگوست 2022 یا پس از آن تغییر خواهد کرد. این ممکن است یک تغییر ناسازگار در اجرای API شما باشد. مطابق با بخش «تغییرات ناسازگار با عقبنشینی» شرایط خدمات سرویسهای YouTube API، این تغییر شش ماه قبل از اجرایی شدن اعلام شده است. لطفاً اجرای API خود را قبل از 11 آگوست 2022 بهروزرسانی کنید تا از انتقال یکپارچه به مجموعه جدید مقادیر اطمینان حاصل کنید.
تغییرات خاصی که ایجاد می شود عبارتند از:
- در API YouTube Analytics (پرسمانهای هدفمند)، بعد
gender
در حال حاضر از دو مقدار پشتیبانی میکند:female
وmale
. در 11 آگوست 2022 یا پس از آن، این بعد از سه مقدار پشتیبانی میکند:female
،male
وuser_specified
. - در API گزارشهای YouTube (گزارشهای انبوه)، بعد
gender
در حال حاضر از سه مقدار پشتیبانی میکند:FEMALE
،MALE
، وGENDER_OTHER
. در 11 اوت 2022 یا پس از آن، مجموعه مقادیر پشتیبانیشده بهFEMALE
،MALE
وUSER_SPECIFIED
تغییر میکند.
9 فوریه 2022
از تاریخ 13 دسامبر 2021، دو معیار بهروزرسانی شده است تا ترافیک کلیپهای حلقهای را حذف کند. این تغییر هم بر API YouTube Analytics (پرسمانهای هدفمند) و هم بر API گزارش YouTube (گزارشهای انبوه) تأثیر میگذارد.
- در API YouTube Analytics (Targeted Queries)، معیارهای
averageViewDuration
وaverageViewPercentage
هر دو از 13 دسامبر 2021 ترافیک کلیپ های حلقه را حذف می کنند. - در API گزارشهای YouTube (گزارشهای انبوه)، معیارهای
average_view_duration_seconds
وaverage_view_duration_percentage
هر دو از 13 دسامبر 2021 ترافیک کلیپهای حلقهای را حذف میکنند.
2 فوریه 2022
این API گزارش YouTube (گزارشهای انبوه) از مقدار بعدی منبع ترافیک جدید پشتیبانی میکند که نشان میدهد بازدیدها از تغییرمسیرهای زنده نشات گرفتهاند:
- در API گزارش YouTube (گزارشهای انبوه)، بعد
traffic_source_type
از مقدار28
پشتیبانی میکند.
برای این نوع منبع ترافیک، بعد traffic_source_detail
شناسه کانالی را که بیننده از آن ارجاع داده شده است، مشخص می کند.
23 سپتامبر 2020
این API تجزیه و تحلیل YouTube (پرسمانهای هدفمند) و API گزارش YouTube (گزارشهای انبوه) هر دو از یک مقدار بعدی منبع ترافیک جدید پشتیبانی میکنند که نشان میدهد با کشیدن انگشت بهصورت عمودی در تجربه مشاهده YouTube Shorts به بیننده ارجاع داده شده است:
- در API YouTube Analytics API (پرسمانهای هدفمند)، بعد
insightTrafficSourceType
از مقدارSHORTS
پشتیبانی میکند. - در API گزارش YouTube (گزارشهای انبوه)، بعد
traffic_source_type
از مقدار24
پشتیبانی میکند.
بعد جزئیات منبع ترافیک - insightTrafficSourceDetail
در YouTube Analytics API یا traffic_source_detail
در YouTube Reporting API - برای این نوع منبع ترافیک جدید پر نشده است.
20 جولای 2020
این بهروزرسانی دو تغییر را پوشش میدهد که بر API YouTube Analytics (پرسمانهای هدفمند) تأثیر میگذارد:
- حداکثر اندازه یک گروه گزارش YouTube Analytics از 200 به 500 مورد افزایش یافته است.
- پارامتر
filters
روشreports.query
فهرستی از فیلترهایی را که باید هنگام بازیابی دادههای YouTube Analytics اعمال شوند، شناسایی میکند. این پارامتر از توانایی تعیین چندین مقدار برای فیلترهایvideo
،playlist
وchannel
پشتیبانی می کند و حداکثر تعداد شناسه هایی که می توان برای آن فیلترها مشخص کرد از 200 به 500 شناسه افزایش یافته است.
13 فوریه 2020
این بهروزرسانی شامل تغییرات زیر مربوط به API YouTube Analytics (پرسمانهای هدفمند) و API گزارش YouTube (گزارشهای انبوه) است. میتوانید در مرکز راهنمای YouTube درباره این تغییرات بیشتر بدانید.
در هر دو API، مجموعه مقادیر جزئیات منبع ترافیک احتمالی برای اعلانها در حال تغییر است. در جستارهای هدفمند ، اعلانها بهعنوان insightTrafficSourceType=NOTIFICATION
گزارش میشوند. در گزارشهای انبوه ، اعلانها بهعنوان traffic_source_type=17
گزارش میشوند.
مقادیر جدید اعلانهای مربوط به ویدیوهای آپلود شده و جریانهای زنده را که قبلاً بهعنوان uploaded
گزارش شدهاند، به دو دسته تقسیم میکنند:
-
uploaded_push
- بازدیدها از اعلانهای فشاری که هنگام آپلود یک ویدیو برای مشترکین ارسال میشود، ایجاد میشود. -
uploaded_other
- بازدیدها از اعلانهای غیر فشاری، مانند اعلانهای ایمیل یا صندوق ورودی که هنگام آپلود ویدیو برای مشترکین ارسال میشوند، نشات میگیرند.
این مقادیر برای بازه زمانی از 13-01-2020 (13 ژانویه 2020) شروع می شود.
همچنین، به عنوان یادآوری، این مقادیر خود اعلانها را نشان نمیدهند، بلکه منابع ترافیکی را نشان میدهند که بازدیدهای خاصی از YouTube را ایجاد کردهاند. برای مثال، اگر یک ردیف گزارش views=3
، traffic_source_type=17
( NOTIFICATION
) و traffic_source_detail=uploaded_push
نشان دهد، این ردیف نشان میدهد که سه بازدید از کلیک بینندگان بر روی اعلانهای ارسال شده هنگام آپلود ویدیو حاصل شده است.
15 اکتبر 2019
این بهروزرسانی شامل تغییرات زیر مربوط به YouTube Analytics (پرسمانهای هدفمند) API است:
توجه: این یک اعلامیه منسوخ شدن است.
YouTube پشتیبانی از ابعاد
7DayTotals
و30DayTotals
را حذف می کند. تا 15 آوریل 2020 همچنان میتوانید با استفاده از آن ابعاد دادهها را بازیابی کنید. در آن تاریخ یا بعد از آن، تلاش برای بازیابی گزارشها با استفاده از بعد7DayTotals
یا30DayTotals
با خطا مواجه میشود.توجه داشته باشید که کاربران میتوانند برخی از دادههای این ابعاد را با استفاده از بعد
day
و جمعآوری یا استخراج دادهها در دورههای هفت یا 30 روزه بازتولید کنند. به عنوان مثال:- تعداد بازدیدها برای یک دوره هفت روزه را می توان با تجمیع تعداد بازدیدها از هر روز آن دوره محاسبه کرد.
- درصد بازدیدکنندگان برای یک دوره هفت روزه را میتوان با ضرب تعداد بازدیدهایی که هر روز انجام میشود در درصد بیننده برای آن روز محاسبه کرد تا تعداد بینندگانی را که هنگام تماشای ویدیو در آن روز وارد سیستم شدهاند به دست آید. سپس، تعداد بینندگان وارد شده را می توان برای کل دوره اضافه کرد و بر تعداد کل بازدیدها برای آن دوره تقسیم کرد تا viewerPercentage برای کل دوره بدست آید.
- تعداد بینندگان منحصر به فرد برای یک دوره هفت روزه قابل محاسبه نیست زیرا یک بیننده می تواند به عنوان یک بیننده منحصر به فرد در روزهای مختلف محاسبه شود. با این حال، ممکن است بتوانید از بعد
month
به جای بعد30DayTotals
برای برون یابی داده های مربوط به تعداد بینندگان منحصر به فرد در یک دوره 30 روزه استفاده کنید. توجه داشته باشید که بعدmonth
به ماه های تقویم اشاره دارد در حالی که بعد30DayTotals
دوره های 30 روزه را بر اساس تاریخ شروع و پایان مشخص شده محاسبه می کند.
27 ژوئن 2019
این بهروزرسانی شامل تغییرات زیر مربوط به YouTube Analytics (پرسمانهای هدفمند) API است:
از آنجایی که نسخه 1 API اکنون کاملاً منسوخ شده است، اسناد برای حذف ارجاعات به آن نسخه، از جمله اخطار منسوخ شدن و راهنمای مهاجرت که نحوه به روز رسانی به نسخه 2 را توضیح می دهد، به روز شده است.
1 نوامبر 2018
این بهروزرسانی شامل تغییرات زیر مربوط به YouTube Analytics (پرسمانهای هدفمند) API است:
نسخه 1 API اکنون منسوخ شده است. اگر قبلاً این کار را نکردهاید، لطفاً مشتریان API خود را بهروزرسانی کنید تا در اسرع وقت از نسخه 2 API استفاده کنند تا اختلالات سرویس به حداقل برسد. برای جزئیات بیشتر به راهنمای مهاجرت مراجعه کنید.
توجه داشته باشید که برنامه این انحلال در ابتدا در تاریخ 26 آوریل 2018 اعلام شد.
17 سپتامبر 2018
این بهروزرسانی شامل تغییرات زیر مربوط به API YouTube Analytics (پرسمانهای هدفمند) است:
بخش جدید ناشناسسازی داده در سند نمای کلی مدل داده توضیح میدهد که برخی از دادههای YouTube Analytics زمانی محدود میشوند که معیارها به آستانه خاصی نرسند. این می تواند در موارد مختلفی اتفاق بیفتد. در عمل، به این معنی است که یک گزارش ممکن است شامل همه (یا هیچ کدام) از داده های شما نباشد اگر:
یک ویدیو یا کانال در یک بازه زمانی مشخص ترافیک محدودی دارد،
یا
شما یک فیلتر یا بعد انتخاب کرده اید، مانند منبع ترافیک یا کشور، که مقادیر برای آن آستانه مشخصی را برآورده نمی کنند.
بخش جدید همچنین شامل بحثی درباره انواع دادههایی است که ممکن است در گزارشهای YouTube Analytics محدود شوند.
گزارشهای کانال و اسناد گزارشهای مالک محتوا بهروزرسانی شدهاند تا منعکسکننده این واقعیت باشند که معیارهای
redViews
وestimatedRedMinutesWatched
دیگر برای مکان پخش، منبع ترافیک، و نوع دستگاه/گزارشهای سیستم عامل پشتیبانی نمیشوند.
18 ژوئن 2018
این بهروزرسانی شامل تغییرات زیر در YouTube Analytics (پرسمانهای هدفمند) API است:
- الزامات دامنه برای روش های زیر تغییر کرده است:
- درخواستها به روش
reports.query
باید بهhttps://www.googleapis.com/auth/youtube.readonly
دامنه دسترسی داشته باشند. - درخواستهای متد
groupItems.list
باید به یکی از این موارد دسترسی داشته باشند:- محدوده
https://www.googleapis.com/auth/youtube
یا - محدوده
https://www.googleapis.com/auth/youtube.readonly
و
محدودهhttps://www.googleapis.com/auth/yt-analytics.readonly
گزینه اول از یک محدوده استفاده می کند که اتفاقاً یک محدوده خواندن-نوشتن است، در حالی که گزینه دوم از دو محدوده فقط خواندنی استفاده می کند.
- محدوده
- درخواستها به روش
23 مه 2018
این بهروزرسانی شامل تغییرات زیر در YouTube Analytics (پرسمانهای هدفمند) API است:
- نمای کلی API شامل بخش جدیدی، معیارهای انبوه و موارد حذف شده است، که توضیح میدهد چگونه پاسخهای API دادههای مرتبط با منابع حذفشده، مانند ویدیوها، فهرستهای پخش، یا کانالها را مدیریت میکنند.
- بخش بهترین شیوه های API Overview به روز شده است تا به شما یادآوری کند که می توانید از YouTube Data API برای بازیابی متادیتاهای اضافی برای منابع شناسایی شده در پاسخ های YouTube Analytics API استفاده کنید. همانطور که در خطمشیهای توسعهدهنده سرویسهای YouTube API (بخشهای III.E.4.b تا III.E.4.d) ذکر شده است، مشتریان API باید پس از 30 روز ابردادههای منبع ذخیرهشده را از آن API حذف یا تازهسازی کنند.
22 مه 2018
این بهروزرسانی شامل تغییرات زیر مربوط به API گزارشهای YouTube (گزارشهای انبوه) است:
- تغییرات زیر در حال حاضر برنامه ریزی شده است که در جولای 2018 اعمال شوند و سیاست های جدید در سطح جهانی برای همه گزارش ها و مشاغل گزارش دهی اعمال می شود.
پس از تغییر، اکثر گزارشهای API، از جمله گزارشهای پر کردن، به مدت 60 روز از زمان تولید در دسترس خواهند بود. با این حال، گزارشهای حاوی دادههای تاریخی به مدت 30 روز از زمان تولید در دسترس خواهند بود.
قبل از این اعلامیه، همه گزارشهای API به مدت 180 روز از زمان تولید در دسترس بودهاند. برای روشن بودن، وقتی این تغییر خطمشی اعمال شود، گزارشهای دادههای تاریخی که بیش از 30 روز از آن گذشته است نیز دیگر از طریق API قابل دسترسی نخواهند بود. سایر گزارشهایی که بیش از 60 روز از آن گذشته است نیز دیگر قابل دسترسی نخواهند بود. به این ترتیب، اکنون اسناد بیان می کند که گزارش های ایجاد شده قبل از تغییر خط مشی تا 180 روز در دسترس خواهند بود.
پس از تغییر، وقتی یک کار گزارشدهی را برنامهریزی میکنید، YouTube از آن روز به بعد گزارشهایی تولید میکند و دوره 30 روزه قبل از زمان برنامهریزی کار را پوشش میدهد. قبل از تغییر، وقتی یک کار گزارشدهی را برنامهریزی میکنید، YouTube گزارشهایی تولید میکند که دوره ۱۸۰ روزه قبل از زمان برنامهریزی کار را پوشش میدهد.
بخش بهترین روشها بهروزرسانی شده است تا به شما یادآوری کند که میتوانید از YouTube Data API برای بازیابی فرادادههای اضافی برای منابع شناساییشده در گزارشها استفاده کنید. همانطور که در خطمشیهای توسعهدهنده سرویسهای YouTube API (بخشهای III.E.4.b تا III.E.4.d) ذکر شده است، مشتریان API باید پس از 30 روز ابردادههای منبع ذخیرهشده را از آن API حذف یا تازهسازی کنند.
بخش ویژگیهای گزارش بهروزرسانی شده است تا توجه داشته باشید که حتی اگر دادههای گزارش فیلتر نشده باشند، گزارشهایی که حاوی دادههایی برای یک دوره زمانی در یا پس از ۱ ژوئن ۲۰۱۸ هستند، حاوی هیچ ارجاعی به منابع YouTube که حداقل ۳۰ روز قبل حذف شدهاند نخواهند بود. تا تاریخ تولید گزارش
بخش دادههای تاریخی در نمای کلی API بهروزرسانی شده است تا توجه داشته باشید که وقتی یک کار گزارشدهی جدید را برنامهریزی میکنید، گزارشهای تاریخی معمولاً ظرف چند روز پست میشوند. پیش از این، مستندات بیان میکرد که ممکن است تا 30 روز طول بکشد تا چنین گزارشهایی در دسترس باشند.
بخش دادههای پرشده در نمای کلی API بهروزرسانی شده است تا دادههای پرشده را بهعنوان مجموعه دادهای که جایگزین مجموعهای که قبلاً تحویل داده شده است، با وضوح بیشتری تعریف کند.
26 آوریل 2018
نسخه 2 از YouTube Analytics (Targeted Queries) API (v2) اکنون برای عموم در دسترس است. لیست زیر تغییرات محصول و اسناد مربوط به نسخه جدید API را مشخص می کند:
v2 API تقریباً مشابه v1 API است. با این حال، احتمالاً باید کد خود را به روز کنید تا تغییرات ذکر شده در زیر را منعکس کند. همه این تغییرات در راهنمای مهاجرت جدید به تفصیل توضیح داده شده است.
- نسخه API از
v1
بهv2
تغییر کرده است. - URL پایه درخواستهای API از
https://www.googleapis.com/youtube/analytics/v1
بهhttps://youtubeanalytics.googleapis.com/v2
تغییر کرده است. - چندین پارامتر برای روش
reports.query
نامهای بهروز شدهاند. به طور خاص، نام پارامترهایی که حاوی خط تیره هستند، مانندend-date
در v1 API، به جای خط تیره در v2 API، از camel case (endDate
) استفاده می کنند. این تغییر نام پارامترها را در سراسر API ثابت میکند زیرا روشهای API برای ایجاد و مدیریت گروهها قبلاً از پوشش شتر برای نام پارامترها استفاده میکردند. - v2 API از درخواست های دسته ای ارسال شده به نقطه پایانی دسته ای HTTP جهانی Google (
www.googleapis.com/batch
) پشتیبانی نمی کند. اگر درخواست های دسته ای را در API v2 ارسال می کنید، باید به جای آن از نقطه پایانیhttps://youtubeanalytics.googleapis.com/v2
استفاده کنید.
علاوه بر این، چند ویژگی v1 در API v2 پشتیبانی نمیشوند:
- متد
reports.query
دیگر پارامترهای درخواستalt
،quotaUser
وuserIp
را پشتیبانی نمیکند. - v2 API یک نقطه پایانی دسته ای ارائه نمی دهد که از دسته های متشکل از درخواست های API های مختلف پشتیبانی کند. (با این حال، یک دسته میتواند شامل درخواستهایی به روشهای مختلف یک API باشد.) این انصراف مختص API YouTube Analytics نیست، زیرا Google در حال منسوخ کردن نقطه پایان دستهای جهانی در همه APIهای خود است.
- v2 API از پروتکل JSON-RPC که در API v1 پشتیبانی میشد، پشتیبانی نمیکند. باز هم، این منسوخ شدن مختص API YouTube Analytics نیست.
- نسخه API از
توجه: این یک اعلامیه منسوخ شدن است.
نسخه 1 API (v1) اکنون منسوخ شده است و تا 31 اکتبر 2018 پشتیبانی میشود. همه درخواستهای API v1 پس از آن تاریخ دیگر کار نمیکنند. به این ترتیب، لطفاً حتماً حداکثر تا 31 اکتبر 2018 به API v2 ارتقا دهید تا از هرگونه وقفه در توانایی شما برای دسترسی به دادههای YouTube Analytics از طریق API جلوگیری شود.
21 فوریه 2018
این بهروزرسانی شامل تغییرات زیر در YouTube Analytics (پرسمانهای هدفمند) API است:
- گزارشهای جمعیتی بیننده، که آمار بازدید را بر اساس گروه سنی و جنسیت بینندگان جمعآوری میکند، دیگر از بعد
youtubeProduct
پشتیبانی نمیکند، که سرویس YouTube را که فعالیت کاربر در آن انجام شده است، مشخص میکند.
18 ژانویه 2018
این به روز رسانی شامل تغییرات زیر است:
YouTube Reporting API (گزارشهای انبوه)
- بعد
operating_system
که سیستم نرم افزاری دستگاهی را که نماها روی آن اتفاق افتاده را مشخص می کند، اکنون از مقدار زیر پشتیبانی می کند:-
25
: KaiOS
-
- بعد
YouTube Analytics API (پرسمانهای هدفمند)
- بعد
operatingSystem
از مقدار ابعادKAIOS
پشتیبانی می کند.
- بعد
20 دسامبر 2017
این بهروزرسانی شامل دو تغییر مربوط به YouTube Reporting API است:
سرور API اکنون از فشردهسازی gzip برای درخواستهایی که گزارشها را دانلود میکنند، پشتیبانی میکند. توجه داشته باشید که فشرده سازی gzip برای انواع دیگر درخواست های API پشتیبانی نمی شود. فعال کردن فشردهسازی gzip، پهنای باند مورد نیاز برای هر پاسخ API را کاهش میدهد. و در حالی که برنامه شما برای فشرده سازی پاسخ های API به زمان CPU بیشتری نیاز دارد، مزایای مصرف کمتر منابع شبکه معمولاً بیشتر از این هزینه است.
برای دریافت پاسخ کدگذاری شده با gzip، هدر درخواست HTTP
Accept-Encoding
را همانطور که در مثال زیر نشان داده شده است، رویgzip
قرار دهید:Accept-Encoding: gzip
این عملکرد در نمای کلی API و در تعریف ویژگی
downloadUrl
منبعreport
توضیح داده شده است.اسناد
age group
و ابعادgender
برای نشان دادن مقادیر واقعی که API برای آن ابعاد برمیگرداند اصلاح شده است. توجه داشته باشید که این یک تصحیح مستندات است و تغییری در عملکرد یا رفتار API را نشان نمیدهد. به طور خاص، مقادیر زیر تغییر کرده است:- مقادیر برای بعد
age_group
از حروف بزرگ استفاده می کنند، شامل زیرخط بین کلمهAGE
و اعداد در گروه سنی هستند و از زیرخط به جای خط تیره استفاده می کنند. به این ترتیب، مقادیری مانندage13-17
وage18-24
به ترتیب بهAGE_13_17
وAGE_18_24
اصلاح شدهاند. - مقادیر برای بعد
gender
از حروف بزرگ استفاده می کنند. بنابراین، مقادیرfemale
،male
وgender_other
بهFEMALE
،MALE
، وGENDER_OTHER
اصلاح شدهاند.
- مقادیر برای بعد
10 آگوست 2017
در 10 آگوست 2016، این مستندات منسوخ شدن معیار earnings
YouTube Analytics API را اعلام کرد. (در همان زمان، API از یک معیار جدید به نام estimatedRevenue
پشتیبانی کرد که همان داده ها را ارائه می دهد.)
از آنجایی که معیار earnings
یک معیار اصلی بود، از تاریخ اعلام به مدت یک سال پشتیبانی شد. اکنون که آن دوره یک ساله به پایان رسیده است، معیار earnings
دیگر پشتیبانی نمی شود. در نتیجه، درخواستهای API که معیار earnings
را مشخص میکنند، اکنون کد پاسخ 400
HTTP را برمیگردانند. اگر قبلاً برنامه خود را برای استفاده از معیار estimatedRevenue
بهجای معیار earnings
بهروزرسانی نکردهاید، لطفاً در اسرع وقت این کار را انجام دهید.
اسناد API برای حذف ارجاعهای باقیمانده به معیار earnings
بهروزرسانی شده است.
6 جولای 2017
این به روز رسانی شامل تغییرات زیر است:
YouTube Analytics API (پرسمانهای هدفمند)
اسناد API بهروزرسانی شده است تا منعکسکننده این واقعیت باشد که پاسخهای API حاوی دادههایی تا آخرین روز در محدوده تاریخ درخواستی هستند که تمام معیارهای مورد نظر برای آن موجود است.
به عنوان مثال، اگر یک درخواست تاریخ پایان 5 ژوئیه 2017 را مشخص کند و مقادیر برای همه معیارهای درخواستی فقط تا 3 ژوئیه 2017 در دسترس باشد، این آخرین تاریخی است که دادهها در پاسخ گنجانده شده است. (این درست است حتی اگر داده های برخی از معیارهای درخواستی برای 4 ژوئیه 2017 در دسترس باشد.)
بعد
adType
اکنون از مقدارreservedBumperInstream
پشتیبانی میکند، که به یک تبلیغ ویدیویی غیرقابل رد شدن تا 6 ثانیه اشاره دارد که قبل از مشاهده ویدیو پخش میشود. فرمت تبلیغات مشابه با تبلیغauctionBumperInstream
است، اما این نوع به تبلیغات فروخته شده به صورت رزرو شده و نه بر اساس حراج اشاره دارد.
YouTube Reporting API (گزارشهای انبوه)
بعد
ad_type
اکنون از مقدار20
پشتیبانی می کند که به تبلیغات باپری که به صورت رزرو فروخته می شوند اشاره دارد. تبلیغات بامپر، تبلیغات ویدیویی غیرقابل رد شدن تا 6 ثانیه هستند که قبل از مشاهده ویدیو پخش می شوند. توجه داشته باشید که مقدار19
برای این بعد به تبلیغات باپری نیز اشاره دارد که به جای رزرو به صورت حراجی فروخته می شوند.مشاغل گزارشدهی برای گزارشهای YouTube Reporting API زیر حذف شدهاند:
-
channel_basic_a1
-
channel_province_a1
-
channel_playback_location_a1
-
channel_traffic_source_a1
-
channel_device_os_a1
-
channel_subtitles_a1
-
channel_combined_a1
-
content_owner_basic_a2
-
content_owner_province_a1
-
content_owner_playback_location_a1
-
content_owner_traffic_source_a1
-
content_owner_device_os_a1
-
content_owner_subtitles_a1
-
content_owner_combined_a1
-
content_owner_asset_basic_a1
-
content_owner_asset_province_a1
-
content_owner_asset_playback_location_a1
-
content_owner_asset_traffic_source_a1
-
content_owner_asset_device_os_a1
-
content_owner_asset_combined_a1
این انواع گزارش ها در تاریخ 15 سپتامبر 2016 کاهش یافته اند و گزارش ها دیگر برای آن دسته از گزارش ها پس از 15 دسامبر 2016 تهیه نشده است. گزارش های قبلاً از زمان تولید آنها هنوز به مدت 180 روز در دسترس بودند. بنابراین ، برخی از گزارش ها از اواخر 15 ژوئن 2017 در دسترس بودند. با این حال ، از آنجا که گزارش ها دیگر در دسترس نیستند ، مشاغل مرتبط با گزارش ها نیز لازم نیست.
-
24 مه 2017
کلیه مشاغل گزارش دهی برای گزارش های API گزارش YouTube زیر حذف شده است:
-
content_owner_ad_performance_a1
-
content_owner_asset_estimated_earnings_a1
-
content_owner_estimated_earnings_a1
این انواع گزارش ها در 22 ژوئن 2016 کاهش یافته اند ، و گزارش ها پس از 22 سپتامبر 2016 دیگر برای آن نوع گزارش ها تهیه نشده است. گزارش های تهیه شده قبلاً از زمان تولید هنوز به مدت 180 روز در دسترس بودند. بنابراین ، برخی از گزارش ها از اواخر 22 مارس 2017 در دسترس بودند. با این حال ، از آنجا که گزارش ها دیگر در دسترس نیستند ، مشاغل مرتبط با گزارش ها نیز لازم نیست.
22 مه 2017
این به روزرسانی شامل تغییرات زیر است:
گزارش YouTube API (گزارش های فله)
- ابعاد
sharing_service
، که خدمتی را که برای به اشتراک گذاری فیلم ها استفاده می شود ، مشخص می کند ، اکنون از مقادیر زیر پشتیبانی می کند:-
85
: موسیقی یوتیوب -
86
: بازی YouTube -
87
: بچه های یوتیوب -
88
: تلویزیون یوتیوب
علاوه بر این ، نامی که برای شناسایی مقدار
52
استفاده شده است در مستندات به Kakao (Kakao Talk) به روز شده است تا به وضوح تر آن را از ارزش73
(داستان Kakao) متمایز کند. این تغییر هیچ تغییری در رفتار API یا طبقه بندی فیلم های به اشتراک گذاشته شده با این خدمات نشان نمی دهد. -
- ابعاد
YouTube Analytics API (نمایش داده شدگان هدفمند)
- ابعاد
sharingService
اکنون از مقادیر زیر پشتیبانی می کند:-
YOUTUBE_GAMING
-
YOUTUBE_KIDS
-
YOUTUBE_MUSIC
-
YOUTUBE_TV
-
- ابعاد
28 مارس 2017
صاحبان کانال که می توانند از طریق YouTube Analytics در Creator Studio به داده های درآمد دسترسی پیدا کنند هم اکنون می توانند به داده های درآمد از طریق API API YouTube دسترسی پیدا کنند:
API از معیارهای مربوط به درآمد زیر پشتیبانی می کند:
-
adImpressions
-
cpm
-
estimatedAdRevenue
-
estimatedRedPartnerRevenue
-
estimatedRevenue
-
grossRevenue
-
monetizedPlaybacks
-
playbackBasedCpm
این معیارها برای گزارش های زیر پشتیبانی می شوند:
-
صاحبان کانال هم اکنون می توانند گزارش عملکرد AD را بازیابی کنند ، که از بعد
adType
و همچنین ابعادday
اختیاری پشتیبانی می کند.راهنمای درخواست های نمونه API API YouTube اکنون شامل بخشی برای گزارش های درآمد کانال است.
17 مارس 2017
این به روزرسانی شامل تغییرات زیر است:
API YouTube Analytics از معیارهای
redViews
و تخمین زده شده از معیارهایestimatedRedMinutesWatched
پشتیبانی می کند ، که هر دو مربوط به بینندگان قرمز YouTube هستند. در حقیقت ، API در واقع برای مدتی از این معیارها پشتیبانی کرده است ، و API گزارش دهنده YouTube در حال حاضر از هر دو معیاری که در 15 سپتامبر 2016 اعلام شده است ، پشتیبانی می کند.- متریک
redViews
تعداد دفعاتی را که یک فیلم توسط اعضای YouTube Red مشاهده شده است ، مشخص می کند. - متریک
estimatedRedMinutesWatched
تعداد دقایقی را که اعضای YouTube Red یک فیلم را تماشا می کردند ، مشخص می کند.
گزارش های کانال و مستندات گزارش های صاحب محتوا به روز شده است تا نشان دهد کدام گزارش از دو معیار جدید پشتیبانی می کند. آنها در هر گزارشی که قبلاً از
views
و معیارهایestimatedMinutesWatched
پشتیبانی می کنند ، پشتیبانی می شوند.- متریک
3 مارس 2017
این به روزرسانی شامل تغییرات زیر است:
گزارش YouTube API (گزارش های فله)
تعریف بعد
date
تصحیح شده است تا توجه داشته باشد که مقدار ابعاد به دوره آغاز شده از ساعت 12:00 صبح اقیانوس آرام و پایان ساعت 11:59 بعد از ظهر اقیانوس آرام در روز ، ماه و سال مشخص شده است. بسته به زمان سال ، زمان اقیانوس آرام یا UTC-7 یا UTC-8 است.اگرچه تاریخ ها به طور معمول یک دوره 24 ساعته را نشان می دهند ، تاریخ هایی که ساعت ها به جلو تنظیم می شوند ، یک دوره 23 ساعته را نشان می دهند و تاریخ هایی که ساعتها به عقب تنظیم می شوند ، یک دوره 25 ساعته را نشان می دهند. (پیش از این ، اسناد و مدارک اظهار داشت که هر تاریخ یک دوره 24 ساعته منحصر به فرد را نشان می داد و زمان اقیانوس آرام همیشه UTC-8 بود.)
توجه داشته باشید که این اصلاح نشان دهنده تغییر در رفتار واقعی API نیست.
- بعد
operating_system
، که سیستم نرم افزاری دستگاهی را که در آن مشاهده شده است مشخص می کند ، اکنون از مقادیر زیر پشتیبانی می کند:-
22
: Tizen -
23
: فایرفاکس -
24
: RealMedia
-
کلیه مشاغل گزارش دهی برای نوع گزارش
content_owner_basic_a1
حذف شده است. این نوع گزارش از 19 اوت 2016 کاملاً مستهلک شده بود ، اما قبلاً گزارش هایcontent_owner_basic_a1
تولید شده بود ، از زمان تولید آنها هنوز 180 روز در دسترس بود. بنابراین ، برخی از گزارش ها از اواخر 19 فوریه 2017 در دسترس بودند. با این حال ، از آنجا که گزارش ها دیگر در دسترس نیستند ، مشاغل مرتبط با گزارش ها نیز لازم نیست.
YouTube Analytics API (نمایش داده شدگان هدفمند)
توضیحات ابعاد مربوط به
time periods
تصحیح شده است تا توجه داشته باشد که مقدار ابعاد به دوره آغاز شده از ساعت 12:00 صبح اقیانوس آرام و پایان ساعت 11:59 بعد از ظهر اقیانوس آرام در روز ، ماه و سال مشخص شده است. بسته به زمان سال ، زمان اقیانوس آرام یا UTC-7 یا UTC-8 است.اگرچه تاریخ ها به طور معمول یک دوره 24 ساعته را نشان می دهند ، تاریخ هایی که ساعت ها به جلو تنظیم می شوند ، یک دوره 23 ساعته را نشان می دهند و تاریخ هایی که ساعتها به عقب تنظیم می شوند ، یک دوره 25 ساعته را نشان می دهند. (پیش از این ، اسناد و مدارك اظهار داشت كه زمان اقیانوس آرام UTC-8 بوده است و این احتمال را ذکر نکرده است كه یك روز ممكن است یك دوره 24 ساعته را نشان ندهد.)
توجه داشته باشید که این اصلاح نشان دهنده تغییر در رفتار واقعی API نیست.
مستندات گزارش کانال به روز شده است تا توجه داشته باشد که گزارش های کانال در حال حاضر حاوی درآمد یا معیارهای عملکرد AD نیستند. در نتیجه ،
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
دامنه در حال حاضر دسترسی به داده های پولی را در گزارش های کانال اعطا نمی کند.- بعد
operatingSystem
از سه مقدار بعد جدید پشتیبانی می کند:-
FIREFOX
-
REALMEDIA
-
TIZEN
-
8 فوریه 2017
API API YouTube API اکنون از پارامتر اختیاری include-historical-channel-data
پشتیبانی می کند. توجه داشته باشید که این پارامتر فقط هنگام بازیابی گزارش های صاحب محتوا مرتبط است.
این پارامتر به یک صاحب محتوا اجازه می دهد تا نشان دهد که یک پاسخ API باید شامل زمان تماشای کانال ها و مشاهده داده ها از دوره زمانی قبل از اتصال کانال ها به صاحب محتوا باشد. مقدار پارامتر پیش فرض false
است ، به این معنی که ، به طور پیش فرض ، پاسخ API فقط شامل زمان ساعت و مشاهده داده ها از زمانی است که کانال ها به صاحب محتوا پیوند داده می شوند.
این قوانین همچنین در صورتی اعمال می شود که درخواست API داده ها را برای چندین کانال بازیابی کند:
- اگر مقدار پارامتر
false
باشد ، پس زمان ساعت و داده های برگشتی برای هر کانال داده شده بر اساس تاریخی است که آن کانال به صاحب محتوا پیوند داده شده است.
یادآوری این نکته حائز اهمیت است که کانال های مختلف ممکن است در تاریخ های مختلف با یک صاحب محتوا مرتبط باشد. اگر درخواست API در حال بازیابی داده ها برای چندین کانال باشد و مقدار پارامترfalse
باشد ، پاسخ API حاوی زمان ساعت و داده های مشاهده بر اساس تاریخ پیوند برای هر کانال مربوطه است. - اگر مقدار پارامتر
true
باشد ، سپس پاسخ زمان ساعت را باز می گرداند و داده ها را برای همه کانال ها بر اساس تاریخ شروع و پایان مشخص شده در درخواست API باز می گرداند.
15 دسامبر 2016
گزارش های API گزارش دهنده YouTube زیر دیگر پشتیبانی نمی شود و از مستندات حذف شده است. نسخه جدیدتر از هر گزارش در دسترس است. ( اعلام استهلاک برای این گزارش ها در 15 سپتامبر 2016 انجام شد.)
گزارش های کانال
-
channel_basic_a1
- جایگزین گزارشchannel_basic_a2
. -
channel_province_a1
- جایگزین گزارشchannel_province_a2
. -
channel_playback_location_a1
- جایگزین گزارشchannel_playback_location_a2
. -
channel_traffic_source_a1
- جایگزین گزارشchannel_traffic_source_a2
. -
channel_device_os_a1
- جایگزین گزارشchannel_device_os_a2
. -
channel_subtitles_a1
- جایگزین گزارشchannel_subtitles_a2
. -
channel_combined_a1
- جایگزین گزارشchannel_combined_a2
.
-
گزارش های صاحب محتوا
-
content_owner_basic_a2
- جایگزین گزارشcontent_owner_basic_a3
. -
content_owner_province_a1
- جایگزین گزارشcontent_owner_province_a2
. -
content_owner_playback_location_a1
- جایگزین گزارشcontent_owner_playback_location_a2
. -
content_owner_traffic_source_a1
- جایگزین گزارشcontent_owner_traffic_source_a2
. -
content_owner_device_os_a1
- جایگزین گزارشcontent_owner_device_os_a2
. -
content_owner_subtitles_a1
- با گزارشcontent_owner_subtitles_a2
جایگزین شده است. -
content_owner_combined_a1
- جایگزین گزارشcontent_owner_combined_a2
. -
content_owner_asset_basic_a1
- با گزارشcontent_owner_asset_basic_a2
جایگزین شده است. -
content_owner_asset_province_a1
- با گزارشcontent_owner_asset_province_a2
جایگزین شده است. -
content_owner_asset_playback_location_a1
- جایگزین گزارشcontent_owner_asset_playback_location_a2
. -
content_owner_asset_traffic_source_a1
- با گزارشcontent_owner_asset_traffic_source_a2
جایگزین شده است. -
content_owner_asset_device_os_a1
- جایگزین گزارشcontent_owner_asset_device_os_a2
. -
content_owner_asset_combined_a1
- با گزارشcontent_owner_asset_combined_a2
جایگزین شده است.
-
لیست انواع گزارش های فعلی در مستندات مرجع API نیز به روز شده است.
11 نوامبر 2016
این به روزرسانی شامل تغییرات زیر است:
گزارش های صفحه نمایش پایان
- گزارش صفحه نهایی برای فیلم های کانال حاوی آماری برای همه فیلم های کانال است.
- گزارش صفحه نهایی برای فیلم های صاحب محتوا حاوی آماری برای فیلم ها در هر یک از کانال های صاحب محتوا است.
- گزارش صفحه نمایش نهایی برای دارایی های صاحب محتوا شامل آماری برای دارایی های مرتبط با فیلم ها است که پس از آن صفحه نمایش های انتهایی نمایش داده می شود.
ابعاد صفحه پایان
-
end_screen_element_type
: نوع عنصر صفحه انتهایی مرتبط با آمار. -
end_screen_element_id
: شناسه ای که YouTube از آن استفاده می کند تا به طور منحصر به فرد عنصر صفحه نمایش را شناسایی کند.
-
معیارهای صفحه نمایش پایان
توجه: داده های مربوط به معیارهای صفحه نمایش از تاریخ 1 مه 2016 در دسترس است.
-
end_screen_element_impressions
: تعداد کل برداشت های عنصر صفحه نهایی. یک برداشت برای هر عنصر صفحه نمایش انتهایی که نمایش می دهد ثبت شده است. -
end_screen_element_clicks
: تعداد دفعاتی که عناصر صفحه نهایی کلیک شده است. -
end_screen_element_click_rate
: نرخ کلیک از طریق عناصر انتهایی صفحه.
-
گزارش های زیر دیگر پشتیبانی نمی شود و از مستندات حذف شده است. نسخه جدیدتر از هر گزارش در دسترس است. ( اعلام استهلاک برای این گزارش ها در 22 ژوئن 2016 انجام شد.)
-
content_owner_ad_performance_a1
- با گزارشcontent_owner_ad_rates_a1
جایگزین شده است. -
content_owner_estimated_earnings_a1
- با گزارشcontent_owner_estimated_revenue_a1
جایگزین شده است. -
content_owner_asset_estimated_earnings_a1
- جایگزین گزارشcontent_owner_asset_estimated_revenue_a1
.
-
معیارهای موجود در لیست زیر کاملاً مستهلک شده و دیگر پشتیبانی نمی شوند. همانطور که در 10 آگوست 2016 اعلام شد ، معیارهای جدید با اشاره به همان داده ها از قبل پشتیبانی می شوند. جدول زیر نام متریک مستهلک شده و نام متریک جدید را نشان می دهد:
متریک کاهش یافته متریک جدید adEarnings
estimatedAdRevenue
impressionBasedCpm
cpm
impressions
adImpressions
redPartnerRevenue
estimatedRedPartnerRevenue
- درآمد آگهی ماهانه ، در سراسر جهان در هر ویدئو
- درآمد تبلیغ روزانه ، هر کشور در هر ویدئو
- درآمد آگهی ماهانه ، در سراسر جهان برای هر دارایی
- روزانه ، درآمد تبلیغات هر کشور برای هر دارایی
- مطالبات (این گزارش حاوی داده های درآمد نیست)
API از دو معیار جدید مربوط به YouTube Red Viewership پشتیبانی می کند:
-
red_views
: تعداد دفعاتی که یک فیلم توسط اعضای YouTube Red مشاهده می شود. -
red_watch_time_minutes
: تعداد دقایقی که اعضای YouTube Red یک فیلم را تماشا می کردند.
-
API از نسخه های جدید 20 گزارش پشتیبانی می کند. همه نسخه های جدید از معیارهای جدید
red_views
وred_watch_time_minutes
پشتیبانی می کنند.برای هر گزارش ، تعداد شناسه نوع گزارش جدید یک شماره بالاتر از شناسه نوع گزارش قدیمی است. (نسخه های قدیمی این گزارش ها اکنون همانطور که بعداً در این تاریخچه تجدید نظر توضیح داده شده است ، مستهلک می شوند.) به عنوان مثال ، گزارش
channel_basic_ a1
اکنون کاهش یافته و توسط گزارشchannel_basic_ a2
جایگزین شده است.لیست های زیر شناسه های نوع گزارش جدید را شناسایی می کنند:
گزارش های ویدئویی کانال
گزارش های ویدیویی صاحب محتوا
دارایی صاحب محتوا گزارش می دهد
توجه: این یک اعلامیه استهلاک است.
توجه داشته باشید که اگر قبلاً شغلی برای ایجاد هر یک از نسخه های قدیمی گزارش های ذکر شده در بالا دارید ، باید برای گزارش های تغییر نام ، مشاغل جدیدی ایجاد کنید. در رابطه با انتشار نسخه های گزارش جدید ، نسخه های گزارش زیر کاهش یافته است:
-
channel_basic_a1
-
channel_province_a1
-
channel_playback_location_a1
-
channel_traffic_source_a1
-
channel_device_os_a1
-
channel_subtitles_a1
-
channel_combined_a1
-
content_owner_basic_a2
-
content_owner_province_a1
-
content_owner_playback_location_a1
-
content_owner_traffic_source_a1
-
content_owner_device_os_a1
-
content_owner_subtitles_a1
-
content_owner_combined_a1
-
content_owner_asset_basic_a1
-
content_owner_asset_province_a1
-
content_owner_asset_playback_location_a1
-
content_owner_asset_traffic_source_a1
-
content_owner_asset_device_os_a1
-
content_owner_asset_combined_a1
اگر برای هر یک از این گزارش ها شغل دارید ، نباید انتظار داشته باشید که یوتیوب پس از 15 دسامبر 2016 گزارش های جدیدی را برای این مشاغل تهیه کند. گزارش های تولید شده از زمان تولید آنها هنوز 180 روز در دسترس خواهد بود.
-
گزارش
content_owner_basic_a1
به طور کامل از بین رفته و از مستندات حذف شده است. YouTube دیگر گزارش های جدیدی از آن نوع تولید نمی کند ، اگرچه گزارش هایی که قبلاً تولید شده بودند ، از زمان تولید آنها هنوز 180 روز در دسترس خواهد بود.جایگزینی گزارش
content_owner_basic_a1
گزارشcontent_owner_basic_a2
است که در تاریخ تجدید نظر در تاریخ 19 مه 2016 توضیح داده شده است.خدمات خدمات تازه منتشر شده API YouTube API ("اصطلاحات به روز شده") ، که به تفصیل در وبلاگ مهندسی و توسعه دهندگان YouTube مورد بحث قرار گرفته است ، مجموعه ای غنی از به روزرسانی ها را به شرایط فعلی خدمات ارائه می دهد. علاوه بر اصطلاحات به روز شده ، که از تاریخ 10 فوریه 2017 به مرحله اجرا در خواهد آمد ، این بروزرسانی شامل چندین سند پشتیبانی برای کمک به توضیح سیاست هایی است که توسعه دهندگان باید دنبال کنند.
مجموعه کامل اسناد جدید در تاریخ تجدید نظر برای اصطلاحات به روز شده شرح داده شده است. علاوه بر این ، تغییرات آینده در اصطلاحات به روز شده یا در مورد اسناد حامی نیز در آن تاریخ تجدید نظر توضیح داده می شود. شما می توانید از پیوندی در آن سند در یک لیست لیست فید RSS مشترک شوید.
YouTube Analytics API (نمایش داده شدگان هدفمند)
توجه: این یک اعلامیه استهلاک است.
معیارهای موجود در جدول زیر مستهلک می شوند. در عین حال ، معیارهای جدید با اشاره به همان داده ها معرفی می شوند. در واقع ، این بدان معنی است که معیارهای قدیمی تغییر نام می یابند ، اگرچه API API YouTube API از هر دو نام متریک پشتیبانی می کند تا تاریخ استهلاک ذکر شده در جدول.
نام متریک قدیمی نام متریک جدید تاریخ حمایت earnings
estimatedRevenue
10 آگوست 2017 adEarnings
estimatedAdRevenue
4 نوامبر 2016 redPartnerRevenue
estimatedRedPartnerRevenue
4 نوامبر 2016 impressionBasedCpm
cpm
4 نوامبر 2016 impressions
adImpressions
4 نوامبر 2016 توجه داشته باشید که متریک
earnings
یک معیار اصلی بود ، بنابراین از تاریخ این اعلامیه به مدت یک سال پشتیبانی می شود. معیارهای دیگر ، که معیارهای اصلی نبودند ، تا 4 نوامبر 2016 به مدت سه ماه پشتیبانی می شوند.به عنوان مثال ، تا 4 نوامبر 2016 ، یک درخواست API می تواند متریک
impressionBasedCpm
، متریکcpm
یا هر دو را مشخص کند. با این حال ، پس از آن تاریخ ، فقط از متریکcpm
پشتیبانی می شود.- ابعاد
insightTrafficSourceType
از دو مقدار بعد جدید پشتیبانی می کند:-
CAMPAIGN_CARD
: این منبع ترافیک فقط برای گزارش های صاحب محتوا پشتیبانی می شود. این نشان می دهد که دیدگاه ها از فیلم های ادعا شده و کاربر بارگیری شده که صاحب محتوا برای تبلیغ محتوای مشاهده شده استفاده می شود ، سرچشمه گرفته است. -
END_SCREEN
: داده ها مربوط به نمایی است که از صفحه پایان فیلم دیگر سرچشمه گرفته است.
برای هر دو منبع جدید ترافیک ، می توانید گزارش
traffic source detail
را نیز بازیابی کنید. در هر دو مورد ، ابعادinsightTrafficSourceDetail
ویدئویی را که از آن بیننده ارجاع شده است ، مشخص می کند. -
بعد
adType
اکنون از ارزشauctionBumperInstream
پشتیبانی می کند ، که به یک آگهی ویدیویی غیر قابل استفاده تا 6 ثانیه که قبل از مشاهده یک فیلم پخش می شود ، اشاره دارد.
گزارش YouTube API (گزارش های فله)
- بعد
traffic_source_type
اکنون از مقادیر زیر پشتیبانی می کند:-
19
: این منبع ترافیک فقط برای گزارش های صاحب محتوا پشتیبانی می شود. این نشان می دهد که دیدگاه ها از فیلم های ادعا شده و کاربر بارگیری شده که صاحب محتوا برای تبلیغ محتوای مشاهده شده استفاده می شود ، سرچشمه گرفته است. -
20
: داده ها مربوط به نمایی است که از صفحه پایان فیلم دیگر سرچشمه گرفته است.
برای هر دو منبع ترافیک جدید ، ابعاد
traffic_source_detail
ویدئویی را که از آن بیننده ارجاع شده است ، مشخص می کند. -
لیست معیارهای اصلی API اصلاح شده است تا لیست
estimated_partner_revenue
به عنوان یک متریک اصلی و حذفearnings
از آن لیست ذکر کند. (متریکearnings
هرگز در API گزارش YouTube پشتیبانی نشده است.)بعد
ad_type
اکنون از مقدار19
که به تبلیغات سپر اشاره دارد ، پشتیبانی می کند ، که تبلیغات ویدیویی غیر قابل استفاده تا 6 ثانیه است که قبل از مشاهده یک فیلم پخش می شود.
- بعد
YouTube Analytics API (نمایش داده شدگان هدفمند)
- لیست معیارهای پشتیبانی شده برای گزارش های کانال زیر به روز شده است که شامل معیارهای کارت است. پشتیبانی از معیارهای کارت در این گزارش ها در واقع در تاریخ 28 ژوئن 2016 اضافه شده است ، و ورود تاریخچه تجدید نظر برای آن تاریخ ، تغییر در جزئیات بیشتر را توضیح می دهد. گزارش ها عبارتند از:
- فعالیت اصلی کاربر برای ایالات متحده
- فعالیت کاربر در ایالات متحده برای دوره های زمانی خاص
- فعالیت کاربر توسط استان
- فعالیت کاربر توسط وضعیت مشترک
- فعالیت کاربر توسط وضعیت مشترک برای استانها
- فیلم های برتر توسط ایالت
- فیلم های برتر برای بینندگان مشترک یا نامشخص
لیست فیلترها برای هر دو گزارش حفظ مخاطبان کانال و گزارش های حفظ مخاطبان صاحب محتوا اصلاح شده است تا نشان دهد که فیلتر
video
مورد نیاز است و فیلترgroup
پشتیبانی نمی شود.پیش از این ، مستندات برای هر دو گزارش به طور نادرست اظهار داشت که این گزارش می تواند با استفاده از یکی از این دو فیلتر یا استفاده از هیچ فیلتر بازیابی شود.
- لیست معیارهای پشتیبانی شده برای گزارش های کانال زیر به روز شده است که شامل معیارهای کارت است. پشتیبانی از معیارهای کارت در این گزارش ها در واقع در تاریخ 28 ژوئن 2016 اضافه شده است ، و ورود تاریخچه تجدید نظر برای آن تاریخ ، تغییر در جزئیات بیشتر را توضیح می دهد. گزارش ها عبارتند از:
گزارش YouTube API (گزارش های فله)
- در نمای کلی API ، بخشی که نحوه بازیابی URL بارگیری یک گزارش را توضیح می دهد ، تصریح شده است که YouTube گزارش های قابل بارگیری را برای روزهایی تولید می کند که هیچ داده ای در دسترس نبوده است. این گزارش ها حاوی یک ردیف هدر هستند اما حاوی داده های اضافی نیستند. این اطلاعات قبلاً در بخش مشخصات گزارش همان سند در تاریخ 12 آوریل 2016 به روز شده بود.
- لیست ابعاد موجود در گزارش
content_owner_asset_cards_a1
اصلاح شده است تا منعکس شود که این گزارش از بعدcard_id
استفاده می کند. پیش از این ، مستندات نادرست نام ابعاد را به عنوانcard_title
ذکر کرده بود.
- آمار اساسی ( کانال ها ، صاحبان محتوا )
- مبتنی بر زمان ( کانال ها ، صاحبان محتوا )
- جغرافیای کاربر ( کانال ها ، صاحبان محتوا )
- فعالیت کاربر توسط وضعیت مشترک ( کانال ها ، صاحبان محتوا )
- فیلم های برتر ( کانال ها ، صاحبان محتوا )
بخش مشخصات گزارش از نمای کلی API به روز شده است تا روشن شود که گزارش ها از طریق API به مدت 180 روز از زمان تولید آنها در دسترس هستند.
پیش از این ، مستندات اظهار داشتند كه گزارش ها برای مدت حداکثر 180 روز قبل از تاریخ ارسال درخواست API در دسترس است. در حالی که از نظر فنی نیز صادق است ، متن اصلی در بهترین حالت بسیار گیج کننده بود.
API از نسخه های جدید سه گزارش پشتیبانی می کند. دو مورد از این گزارش ها همچنین حاوی معیارهای جدید و تغییر نام هستند:
گزارش
content_owner_ad_rates_a1
نسخه جدید گزارشcontent_owner_ad_performance_a1
است. گزارش تازه تغییر نام با نسخه قبلی یکسان است.دو گزارش که نسخه های جدیدی دارند تغییر نام داده اند:
- نسخه جدید گزارش
content_owner_estimated_earnings_a1
با نامcontent_owner_estimated_revenue_a1
نامگذاری شده است. - نسخه جدید گزارش
content_owner_asset_estimated_earnings_a1
با نامcontent_owner_asset_estimated_revenue_a1
نامگذاری شده است.
هر دو گزارش تازه تغییر نام با روشهای زیر با پیشینیان خود متفاوت است:
- آنها متریک جدید
estimated_partner_red_revenue
را اضافه می کنند ، که کل درآمد حاصل از اشتراک های قرمز YouTube را تخمین می زند. - آنها متریک جدید
estimated_partner_transaction_revenue
را اضافه می کنند ، که درآمد حاصل از معاملات ، مانند محتوای پرداخت شده و بودجه فن را تخمین می زند ، منهای بازپرداخت دارای شارژ شریک. - آنها متریک
estimated_partner_ad_sense_revenue
را بهestimated_partner_ad_auction_revenue
تغییر نام می دهند. - آنها معیار
estimated_partner_double_click_revenue
را بهestimated_partner_ad_reserved_revenue
تغییر نام می دهند.
- نسخه جدید گزارش
توجه داشته باشید که اگر در حال حاضر شغلی برای ایجاد هر یک از نسخه های قدیمی تر این گزارش ها دارید ، باید برای گزارش های تغییر نام ، مشاغل جدیدی ایجاد کنید. در رابطه با انتشار نسخه های گزارش جدید ،
content_owner_ad_performance_a1
،content_owner_estimated_earnings_a1
، وcontent_owner_asset_estimated_earnings_a1
گزارش شده است.اگر برای هر یک از این گزارش ها شغل دارید ، نباید انتظار داشته باشید که یوتیوب پس از 22 سپتامبر 2016 گزارش های جدیدی را برای این مشاغل تهیه کند. گزارش های تولید شده از زمان تولید آنها هنوز 180 روز در دسترس خواهد بود.
تعریف خاصیت
id
reportType
Resource به روز شده است تا مجموعه فعلی گزارش های موجود را منعکس کند.نام دو معیار در مستندات اصلاح شده است تا با نام هایی که در گزارش ها ظاهر می شود مطابقت داشته باشد. این صرفاً یک اصلاح اسناد است و نشان دهنده تغییر در محتوای گزارش واقعی نیست:
- نام متریک
estimated_partner_adsense_revenue
درestimated_partner_ad_sense_revenue
به روز شده است. با این حال ، توجه داشته باشید که این متریک فقط در دو گزارش ظاهر می شود که با این بروزرسانی کاهش می یابد. همانطور که در بالا توضیح داده شد ، این متریک در نسخه های جدیدتر از این گزارش هاestimated_partner_ad_auction_revenue
تغییر نام داده است. - نام
estimated_partner_doubleclick_revenue
Metric به روز شده درestimated_partner_double_click_revenue
به روز شده است. باز هم ، توجه داشته باشید که این متریک فقط در دو گزارش ظاهر می شود که با این بروزرسانی کاهش می یابد. همانطور که در بالا توضیح داده شد ، این متریک در نسخه های جدیدتر از این گزارش هاestimated_partner_ad_reserved_revenue
تغییر نام داده است.
- نام متریک
مستندات ابعاد API گزارش دهی به روز شده است تا دیگر ویژگی های
elapsed_video_time_percentage
وaudience_retention_type
را لیست نکنید. این ابعاد در حال حاضر توسط هیچ گزارش موجود از طریق API پشتیبانی نمی شود.API از نسخه جدیدی از گزارش فعالیت کاربر برای صاحبان محتوا پشتیبانی می کند. شناسه نوع گزارش برای گزارش جدید
content_owner_basic_a2
است. بر خلاف نسخه قبلی گزارش ،content_owner_basic_a1
، نسخه جدید از معیارهایlikes
پشتیبانی می کند وdislikes
.اگر قبلاً شغلی برای ایجاد گزارش
content_owner_basic_a1
دارید ، هنوز هم باید یک کار جدید برای گزارشcontent_owner_basic_a2
ایجاد کنید. YouTube به طور خودکار صاحبان محتوا را به نسخه گزارش جدید منتقل نمی کند یا به طور خودکار ایجاد کار برای تولید نسخه گزارش جدید است. در برخی از پیاده سازی ها ، ظاهر یک کار جدید و غیر منتظره می تواند یک تغییر شکستگی باشد.در رابطه با انتشار گزارش جدید ، گزارش
content_owner_basic_a1
کاهش یافته است. اگر برای آن گزارش شغلی دارید ، نباید انتظار داشته باشید که یوتیوب پس از 19 آگوست 2016 گزارش های جدیدی را برای آن شغل تهیه کند. گزارش های تولید شده از زمان تولید آنها هنوز برای 180 روز در دسترس خواهد بود.منابع
reportType
،job
وreport
همه از یک ویژگی جدید پشتیبانی می کنند که مشخص می کند منبع مرتبط نشان دهنده یک نوع گزارش مستهلک است:ویژگی
deprecateTime
reportType
Resource ، تاریخ و زمانی را که نوع گزارش کاهش می یابد مشخص می کند. این ملک فقط برای گزارش هایی که به عنوان مستهلک اعلام شده اند ، ارزش دارد و مقدار آن را نشان می دهد که YouTube از تولید گزارش های آن نوع متوقف می شود.پس از اعلام نوع گزارش به عنوان مستهلک ، YouTube گزارش هایی از آن نوع را برای سه ماه دیگر تولید می کند. به عنوان مثال ، این به روزرسانی در 19 مه 2016 ، استهلاک گزارش
content_owner_basic_a1
را اعلام می کند. بنابراین ،deprecateTime
برای آن نوع گزارش ، زمانی را در 19 آگوست 2016 مشخص می کند ، پس از آن YouTube از تولید گزارش های آن نوع متوقف می شود.املاک
expireTime
منابعjob
تاریخ و زمان منقضی شدن شغل را مشخص می کند یا منقضی می شود. اگر نوع گزارش مرتبط با کار کاهش یافته باشد یا اگر گزارش های تولید شده برای کار برای مدت طولانی بارگیری نشده است ، این ویژگی دارای ارزش است. تاریخ زمانی است که YouTube دیگر گزارش های جدیدی را برای این کار تولید نمی کند.این
report
از منابعjobExpireTime
منبع ، تاریخ و زمانی را که شغلی که با گزارش در ارتباط است یا منقضی شده یا منقضی می شود ، مشخص می کند. این ویژگی حاوی همان مقدار خاصیتexpireTime
در منبعjob
است ، همانطور که در مورد قبلی در این لیست توضیح داده شده است.
در صورتی که سعی می کنید شغلی را برای یک گزارش مستهجن ایجاد کنید ، روش
jobs.create
اکنون یک کد پاسخ400
HTTP (Bad Request
) را برمی گرداند. علاوه بر این ، مستندات این روش اکنون چندین دلیل دیگر را نشان می دهد که باعث عدم موفقیت درخواست API می شود.YouTube اکنون داده های مربوط به دوره 180 روزه را قبل از زمان برنامه ریزی کار گزارش دهی تولید می کند. پیش از این ، API گزارشگری هیچ اطلاعات تاریخی ارائه نمی داد. این تغییر بر همه مشاغل ، از جمله موارد ایجاد شده قبل از این اعلامیه تأثیر می گذارد.
گزارش های تاریخی به محض در دسترس بودن ارسال می شود ، اگرچه تقریباً یک ماه طول می کشد تا همه داده های تاریخی برای یک کار ارسال شوند. بنابراین ، یک ماه پس از برنامه ریزی کار گزارشگری ، حدود هفت ماه از داده ها دسترسی خواهید داشت. (تمام داده های تاریخی برای مشاغل ایجاد شده قبل از این اعلامیه باید طی یک ماه از اعلامیه ارسال شود.)
توجه داشته باشید که داده های تاریخی فقط از اول ژوئیه 2015 در دسترس است. در نتیجه ، مشاغل ایجاد شده قبل از 28 دسامبر 2015 ، کمتر از 180 روز داده های تاریخی خواهد داشت.
این تغییرات همه در بخش جدید داده های تاریخی گزارش کلی API گزارشگر توضیح داده شده است.
بخش مشخصات گزارش از نمای کلی API گزارش YouTube با تغییرات زیر به روز شده است:
در این مستندات اکنون آمده است که گزارش ها برای مدت 180 روز پس از تولید در دسترس است و بنابراین ، برای بارگیری مشتریان API در دسترس است. پیش از این ، مستندات اظهار داشت که گزارش ها برای مدت حداکثر شش ماه قبل از تاریخ ارسال درخواست API در دسترس بوده است.
این مستندات به روز شده است تا این واقعیت را منعکس کند که API اکنون گزارش های قابل بارگیری را برای روزهایی تولید می کند که هیچ داده ای در دسترس نبوده است. این گزارش ها حاوی ردیف هدر هستند اما حاوی داده های اضافی نیستند.
API Reporting YouTube به زودی مجموعه ای از گزارش های تولید شده توسط سیستم را که حاوی داده های درآمد آگهی یا داده های درآمد اشتراک YouTube Red است ، پشتیبانی می کند. این گزارش ها در دسترس صاحبان محتوا قرار خواهد گرفت که می توانند از قبل به گزارش های قابل بارگیری دستی در استودیوی خالق YouTube دسترسی پیدا کنند. بنابراین ، عملکرد جدید API دسترسی برنامه ای به آن داده ها را فراهم می کند.
تغییرات API زیر اکنون در آماده سازی برای راه اندازی گزارش های مدیریت شده توسط سیستم اعلام شده است:
خاصیت جدید
systemManaged
منبعjob
نشان می دهد که آیا این منبع شغلی را توصیف می کند که گزارش های مدیریت سیستم را تولید می کند یا خیر. YouTube به طور خودکار گزارش های مدیریت سیستم را برای صاحبان محتوای YouTube تولید می کند ، و صاحبان محتوا نمی توانند شغل هایی را که این گزارش ها را ایجاد می کنند اصلاح یا حذف کنند.پارامتر جدید
includeSystemManaged
روشjobs.list
لیست نشان می دهد که آیا پاسخ API باید شامل شغل هایی برای گزارش های مدیریت شده توسط سیستم باشد. مقدار پیش فرض پارامترfalse
است.پارامتر جدید
startTimeAtOrAfter
روشjobs.reports.list
نشان می دهد که پاسخ API فقط باید حاوی گزارش هایی باشد که اولین داده های موجود در گزارش در تاریخ یا بعد از تاریخ مشخص شده باشد. به طور مشابه ، پارامترstartTimeBefore
نشان می دهد که پاسخ API فقط باید حاوی گزارش هایی باشد که اولین داده های موجود در گزارش قبل از تاریخ مشخص شده باشد.بر خلاف پارامتر
createdAfter
روش ، که مربوط به زمانی است که گزارش ایجاد شده است ، پارامترهای جدید مربوط به داده های موجود در گزارش است.خاصیت جدید
systemManaged
reportType
Resource نشان می دهد که آیا این منبع گزارش مدیریت سیستم را توصیف می کند یا خیر.Parameter
includeSystemManaged
روش جدیدreportTypes.list
، نشان می دهد که آیا پاسخ API باید شامل گزارش های مدیریت شده باشد. مقدار پیش فرض پارامترfalse
است.
- در API گزارش YouTube ، ابعاد
sharing_service
از این مقادیر جدید پشتیبانی می کند:-
82
: گفتگوی فعالیت سیستم iOS -
83
: صندوق ورودی Google -
84
: پیام رسان اندروید
-
- در API API ANALYTICS YouTube ، Dimension
sharingService
از این مقادیر جدید پشتیبانی می کند:-
ANDROID_MESSENGER
: Android Messenger -
INBOX
: صندوق ورودی Google -
IOS_SYSTEM_ACTIVITY_DIALOG
: گفتگوی فعالیت سیستم iOS
-
- Dimension
playback_location_type
از دو مقدار ابعاد جدید پشتیبانی می کند:-
7
: داده ها مربوط به نمایی است که در صفحه اصلی YouTube یا صفحه اصلی ، در فید اشتراک کاربر یا در یک ویژگی مرور YouTube دیگر اتفاق می افتد. -
8
: داده ها مربوط به نمایی است که مستقیماً در صفحه نتایج جستجوی YouTube اتفاق می افتد.
-
- بعد
traffic_source_type
اکنون از18
به عنوان یک مقدار ابعاد پشتیبانی می کند. این مقدار نشان می دهد که نمایش های ویدئویی از صفحه ای که تمام فیلم ها را در یک لیست پخش لیست می کند ، سرچشمه گرفته است. این منبع با نوع منبع14
متفاوت است ، که نشان می دهد در هنگام پخش این فیلم به عنوان بخشی از لیست پخش ، این دیدگاه ها رخ داده است. - ابعاد
insightPlaybackLocationType
از دو مقدار بعد جدید پشتیبانی می کند:-
BROWSE
: داده ها مربوط به نمایی است که در صفحه اصلی YouTube یا صفحه اصلی ، در فید اشتراک کاربر یا در یکی دیگر از ویژگی های مرور YouTube انجام شده است. -
SEARCH
: داده ها مربوط به نمایی است که مستقیماً در صفحه نتایج جستجوی YouTube اتفاق می افتد.
-
- The
insightTrafficSourceType
dimension now supportsYT_PLAYLIST_PAGE
as a dimension value. This value indicates that the video views originated from a page that lists all of the videos in a playlist. This source differs from thePLAYLIST
source type, which indicates that the views occurred while the video was being played as part of a playlist. - In the YouTube Reporting API, the
operating_system
dimension uses the value21
to identify views that take place via Chromecast. - In the YouTube Analytics API, the
operatingSystem
dimension uses the valueCHROMECAST
to identify views that take place via Chromecast. The YouTube Analytics API now supports three new playback detail dimensions , which can be used in a variety of channel and content owner reports:
-
liveOrOnDemand
: This dimension indicates whether the data in the report describes user activity that occurred during a live broadcast. -
subscribedStatus
: This dimension indicates whether the user activity metrics in the data are associated with viewers who were subscribed to the video's or playlist's channel. -
youtubeProduct
: This dimension identifies the YouTube property on which the user activity occurred. Possible values include the core YouTube website (or YouTube app), YouTube Gaming, and YouTube Kids.
The documentation has been updated to identify new playback detail reports that are available for channels and content owners . In addition, many other reports have been updated to note that one or more of these dimensions can optionally be used as dimensions and/or filters in those reports.
-
The format of the tables that explain the reports has changed to make it easier for you to identify valid combinations of dimensions, metrics, and filters that can be used to retrieve each report. The table below, which explains the "Device Type" report for channels, shows the new format:
مطالب ابعاد: مورد نیاز deviceType Use 0 or more day , liveOrOnDemand , subscribedStatus , youtubeProduct Metrics: Use 1 or more views , estimatedMinutesWatched فیلترها: Use 0 or 1 country , province , continent , subContinent Use 0 or 1 video , group Use 0 or more operatingSystem , liveOrOnDemand , subscribedStatus , youtubeProduct The terminology describing required and optional fields is explained in the documentation for channel and content owner reports.
The YouTube Analytics API now automatically drops entities that the API user cannot retrieve data for from filters that support multiple values (
video
,playlist
, andchannel
). Previously, the API server would have just returned an error if the API user could not access data for at least one of the specified items.For example, suppose a user submits an API request in which the
video
filter lists 20 video IDs. The user owns 18 of the videos. However, one videos ID identifies a video owned by another channel, and another ID identifies a video that was deleted and, therefore, no longer exists. In this case, instead of returning an error, the API server now drops the two videos that the user cannot access, and the API response contains data for the 18 videos that the API user owns.If you request data for an empty YouTube Analytics
group
, the API now returns an empty data set rather than an error.The YouTube Analytics API's
groupItems.insert
method now returns an unauthorized (403
HTTP response code) error if you try to add an entity to a group but you do not have access to that entity. Previously, the API would have allowed you to add the entity to the group, but later returned an unauthorized error when you tried to retrieve report data for that group.The YouTube Analytics API's
groups.list
method now supports pagination. If the API response does not contain all available groups, then the response'snextPageToken
parameter specifies a token that can be used to retrieve the next page of results. Set the method'spageToken
parameter to that value to retrieve additional results.The YouTube Analytics API now supports the
redPartnerRevenue
metric, which reports the total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The metric's value reflects earnings from both music and non-music content and is subject to month-end adjustment.The YouTube Analytics API's list of content owner reports has been updated to identify the video reports that support the
redPartnerRevenue
metric:- Basic stats
- مبتنی بر زمان
- User geography
- Top videos – For this report,
redPartnerRevenue
is also supported as a sorting metric, which means you can retrieve a list of videos sorted by their YouTube Red earnings.
The top videos report definition for the YouTube Analytics API now reflects that this report also supports the following earnings metrics:
earnings
,adEarnings
,grossRevenue
,monetizedPlaybacks
,playbackBasedCpm
,impressions
, andimpressionBasedCpm
.The documentation for the YouTube Reporting API's
date
dimension has been corrected to reflect that dates reference the 24-hour period beginning at 12:00 am Pacific time (UTC-8). Previously, the documentation stated that the date began at 12:00 am (GMT).In addition, the YouTube Analytics API documentation has been updated to note that all date-related dimensions (
day
,7DayTotals
,30DayTotals
, andmonth
) refer to dates beginning at 12:00 am Pacific time (UTC-8).The YouTube Reporting API's
jobs.reports.list()
method now supports thecreatedAfter
query parameter. If specified, this parameter indicates that the API response should only list reports created after the specified date and time, including new reports with backfilled data. Note that the parameter value pertains to the time that the report is created and not the dates associated with the returned data.The parameter value is a timestamp in RFC3339 UTC "Zulu" format, accurate to microseconds. Example:
"2015-10-02T15:01:23.045678Z"
.The YouTube Reporting API best practices have also been updated to explain how you can use the
createdAfter
parameter to avoid repeatedly processing the same report.The definitions of the
job
resource'screateTime
property and thereport
resource'sstartTime
,endTime
, andcreateTime
properties have all been corrected to note that the property values are accurate to microseconds, not nanoseconds. In addition, all of the definitions now accurately reflect that the property value is a timestamp.The documentation for the YouTube Analytics API's
sharingService
dimension has been updated to include a list of possible dimension values. The list includes a number of newly supported services.The YouTube Reporting API's
sharing_service
dimension's definition has also been updated to list the newly supported values. The enum values that are greater than59
are the new ones in the list.The new YouTube Reporting API retrieves bulk data reports that contain YouTube Analytics data for a channel or content owner. It is designed for applications that can import large data sets and that provide tools to filter, sort, and mine that data.
Each YouTube Reporting API report contains a predefined set of dimensions and metrics. (YouTube Analytics API reports also use metrics and dimensions.) In a report, each row of data has a unique combination of dimension values. You can aggregate data across rows based on dimension values to calculate metrics for individual videos, countries, live videos, subcribed users, and so forth.
You can use the API to schedule reporting jobs, each of which identifies a report that YouTube should generate. Once you have set up a job, YouTube generates a daily report that can be asynchronously downloaded. Each report contains data for a unique, 24-hour period.
Although they are different APIs, the YouTube Analytics API and the YouTube Reporting API both enable developers to retrieve YouTube Analytics data. Since the APIs both provide access to similar data sets, the documentation for the two APIs is being published as a single set of documentation.
- The Guides tab in the documentation set contains information common to both APIs, including instructions for authorizing API requests.
- The Bulk reports tab contains reference documentation and other content specifically for the YouTube Reporting API.
- The Targeted queries tab contains reference documentation and other content specifically for the YouTube Analytics API.
- The Samples tab lists code samples available for either of the two APIs.
- The Tools tab lists additional resources available to help developers implement either of the two APIs.
The API documentation has been restructured in an effor to make the API easier to understand. As such, these changes do not describe new features:
The documentation now contains one page that lists all available channel reports and another that lists all available content owner reports . Previously, the documentation had separate pages for channel video reports, channel playlist reports, and so forth.
The new data model overview seeks to provide a clearer introduction to how the API works. Specifically, this document tries to better explain how YouTube uses metrics, dimensions, and filters to calculate report values.
The API's
reports.query
method, which you use to retrieve reports, is now documented separately. The information on that page had previously been on some other pages. The new page is designed to help you more easily identify the information you need to send to retrieve a report.
The new
adEarnings
metric includes total estimated earnings (net revenue) from all Google-sold advertising sources. It is not a core metric. The API supports theadEarnings
metric for any report that already supported theearnings
metric.In addition, the definition of the
earnings
metric has been corrected to reflect the fact that its value includes total estimated earnings from all Google-sold advertising sources as well as from non-advertising sources. Previously, the definition incorrectly indicated that the metric only included earnings from advertising sources.The
primaryAdGrossRevenue
metric has been deprecated. Instead, use thegrossRevenue
metric to retrieve revenue data.In addition to the deprecated
primaryAdGrossRevenue
metric, ad performance reports no longer support themonetizedPlaybacks
andplaybackBasedCpm
metrics. However, several video reports do still support those metrics.The API now supports two new metrics for video reports,
videosAddedToPlaylists
andvideosRemovedFromPlaylists
. The lists of video reports for channels and content owners have both been updated to identify the reports that support the new metrics.-
videosAddedToPlaylists
– The number of times that videos in the scope of the query were added to any YouTube playlists. The videos could have been added to the video owner's playlist or to other channels' playlists. -
videosRemovedFromPlaylists
– The number of times that videos in the scope of the query were removed from any YouTube playlists. The videos could have been removed from the video owner's playlist or from other channels' playlists.
Both metrics include default playlists like the "Watch Later" playlist. However, they do not count playlists that a video is automatically added to, such as a channel's uploads playlist or a user's watch history. Also note that these metrics reflect the absolute number of additions and deletions. So, if a user adds a video to a playlist, then removes it, and then adds it again, the metrics indicate that the video was added to two playlists and removed from one.
Data for these metrics is available as of October 1, 2014.
-
The
favoritesAdded
andfavoritesRemoved
metrics are both deprecated effective as of this announcement. These are both core metrics and subject to the Deprecation Policy set forth in the terms of service .The new
currency
parameter allows you to retrieve earnings metrics in a currency other than United States dollars (USD
). If the parameter is set, then the API converts values for theearnings
,grossRevenue
,playbackBasedCpm
, andimpressionBasedCpm
metrics to the specified currency. The values returned are estimates calculated using exchange rates that change on a daily basis.The parameter value is a three-letter, ISO 4217 currency code. The default value is
USD
. The parameter definition contains a list of supported currency codes.The API now supports the ability to create and manage YouTube Analytics groups as well as the ability to retrieve report data for those groups.
ایجاد و مدیریت گروه ها
This update introduces the
group
andgroupItem
resources for creating and managing groups.- The
group
resource represents an Analytics group, a custom collection of up to 200 channels, videos, playlists, or assets. The API supportslist
,insert
,update
, anddelete
methods for this resource. - The
groupItem
resource represents an item in an Analytics group. The API supportslist
,insert
, anddelete
methods for this resource.
So, for example, you could create a group using the
groups.insert
method and then add items to that group using thegroupItems.insert
method.- The
Retrieving report data for a group
The dimensions documentation has been updated to include the
group
dimension, which can be used as a filter for many channel reports and content owner reports . When you use thegroup
filter, the API returns data for all of the items in that group. Note that the API does not currently support the ability to create reports for asset groups.
See the YouTube Help Center for more information about YouTube Analytics groups.
The API no longer supports the
show
dimension.The API now supports the ability to specify multiple values for the
video
,playlist
,channel
, andshow
dimensions when those dimensions are used as filters . To specify multiple values, set thefilters
parameter value to a comma-separated list of the video, playlist, channel, or show IDs for which the API response should be filtered. The parameter value can specify up to 200 IDs.If you specify multiple values for the same filter, you can also add that filter to the list of dimensions that you specify for the request. This is true even if the filter is not listed as a supported dimension for a particular report. If you do add the filter to the list of dimensions, then the API also uses the filter values to group results.
See the
filters
parameter definition for complete details about this functionality.When retrieving a channel report, you can now retrieve data for the authenticated user's channel by setting the value of the
ids
parameter tochannel==MINE
. (You can also still set theids
parameter tochannel== CHANNEL_ID
to retrieve data for the specified channel.)The API now supports playlist reports, which contain statistics related to video views that occur in the context of a playlist. Playlist reports are available for channels and content owners .
All playlist reports support the
views
andestimatedMinutesWatched
metrics, and some also support theaverageViewDuration
metric.In addition, all playlist reports support the following new metrics. Note that each of these metrics only reflect playlist views that occurred on the web.
-
playlistStarts
: The number of times viewers initiated playback of a playlist. -
viewsPerPlaylistStart
: The average number of video views that occurred each time a playlist was initiated. -
averageTimeInPlaylist
: The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated.
Any request to retrieve a playlist report must use the
isCurated
filter, which must be set to1
(isCurated==1
).-
The API now supports an audience retention report. This report measures a video's ability to retain its audience. The report's new
elapsedVideoTimeRatio
dimension measures the amount of the video that has elapsed for the corresponding metric values:The
audienceWatchRatio
metric identifies the absolute ratio of viewers watching the video at the given point in the video. The ratio is calculated by comparing the number of times a portion of a video has been watched to the total number of views of the video.Note that a portion of a video could be watched more than once (or not at all) in a given video view. For example, if users rewind and watch the same portion of a video multiple times, then the absolute ratio for that portion of the video the could be greater than
1
.The
relativeRetentionPerformance
metric shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length. A value of 0 indicates that the video retains viewers worse than any other video of similar length, while a value of 1 indicates that the video retains viewers better than any other video of similar length. A median value of 0.5 indicates that half of the videos of similar length retain viewers better while half retain viewers worse.
You can also use the
audienceType
filter so that the report only returns data associated with organic views, views from TrueView in-stream ads, or views from TrueView in-display ads. (Organic views are the direct result of user action, such as a search for a video or a click on a suggested video.)The API supports several new metrics related to annotations. The metrics listed below can be retrieved with any reports that previously supported the
annotationClickThroughRate
andannotationCloseRate
metrics.-
annotationImpressions
: The total number of annotation impressions. -
annotationClickableImpressions
: The number of annotations that appeared and could be clicked. -
annotationClosableImpressions
: The number of annotations that appeared and could be closed. -
annotationClicks
: The total number of clicked annotations. -
annotationCloses
: The total number of closed annotations.
All of the new metrics are core metrics and are subject to the Deprecation Policy . However, note that data is available for the new metrics as of July 16, 2013. (Data for the
annotationClickThroughRate
andannotationCloseRate
metrics is available as of June 10, 2012.)-
GOOGLE_SEARCH
is no longer reported as a separate value for theinsightTrafficSourceType
dimension. Instead, referrals from Google search results are now attributed to theEXT_URL
traffic source type. As a result, it's also no longer possible to retrieve aninsightTrafficSourceDetail
report that sets theinsightTrafficSourceType
filter toGOOGLE_SEARCH
.The content owner reports document has been updated to reflect that the
subscribersGained
andsubscribersLost
metrics can now be retrieved for content claimed or uploaded by a content owner.The change is visible in the first basic stats report for content owners, which now supports the
claimedStatus
anduploaderType
filters.The sample requests document has been redesigned to group examples in categories, using a tab format similar to the one recently released for channel and content owner reports. With the new design, examples are grouped into the following categories:
- Basic stats
- مبتنی بر زمان
- جغرافیایی
- محل پخش
- منبع ترافیک
- Device/OS
- جمعیت شناختی
- اجتماعی
- Earnings/Ads (for content owner reports only)
The sample requests document now includes new examples for retrieving province-specific data in either channel reports or content owner reports.
Province-specific metrics for US states and Washington DC : This report retrieves a province-by-province breakdown of view counts and other statistics for a channel's videos. The data covers US states and Washington DC The example uses the
province
dimension, and also uses thefilters
parameter to restrict the response to only include results for the United States.Viewer demographics in California (age group and gender) : This report retrieves statistics about the age group and gender of viewers in California who watched a channel's videos or, for content owner reports, a content owner's claimed content. This example uses the
filters
parameter to ensure the response only includes data for a particular province.
The definition of the
province
dimension has been updated to note that whenprovince
is included in thedimensions
parameter value, the request must also restrict data to the United States by includingcountry==US
in thefilters
parameter value.The documents that list the supported channel and content owner reports have been redesigned. Instead of providing a table that lists all possible reports, each document instead groups the reports into categories:
- Basic stats
- مبتنی بر زمان
- جغرافیایی
- محل پخش
- منبع ترافیک
- Device/OS
- جمعیت شناختی
- اجتماعی
- ویدیوهای برتر
Each document displays these categories as a list of tabs, and you can click any tab to see the supported reports in that category.
The API now supports three new geographic dimensions:
province
,continent
, andsubContinent
.The
province
dimension lets you retrieve statistics for US states and for the District of Colombia. The API supports two uses for this dimension:The API supports two reports that break statistics down on a state-by-state basis. Both reports are available for channels and content owners .
- The core stats report provides several statistics, including view counts and estimated minutes watched.
- The time-based report provides the same statistics, but aggregates data on a daily, 7-day, 30-day, or monthly basis.
You can use the
filters
query parameter to restrict a report to only contain statistics for a particular state. Several reports support this type of filtering, including geographic reports, playback location reports, traffic source reports, device reports, operating system reports, demographic reports, and top-video reports.
The
continent
dimension specifies a United Nations (UN) statistical region code that identifies a continent. This dimension can only be used as a filter .The
subContinent
dimension specifies a United Nations (UN) statistical region code that identifies a sub-region of a continent. This dimension can also only be used as a filter.Since each sub-region is only associated with one continent, there is no need to also use the
continent
filter when you are using thesubContinent
filter. (In fact, the API will return an error if a request uses both dimensions.)
The documentation has been corrected so that the
insightTrafficSourceDetail
dimension does not include theinsightTrafficSourceType
valuePROMOTED
as a valid filter value.The YouTube Analytics API is now subject to the Deprecation Policy described in the Terms of Service . However, the API's non-core dimensions and non-core metrics are not subject to the Deprecation Policy. The dimensions and metrics pages have been updated to list core dimensions and core metrics. In addition, the definitions on those pages have been updated to explicitly identify core dimensions and metrics.
The API now supports
EXTERNAL_APP
as a value for theinsightPlaybackLocationType
dimension. In conjunction with this update, as of September 10, 2013, playbacks are no longer categorized asMOBILE
playbacks, though mobile playbacks that occurred before that date will still be categorized with that value.With this update, mobile playbacks are now classified as either
WATCH
,EMBEDDED
, orEXTERNAL_APP
playbacks, depending on the type of application where the playbacks occur.The API now supports
PLAYLIST
as a value for theinsightTrafficSourceType
dimension. The value indicates that video views were referred from a playlist. Previously, these views would have been classified using the dimension'sYT_OTHER_PAGE
category.The API now supports the ability to sort reports by multiple dimensions and metrics. The sample requests document contains a new example, Sorting requests by multiple dimensions/metrics , that demonstrates this functionality. The request retrieves traffic source data and has a
sort
parameter value ofday,-views
. Results are sorted chronologically, but within the result set for each day, the first row contains data for the traffic source that generated the most views, the second row contains data for the source with that generated the next highest amount of views, and so forth .The API now supports two new dimensions,
deviceType
andoperatingSystem
, which can be used to retrieve data about the devices where viewers are watching your videos. The API supports reports that use either or both dimensions.The
deviceType
report lets you retrieve view counts and estimated watch time for different types of devices, including desktop, mobile, and tablet devices. You can also use theoperatingSystem
filter to restrict the device type report to only contain statistics for devices running a specific operating system, such as Android or iOS .The
operatingSystem
report lets you retrieve view counts and estimated watch time for different operating systems, such as Android, iOS, Linux, and more. You can also use thedeviceType
filter to restrict the operating system report to only contain statistics for a specific type of device, such as mobile devices or tablets.
The new device type and operating system reports are available for channels and for content owners .
The sample requests document has been updated to include three device reports for channels and three device reports for content owners.
The
insightPlaybackLocationType
dimension may return the valueYT_OTHER
, which identifies views that are not classified using one of the dimension's other values.The content owner reports document has been updated to reflect that you can sort the top video report in descending order of earnings to identify videos with the highest earnings. This report is the first one listed in the second table of the User activity and earnings reports section.
YouTube no longer identifies experimental API features and services. Instead, we now provide a list of YouTube APIs that are subject to the deprecation policy .
The API now supports the ability to retrieve watch time metrics –
estimatedMinutesWatched
,averageViewDuration
, andaverageViewPercentage
– in conjunction with other metrics, including view metrics, engagement metrics, earnings metrics, and ad performance metrics.The lists of available channel reports and content owner reports have been updated to reflect this change. (The lists are actually shorter now since the watch time metrics can be retrieved as part of other listed reports.)
The Sample API requests document has also been updated.
The reports that use the
insightPlaybackLocationDetail
andinsightTrafficSourceDetail
dimensions have been enhanced in the following ways:They now support an optional
country
filter.Content owners can now retrieve these reports using any of the following new
filter
combinations. Note that all of these combinations also support the optionalcountry
filter.Playback location detail
-
channel,insightPlaybackLocationType==EMBEDDED
-
show,insightPlaybackLocationType==EMBEDDED
-
claimedStatus,insightPlaybackLocationType==EMBEDDED
-
uploaderType,insightPlaybackLocationType==EMBEDDED
-
uploaderType,claimedStatus,insightPlaybackLocationType==EMBEDDED
-
Traffic source detail
-
channel,insightTrafficSourceType
-
show,insightTrafficSourceType
-
claimedStatus,insightTrafficSourceType
-
uploaderType,insightTrafficSourceType
-
uploaderType,claimedStatus,insightTrafficSourceType
-
The new Sample API requests document provides examples that demonstrate how to retrieve many different types of reports using the YouTube Analytics API . Each example includes a brief description of the report that the request retrieves and then shows the dimensions, metrics, filters, and sort parameters for the request.
The
insightTrafficSourceType
dimension now supportsSUBSCRIBER
as a valid value. This value identifies video views that were referred from feeds on the YouTube homepage or from YouTube subscription features. If you filter based on this traffic source, theinsightTrafficSourceDetail
field will specify the homepage feed or other page from which views were referred.The API now supports two new metrics,
annotationClickThroughRate
andannotationCloseRate
, which are related to viewer interactions with annotations that display during your videos. The lists of channel reports and content owner reports have both been updated to identify the reports that support the new metrics.-
annotationClickThroughRate
– The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. -
annotationCloseRate
– The ratio of annotations that viewers closed to the total number of annotation impressions.
-
The API now supports earnings and ad performance metrics as well as new ad performance reports. The metrics and the reports are all accessible only to YouTube content partners who participate in the YouTube Partner Program .
The newly supported reports support playback-based ad performance metrics and impression-based ad performance metrics. See the content owner reports documentation for more information about ad performance reports.
The newly supported metrics are listed below. The list of content owner reports has been updated to identify the reports, including the two new reports, that support these metrics.
-
earnings
– Total estimated earnings from all Google-sold advertising sources. -
grossRevenue
– Estimated gross revenue from Google or DoubleClick partners. -
primaryAdGrossRevenue
– Estimated gross revenue, summed and classified under the primary ad type for the video playbacks that the report covers, from Google or DoubleClick partners. -
monetizedPlaybacks
– The number of playbacks that showed at least one ad impression. -
playbackBasedCpm
– Estimated gross revenue per thousand playbacks. -
impressions
– The number of verified ad impressions served. -
impressionBasedCpm
– Estimated gross revenue per thousand ad impressions.
Note: See the metric definitions for complete details.
-
Any request that retrieves earnings or ad performance metrics must send an authorization token that grants access using the new
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
scope.
The API documentation has been reorganized so that different types of reports are explained on separate pages. As such, there are now separate pages explaining the different types of channel reports and content owner reports .
The API's reference guide now has an examples section, which includes code samples that demonstrate how to call the API using the Java, JavaScript, Python, and Ruby client libraries. The JavaScript code sample is the same one discussed in detail in the sample application documentation.
The API reference guide now features the APIs Explorer , which enables you to call the API, see the API request, and retrieve real data in the response.
The API supports a number of new reports for both channels and content owners, which are described below. Each report is available as a channel report or a content owner report . The dimensions and metrics pages have also been updated accordingly.
The playback location report specifies the number of video views that took place on different types of pages or applications .
The playback location detail report identifies the embedded players that generated the most views for a specified video. It provides a more fine-grained view than the playback location report by identifying the URLs associated with the top embedded players.
The traffic source report identifies the number of videos views that originated from different types of referrers .
The traffic source detail report identifies the referrers that generated the most views for a specified video and a specified traffic source type. For example, this report could you the related videos that sent the most traffic to a specific video. This report is supported for several traffic sources .
Watch time reports provide the amount of time viewers spent watching your content. The reports can aggregate data for a specific time frame – day, previous seven days, previous 30 days, etc. – or country. If a report aggregates data by either day or country, it can also specify the average length of each video view as well as the average percentage of each video that users watched.
The YouTube Analytics API is now available to all developers. You can activate the API for your project, without having to first request access, from the Services panel in the APIs console .
The new Getting Started section outlines the prerequisites and basic steps for building an application that uses the YouTube Analytics API .
The new understanding quota usage section provides guidelines for optimizing your API quota usage. The API server calculates a query cost for each request, and that cost is deducted from your API usage quota. Since different types of reports may have greatly different query costs, you should plan to use your quota efficiently, and your application should only request the metrics and data that it actually needs.
The temporal dimensions section has been updated to explain that those dimensions indicate that an Analytics report should aggregate data based on a time period. The API now supports the following additional temporal dimensions:
-
7DayTotals
– Data in the report will be aggregated so that each row contains data for a seven-day period. -
30DayTotals
– Data in the report will be aggregated so that each row contains data for a 30-day period. -
month
– Data in the report will be aggregated by calendar month.
Similarly, the available reports section has been updated to reflect the API's support for reports that use these dimensions.
-
The reporting entity dimensions section has been updated to note that API requests to retrieve content owner reports must filter data using either one of these dimensions (
video
,channel
, orshow
) or a supported combination of theclaimedStatus
anduploaderType
dimensions.The API now supports two new sorting options for top-video reports . These reports, which are available as channel reports or content owner reports, contain metrics (views, comments, likes, etc.) on a per-country basis and break down those metrics by video. You can now sort these reports based on the number of users who subscribed to or unsubscribed from a channel from the video's watch page.
The definitions of the
subscribersGained
andsubscribersLost
metrics have been updated to explain that a channel can gain or lose subscribers in several places, including the video watch page, the channel page, and the guide that appears on the YouTube home page. When these metrics appear in a video-specific report, they only include statistics from the specified video's watch page.
API Reporting YouTube از سه گزارش جدید صفحه نمایش جدید و همچنین ابعاد و معیارهای جدید برای این گزارش ها پشتیبانی می کند. این گزارش ها برای صفحه نمایش های انتهایی که بعد از پخش ویدیو نمایش داده می شوند ، تصور و کلیک از طریق آن را ارائه می دهند.
مرکز راهنمای YouTube حاوی اطلاعات دقیق تری در مورد اضافه کردن صفحه های نهایی به فیلم های شما است.
8 نوامبر 2016
این به روزرسانی شامل تغییرات زیر در API ANALTICS YouTube است:
27 اکتبر 2016
YouTube اکنون به طور خودکار مجموعه ای از گزارش های درآمد آگهی مدیریت شده توسط سیستم را برای صاحبان محتوا که به گزارش های مربوطه در بخش گزارش های استودیوی Creator YouTube دسترسی دارند ، تولید می کند. گزارش های جدید API با مدیریت سیستم به گونه ای طراحی شده است که دسترسی برنامه ای به داده هایی را که در گزارش های استودیوی Creator Creator قابل بارگیری نیز در دسترس است ، فراهم می کند.
نمای کلی گزارش های مدیریت سیستم ، مختصری از گزارش های جدید را ارائه می دهد و روند بازیابی آنها را از طریق API توضیح می دهد. این فرآیند برای بازیابی گزارش های فله ای برای YouTube Analytics کمی متفاوت است زیرا شرکا برای تولید گزارش ها نیازی به برنامه ریزی شغل ندارند.
ویژگی id
reportType
Resource به روز شده است تا لیستی از گزارش های مدیریت شده توسط سیستم را شامل شود که می توانید از طریق API به آنها دسترسی پیدا کنید:
27 سپتامبر 2016
توجه: این یک اعلامیه استهلاک است.
متریک Utube Analytics API uniques
کاهش یافته است. این یک متریک اصلی نیست و تا 31 اکتبر 2016 پشتیبانی می شود.
15 سپتامبر 2016
این به روزرسانی شامل تغییرات API گزارش YouTube زیر است:
19 آگوست 2016
این به روزرسانی شامل تغییر API گزارش YouTube زیر است:
11 آگوست 2016
این به روزرسانی شامل تغییرات زیر است:
10 آگوست 2016
این به روزرسانی شامل تغییرات زیر است:
18 جولای 2016
این به روزرسانی شامل تغییرات زیر است:
28 ژوئن 2016
مستندات API API YouTube به روز شده است تا منعکس کننده پشتیبانی از معیارهای کارت در گزارش های متعدد کانال و صاحب محتوا باشد. معیارهای تازه پشتیبانی شده عبارتند از:
معیارها در انواع گزارش های زیر پشتیبانی می شوند:
22 ژوئن 2016
این بروزرسانی شامل تغییرات API گزارش YouTube زیر است. اولین تغییر مربوط به API به طور کلی است و تغییرات باقیمانده فقط بر گزارش های صاحب محتوا تأثیر می گذارد:
19 مه 2016
این به روزرسانی شامل تغییرات API گزارش YouTube زیر است:
12 آوریل 2016
این به روزرسانی شامل تغییرات زیر است که همه آنها فقط بر API گزارشگری YouTube تأثیر می گذارد:
28 مارس 2016
API API Reporting YouTube و YouTube Analtics API اکنون آمار نمایش را برای چندین سرویس اشتراک گذاری اضافی باز می گرداند.
16 مارس 2016
این به روزرسانی شامل تغییرات زیر است که هم بر API گزارش YouTube و هم در API API YouTube تأثیر می گذارد:
گزارش YouTube API
YouTube Analytics API
8 فوریه 2016
The list of metrics supported for the YouTube Analytics API has been updated so that card metrics are no longer listed as supported metrics for that API. (None of that API's reports had been documented as supporting any of the card metrics.)
Note that you can still retrieve card metrics using the YouTube Reporting API, which supports those metrics for numerous channel and content owner reports.
6 ژانویه 2016
The YouTube Reporting API and YouTube Analytics API both now specifically identify views that occur via a Chromecast device.
21 دسامبر 2015
In the documentation, the names of the annotation_clickable_impressions
and annotation_closable_impressions
metrics have been updated to match the names being returned in the reports. Previously, the names were documented as clickable_annotation_impressions
and closable_annotation_impressions
.
18 دسامبر 2015
European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy . We have added a notice of this requirement in our YouTube API Terms of Service .
15 دسامبر 2015
This update contains the following changes, all of which affect the YouTube Analytics API:
10 نوامبر 2015
This update contains the following changes:
29 اکتبر 2015
This update contains the following changes:
8 اکتبر 2015
This update contains the following changes:
24 سپتامبر 2015
This update contains the following changes:
20 آگوست 2015
This update contains the following changes:
22 جولای 2015
This update contains several changes, all of which only apply to content owners:
1 ژوئن 2015
This update contains the following changes:
31 مارس 2015
This update contains the following changes:
16 مارس 2015
This update contains the following changes:
25 فوریه 2015
This update contains the following changes:
13 فوریه 2015
This update contains the following changes:
28 آگوست 2014
This update contains the following changes:
16 جولای 2014
This update contains the following changes:
31 ژانویه 2014
This update contains the following changes:
16 ژانویه 2014
This update contains the following changes:
6 ژانویه 2014
This update contains the following changes:
30 سپتامبر 2013
This update contains the following changes:
16 جولای 2013
This update contains the following changes:
23 مه 2013
This update contains the following changes:
10 مه 2013
This update contains the following changes:
6 مه 2013
This update contains the following changes:
3 مه 2013
This update contains the following changes:
28 مارس 2013
This update contains the following changes:
21 مارس 2013
This update contains the following changes:
4 فوریه 2013
This update contains the following changes:
14 نوامبر 2012
This update contains the following changes:
October 2, 2012
This update contains the following changes:
12 سپتامبر 2012
This update contains the following changes: