CData Python Connector for YouTube Analytics

Build 23.0.8839

UserActivityByCountry

This report provides user activity statistics.

Table Specific Information

Select Rules

User activity by country can only be filtered to return data for a specific video.

Video Reports:

Dimensions Required country
Optional creatorContentType
Metrics Use 1 or more views, redViews, comments, likes, dislikes, videosAddedToPlaylists, videosRemovedFromPlaylists, shares, estimatedMinutesWatched, estimatedRedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, cardClickRate, cardTeaserClickRate, cardImpressions, cardTeaserImpressions, cardClicks, cardTeaserClicks, subscribersGained, subscribersLost, estimatedRevenue*, estimatedAdRevenue*, grossRevenue*, estimatedRedPartnerRevenue*, monetizedPlaybacks*, playbackBasedCpm*, adImpressions*, cpm*
Filters Use 0 or 1 continent,subContinent
Use 0 or 1 video, group


Playlist Reports:

Dimensions Required country
Use 0 or more subscribedStatus, youtubeProduct
Metrics Use 1 or more views, redViews, estimatedMinutesWatched, estimatedRedMinutesWatched, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist
Filters Required isCurated==1
Use 0 or 1 continent, subContinent
Use 0 or 1 playlist, group
Use 0 or more subscribedStatus, youtubeProduct


Content Owner Reports:

Dimensions Required country
Optional creatorContentType
Metrics Use 1 or more views, redViews, comments, likes, dislikes, videosAddedToPlaylists, videosRemovedFromPlaylists, shares, estimatedMinutesWatched, estimatedRedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, cardClickRate, cardTeaserClickRate, cardImpressions, cardTeaserImpressions, cardClicks, cardTeaserClicks, subscribersGained, subscribersLost, estimatedRevenue*, estimatedAdRevenue*, grossRevenue*, estimatedRedPartnerRevenue*, monetizedPlaybacks*, playbackBasedCpm*, adImpressions*, cpm*
Filters Use exactly 1 video, channel, group, or a supported combination of uploaderType and claimedStatus
Use 0 or 1 continent, subContinent

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Channel String True (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.
Video String True The Id of a YouTube video.
Playlist String True The Id of a YouTube playlist.
Group String True (filter only) The Id of a YouTube Analytics group.
Country String True False 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 True (filter only) A United Nations (U.N.) statistical region code. The allowed values are 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 True (filter only) A U.N. statistical region code that identifies a geographical subregion.
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.
SubscribedStatus String True This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs.
YoutubeProduct String True This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN.
IsCurated Boolean True This filter indicates that the request is retrieving data about video views that occurred in the context of a playlist. This filter is required for any playlist report and its value must be set to 1.
ClaimedStatus String True (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.
UploaderType String True (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.
Views Double False 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 False False The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members.
Likes Double False False The number of times that users indicated that they liked a video by giving it a positive rating.
Comments Double False False The number of times that users commented on a video.
Dislikes Double False False The number of times that users indicated that they disliked a video by giving it a negative rating.
VideosAddedToPlaylists Double False False 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.
VideosRemovedFromPlaylists Double False False 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.
Shares Double False False The number of times that users shared a video through the Share button.
EstimatedMinutesWatched Double False False The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
EstimatedRedMinutesWatched Double False False The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video.
AverageViewDuration Double False False The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist.
AverageViewPercentage Double False False The average percentage of a video watched during a video playback.
AnnotationClickThroughRate Double False False The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationCloseRate Double False False The ratio of annotations that viewers closed to the total number of annotation impressions.
AnnotationImpressions Double False False The total number of annotation impressions.
AnnotationClickableImpressions Double False False The number of annotations that appeared and could be clicked.
AnnotationClosableImpressions Double False False The number of annotations that appeared and could be closed.
AnnotationClicks Double False False The number of clicked annotations.
AnnotationCloses Double False False The number of closed annotations.
CardClickRate Double False False The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions.
CardTeaserClickRate Double False False 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 False False 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 False False The number of times that card teasers were displayed. A video view can generate multiple teaser impressions.
CardClicks Double False False The number of times that cards were clicked.
CardTeaserClicks Double False False The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user.
SubscribersGained Double False False The number of times that users subscribed to a channel.
SubscribersLost Double False False The number of times that users unsubscribed from a channel.
EstimatedRevenue Double False False The total estimated net revenue from all Google-sold advertising sources as well as from non-advertising sources for the selected date range and region.
EstimatedAdRevenue Double False False The total estimated net revenue from all Google-sold advertising sources for the selected date range and region.
GrossRevenue Double False False 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 estimated revenue, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
EstimatedRedPartnerRevenue Double False False The total estimated revenue earned from YouTube Premium (previously known as 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.
MonetizedPlaybacks Double False False 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 Double False False The estimated gross revenue per thousand playbacks.
AdImpressions Double False False The number of verified ad impressions served.
CPM Double False False The estimated gross revenue per thousand ad impressions.
PlaylistStarts Double False False The number of times that viewers initiated playback of a playlist. Note that this metric only includes playlist views that occurred on the web.
ViewsPerPlaylistStart Double False False 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.
AverageTimeInPlaylist Double False False 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.
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 23.0.8839