JDBC Driver for YouTube Analytics

Build 24.0.9060

TimeBasedReports

Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time.

Table-Specific Information

Select Rules

You can use the following tables to build queries to TimeBased Reports: TimeBased Reports for videos:

Dimensions Use 0 or more day, month, video
Metrics Use 1 or more views, comments, likes, dislikes, videosAddedToPlaylists, videosRemovedFromPlaylists, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, subscribersGained, subscribersLost, uniques, earnings, adEarnings, grossRevenue, redPartnerRevenue, monetizedPlaybacks, playbackBasedCpm, impressions, impressionBasedCpm
Filter Use 0 or one country, continent, subContinent
Use 0 or one video, group

Timebased Reports for playlist rules:

Dimensions Use exactly one day, month
Optional creatorContentType
Use 0 or more subscribedStatus, youtubeProduct
Metrics Use 1 or more views, estimatedMinutesWatched, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist
Filter Required isCurated=true
Use 0 or one country, province, continent, subContinent
Use 0 or one playlist, channel, group
Use 0 or more subscribedStatus, youtubeProduct

Timebased Reports for content owner rules:

Dimensions Use exactly one day, month
Optional creatorContentType
Metrics Use 1 or more views, comments, likes, dislikes, videosAddedToPlaylists, videosRemovedFromPlaylists, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, subscribersGained, subscribersLost, uniques, earnings, adEarnings, grossRevenue, redPartnerRevenue, monetizedPlaybacks, playbackBasedCpm, impressions, impressionBasedCpm
Filter Use exactly one video, channel, group
Use 0 or one country, continent, subContinent

Timebased Reports for content owner playlist rules:

Dimensions Use exactly one day, month
Use 0 or more subscribedStatus, youtubeProduct
Metrics Use 1 or more views, estimatedMinutesWatched, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylis
Filter Required isCurated=true
Use 0 or one country, province, continent, subContinent
Use 0 or one playlist, channel, group
Use 0 or more subscribedStatus, youtubeProduct

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Day String True True When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day.
Month String True Data in the report is aggregated by calendar month. In the report, dates are listed in YYYY-MM format. Note: If your SQL query uses the Month dimension, then the StartDate and EndDate parameters must both be set to the first day of the month.
CreatorContentType String True This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED.
Views Double True The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist.
RedViews Double True The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members.
Comments Double True The number of times that users commented on a video.
Likes Double True The number of times that users indicated that they liked a video by giving it a positive rating.
Dislikes Double True The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy.
VideosAddedToPlaylists Double True The number of times that videos were added to the video owner playlist or other channel playlists like the Watch Later playlist. Channel uploads playlists and user watch history are not reported. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, and then adds it again, the metric value reflects the video being added to a playlist twice. Data for this metric is not available for dates before October 1, 2014.
VideosRemovedFromPlaylists Double True The number of times that videos were removed from the video owner playlist and other YouTube playlists like the Watch Later playlist. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, adds it again, and then removes it again, the metric value reflects the video being removed from a playlist twice. Data for this metric is not available for dates before October 1, 2014.
Shares Double True The number of times that users shared a video through the Share button.
EstimatedMinutesWatched Double True The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
EstimatedRedMinutesWatched Double True The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video.
AverageViewDuration Double True The average length, in seconds, of video playbacks. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist.
AverageTimeInPlaylist Double The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated.
AverageViewPercentage Double True The average percentage of a video watched during a video playback.
AnnotationClickThroughRate Double True The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationCloseRate Double True The ratio of annotations that viewers closed to the total number of annotation impressions.
AnnotationImpressions Double True The total number of annotation impressions.
AnnotationClickableImpressions Double True The number of annotations that appeared and could be clicked.
AnnotationClosableImpressions Double True The number of annotations that appeared and could be closed.
AnnotationClicks Double True The number of clicked annotations.
AnnotationCloses Double True The number of closed annotations.
CardClickRate Double True The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions.
CardTeaserClickRate Double True 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.
CardImpressions Double True 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.
CardTeaserImpressions Double True The number of times that card teasers were displayed. A video view can generate multiple teaser impressions.
CardClicks Double True The number of times that cards were clicked.
CardTeaserClicks Double True The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user.
SubscribersGained Double True The number of times that users subscribed to a channel or video.
SubscribersLost Double True The number of times that users unsubscribed from a channel or video.
EstimatedRevenue Decimal The total estimated earnings (net revenue) from all Google-sold advertising sources as well as from nonadvertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising.
EstimatedAdRevenue Decimal The total estimated earnings (net revenue) from all Google-sold advertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising.
GrossRevenue Decimal The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
EstimatedRedPartnerRevenue Decimal The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The value of the metric reflects earnings from both music and nonmusic content and is subject to month-end adjustment.
MonetizedPlaybacks Double 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. The expected estimated error for this figure is ?2.0%.
PlaybackBasedCpm Decimal The estimated gross revenue per thousand playbacks.
AdImpressions Double The number of verified ad impressions served.
Cpm Decimal The estimated gross revenue per thousand ad impressions.
PlaylistAverageViewDuration Double The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels.
PlaylistEstimatedMinutesWatched Double The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels.
PlaylistSaves Double The net number of times that users saved a playlist. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and saves it again, the metric value reflects one playlist save being added.
PlaylistStarts Double The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web.
PlaylistViews Double The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels.
ViewsPerPlaylistStart Double The average number of video views that occurred each time a playlist was initiated.
Video String True The Id of a YouTube video.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
Country String The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country.
Continent String (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data.
SubContinent String (filter only) A U.N. statistical region code that identifies a geographical subregion.
UploaderType String (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty.
ClaimedStatus String (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed.
Channel String (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060