Overview
The YouTube datasource enables you to generate custom reports containing YouTube Analytics data. The datasource supports reports for channels and for content owners. Report fields are characterized as either dimensions or metrics.
|
Vendor/Partner |
Google/Youtube |
|---|---|
|
Version |
V3 |
|
API Documentation |
|
|
Sunset Date |
None as of July 4 2024 |
|
Channel(s) |
Social |
|
Refresh Time (CST) |
3 am |
|
Default backfill |
7 days |
|
Alli Data Library |
|
Getting Started
Required Authorization
The authenticated user for this source should be the account that own’s the YouTube channel for best results.
Limitations
The API response contains data up until the last day for which all metrics in the query are available at the time of the query. So, for example, if the request specifies an end date of July 5, 2017, and values for all of the requested metrics are only available through July 3, 2017, that will be the last date for which data is included in the response. (That is true even if data for some of the requested metrics is available for July 4, 2017.)
Define your Data
Dimensions
|
Name |
Description |
|---|---|
|
Day |
Aggregates data on a daily basis. |
|
Video |
The Youtube Video. |
|
Video Name |
The Youtube Video's name. |
|
Video Publish Date |
When the video was published. |
|
Video Description |
The Youtube Video's description. |
|
Channel Title |
The Channel Name. |
|
Age Group |
Age groups of logged-in users. |
|
Channel |
The ID of the Youtube Channel. |
|
Country |
The country code. |
|
Gender |
Gender of logged-in users. |
|
Sharing Service |
The service used to share videos. |
|
Uploader Type |
Content for self/third party uploaded content. |
|
Playlist |
The ID of a YouTube playlist. In the YouTube Data API |
|
Channel (only used in content owner reports) |
The ID for a YouTube channel. In the YouTube Data API |
|
Country |
The country associated with the metrics in the report row. The country code ZZ is used to report metrics for which YouTube could not identify the associated country. |
|
Province |
The U.S. state or territory associated with the metrics in the report row. |
|
Insight Playback Location Type |
Data in the report is aggregated based on the type of page or application where video playbacks occurred. |
|
Insight Playback Location Detail |
Data is aggregated based on the page where the player is located. |
|
Live or On Demand |
This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. |
|
Subscribed Status |
This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video's or playlist's channel. |
|
YouTube Product |
This dimension identifies the YouTube service on which the user activity occurred. |
|
Insight Traffic Source Type |
Data in the report is aggregated based on the referrer type. |
|
Device Type |
This dimension identifies the physical form factor of the device on which the view occurred. |
|
Operating System |
This dimension identifies the software system of the device on which the view occurred. |
|
Elapsed Video Time Ratio |
This dimension specifies the ratio of the elapsed portion of the video to the video's length. |
|
Ad Type |
The adType dimension is used in ad performance reports and aggregates the requested metrics based on the types of ads that ran during video playbacks. |
|
Claimed Status (only used in content owner reports) |
This dimension lets you indicate that an API response should only contain metrics for claimed content. |
Metrics
|
Name |
Description |
|---|---|
|
Annotation Click Through Rate |
|
|
Annotation Close Rate |
|
|
Average View Duration |
|
|
Comments |
|
|
Dislikes |
|
|
Estimated Revenue |
|
|
Estimated Minutes Watched |
|
|
Likes |
|
|
Shares |
|
|
Subscribers Gained |
|
|
Subscribers Lost |
|
|
Viewer Percentage |
|
|
Views |
|
|
Red Views |
The number of times that a video was viewed by YouTube Red members. |
|
Estimated Red Minutes Watched |
The number of minutes that YouTube Red members watched a video. |
|
Average View Percentage |
The average percentage of a video watched during a video playback. |
|
Videos Added to Playlists |
The number of times that videos were added to any YouTube playlists. The videos could have been added to the video owner's playlist or to other channels' playlists. |
|
Videos Removed from Playlists |
The number of times that videos were removed from any YouTube playlists. The videos could have been removed from the video owner's playlist or from other channels' playlists. |
|
Playlist Starts |
The number of times that viewers initiated playback of a playlist. Note that this metric only includes playlist views that occurred on the web. |
|
Views Per Playlist Start |
The average number of video views that occurred each time a playlist was initiated. Note that this metric only includes playlist views that occurred on the web. |
|
Average Time in Playlist |
The estimated average amount of time in minutes that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric only includes playlist views that occurred on the web. |
|
Annotation Impressions |
The total number of annotation impressions. |
|
Annotation Clickable Impressions |
The number of annotations that appeared and could be clicked. |
|
Annotation Clicks |
The number of clicked annotations. |
|
Annotation Closable Impressions |
The number of annotations that appeared and could be closed. |
|
Annotation Closes |
The number of closed annotations. |
|
Card Impressions |
The number of times cards were displayed. When the card panel is opened a card impression is logged for each of the video's cards. |
|
Card Clicks |
The number of times that cards were clicked. |
|
Card Click Rate |
The click-through-rate for cards which is calculated as the ratio of card clicks to card impressions. |
|
Card Teaser Impressions |
The number of times that card teasers were displayed. A video view can generate multiple teaser impressions. |
|
Card Teaser Clicks |
The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user. |
|
Card Teaser Click Rate |
The click-through-rate for card teasers which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions. |
|
Estimated Ad Revenue |
The total estimated net revenue from all Google-sold advertising sources for the selected date range and region. |
|
Estimated Red Partner Revenue |
The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The metric's value reflects revenue from both music and non-music content and is subject to month-end adjustment. |
|
Gross Revenue |
The estimated gross revenue in USD from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. |
|
CPM |
The estimated gross revenue per thousand ad impressions. |
|
Ad Impressions |
The number of verified ad impressions served. |
|
Monetized Playbacks |
The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. |
|
Playback Based CPM |
The estimated gross revenue per thousand playbacks. |
|
Playlist Average View Duration |
The estimated average length in seconds watched per playlist view. |
|
Playlist Estimated Minutes Watched |
The number of minutes that users watched the playlist content as a part of the playlist. |
|
Playlist Saves |
The net number of times that users saved a playlist. |
|
Playlist Views |
The number of times that videos in the playlist were viewed in the context of that playlist. |