Adding a Connection to YouTube Analytics

To add a connection to YouTube Analytics:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the YouTube Analytics icon is not available, click the Add More icon to download and install the YouTube Analytics connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to YouTube Analytics

YouTube Analytics supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to YouTube Analytics from three common authentication flows:

• Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
• Web: access to data via a shared website. Authenticated via custom OAuth only.
• Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in YouTube Analytics, see Connection.

When the access token expires, the Sync App refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Sync App automatically refresh the OAuth access token, do the following:

1. The first time you connect to data, set the following connection parameters:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = the client Id in your application settings.
   • OAuthClientSecret = the client secret in your application settings.
   • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation = the path where you want the Sync App to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId = the Client Id in your application settings.
   • OAuthClientSecret = the Client Secret in your application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

YouTube Analytics data is organized into various metrics (Viewers, ViewerPercentage, AgeGroup, etc.), which can be queried over various dimensions (Day, DeviceType, etc.). There are many valid combinations of metrics and dimensions. The Sync App surfaces some of the most commonly used combinations as relational views for ease of use.

Additionally, the Sync App allows you to query all valid combinations, even those not included in the predefined views. You can use the CreateCustomSchema stored procedure to create a view on a query. Refer to Data Model for how to combine metrics and dimensions in queries and schemas. Below is a guide to getting started with the default views.

Selecting Dimensions and Measures

The dimension and metrics are clearly defined for each table and can be seen in the Data Model: Simply select the metrics and the dimensions you are interested in. For example, a channel's top videos by most minutes watched in a specific country can be selected like this:

SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country='AL'

Executing SELECT * Queries

Unlike most database tables, it is not very helpful to select all metrics and dimensions in a given table. The Sync App thus interprets the SELECT * query to mean a default set of metrics and dimensions are requested. This includes queries that explicitly select all columns. Refer to the individual view's documentation in Data Model to see which fields are the default for each schema.

This section details a selection of advanced features of the YouTube Analytics Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to YouTube Analytics and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models YouTube Analytics entities in relational Tables, Views, and Stored Procedures.

YouTube Analytics allows for the querying of Dimensions and Metrics in a large number of arrangements. We provide some sample views based on common YouTube Analytics reports. You can also create your own custom views based on any combination of Dimensions and Metrics you need.

For information about how to view schemas, along with API limitations and requirements, see Defining Custom Views, below.

Tables

You can access Groups and Group Items as Tables.

Stored Procedures

Stored Procedures are function-like interfaces to the data source that can be used to access additional capabilities of the YouTube Analytics API.

Views

Reports are shown as views; that is, as tables that are "snapshots" of the data, and cannot be modified. Unlike traditional database views, it is not very helpful to create a view of an entire table by selecting all metrics and dimensions in that table, because the provider interprets the SELECT * query as if you are requesting a default set of metrics and dimensions. This is also true for queries that explicitly select all columns.

Note that the YouTube Analytics API limits the number and combinations of columns that can be projected over the data or used to restrict the results returned. These limitations and the default fields for each schema are listed in Views. Refer to these sections when defining your own view, as well.

Defining Custom Views

Use the CreateCustomSchema stored procedure to create a view on a query. This stored procedure provides an easy way to generate new view definitions with a custom combination of Dimensions and Metrics. Calling it creates a new schema file that you can query like any other view.

The stored procedure takes a view name, a comma-separated list of metrics, a comma-separated list of dimensions, and an output folder as inputs. To access the script files created, you must set Location to the folder containing the new script files. In this sense, Location is a substitute for the output folder.

For example, to use a new schema along with the default schemas, set Location to the db subfolder in the installation folder and call:

EXEC CreateCustomSchema Dimensions='Day,DeviceType', Metrics='Views,EstimatedMinutesWatched', TableName='DailyDeviceReports'

The Sync App models the data in YouTube Analytics as a list of tables in a relational database that can be queried using standard SQL statements.

YouTube Analytics Connector for CData Sync Tables

Name	Description
GroupItems	Create, delete, and query Items that compose a Group.
Groups	Create, update, delete, and query YouTube Analytics Groups.

Create, delete, and query Items that compose a Group.

Table-Specific Information

Select

The following query returns the items that compose the YouTube Analytics groups:

SELECT * FROM GroupItems

The following query returns the items that compose a specific YouTube Analytics group:

SELECT * FROM GroupItems WHERE GroupId = '239_65GrkKS6kRL'

Additionally, OnBehalfOfContentOwner can optionally be used in the WHERE clause.

Insert

GroupId and Resource_Id are required to insert an Item into a Group.

INSERT INTO GroupItems (GroupId, Resource_Id) VALUES ('fjgeeljgio54', 'dkhgjio5sfff')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id that YouTube uses to uniquely identify the channel, video, playlist, or asset that is included in the group. Note that this Id refers specifically to the inclusion of that entity in a particular group and is different than the channel Id, video Id, playlist Id, or asset Id that uniquely identifies the entity itself.
Kind	String	False	Identifies the type of the group item. The value will be youtube#groupItem.
Etag	String	False	The Etag of this item.
GroupId	String	False	The Id that YouTube uses to uniquely identify the group that contains the item.
Resource_Kind	String	False	The type of the group item. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset.
Resource_Id	String	False	The channel, video, playlist, or asset Id that YouTube uses to uniquely identify the group item.
OnBehalfOfContentOwner	String	False	This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value.

Create, update, delete, and query YouTube Analytics Groups.

Table-Specific Information

A Group is a custom collection of up to 200 channels, videos, playlists, or assets. All of the Items in a Group must represent the same type of entity. For example, you cannot create a Group that contains 100 videos and 100 playlists. An Analytics Group can only contain entities that you have uploaded or claimed or that are linked to a channel that you administer. As a result, content owners can create groups of videos, playlists, channels, or assets. Channel owners can create groups of videos and playlists.

Select

The following columns can be used in the WHERE clause: OnBehalfOfContentOwner and Mine.

Insert

ContentDetails_ItemType is required to insert a Group.

INSERT INTO Groups (Snippet_Title, ContentDetails_ItemType) VALUES ('test2', 'youtube#channel')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id that YouTube uses to uniquely identify the group.
Kind	String	False	Identifies the type of the YouTube Analytics entity. The value will be youtube#group.
Etag	String	False	The Etag of this resource.
Snippet_PublishedAt	DateTime	True	The date and time that the group was created.
Snippet_Title	String	False	The group name. The value must be a nonempty string.
ContentDetails_ItemCount	String	False	The number of items in the group.
ContentDetails_ItemType	String	False	The type of entities that the group contains. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset.
Mine	String	False	Set this to true to retrieve all groups owned by the authenticated user.
PageToken	String	False	The PageToken parameter identifies a specific page in the result set that should be returned.
OnBehalfOfContentOwner	String	False	This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

YouTube Analytics Connector for CData Sync Views

Name	Description
Activities	Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube.
AdPerformanceReports	Query Ad Performance Reports. Ad Performance Reports provide impression-based metrics for ads that ran during video playbacks. These metrics account for each ad impression, and each video playback can yield multiple impressions.
Captions	Query YouTube Captions. A Caption resource represents a YouTube caption track.
Channels	Query YouTube Channels.
ChannelSections	Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature.
Comments	Query YouTube Comments.
CommentThreads	Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment.
Demographics	Query YouTubeAnalytics Demographics grouped by age groups and gender.
Devices	Query YouTubeAnalytics Devices or Operating System statistics. This table allows you to aggregate viewing statistics based on the manner in which viewers reached your video content. For example, you can identify the number of views that occurred on mobile devices or game consoles.
EngagementReports	Query Engagement Reports info. For example, how many times a user shared a video.
Languages	Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language.
PlayListItems	Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList.
PlayLists	Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users.
Regions	Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale.
Subscriptions	Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video.
TimeBasedReports	Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time.
TopVideos	Query the TopVideos for a channel or the TopPlaylists if you are a content owner. You can also use this view to query playback detail and geographic filters.
TrafficSources	Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content.
UserActivityByCity	This report provides user activity statistics, sorted by city.
UserActivityByCountry	This report provides user activity statistics.
UserActivityByProvince	This report provides user activity statistics, sorted by province (includes Washington DC).
VideoAbuseReportReasons	Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content.
VideoCategories	Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos.
Videos	Query YouTube Videos.

Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube.

Table Specific Information

Select

YouTube Analytics only allows Channel Id to be used as filter criteria. Additionally, the extra optional columns supported are PublishedAt and Region.

All columns support the '=' operator. PublishedAt also supports '>', '>=', '<', and '<='.

By default, if no filters are specified, the driver will return activities generated by authenticated user.

SELECT * FROM Activities WHERE ChannelId = "abc123" AND PublishedAt < '2016-01-01T10:00:00Z'

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the activity.
PublishedAt	Datetime				The date and time that the activity occurred. The value is in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId	String				The Id that YouTube uses to uniquely identify the channel associated with the activity.
Title	String				The title of the resource primarily associated with the activity.
Description	String				The description of the resource primarily associated with the activity.
ChannelTitle	String				Channel title for the channel responsible for this activity.
Type	String				The type of activity that the resource describes. Valid values: channelItem, comment (not currently returned), favorite, like, playlistItem, recommendation, social, subscription, and upload.
GroupId	String				The group Id associated with the activity.
ThumbnailsDefaultUrl	String				The URL of the default image thumbnail.
UploadVideoId	String				The Id that YouTube uses to uniquely identify the uploaded video.
LikeResourceIdKind	String				The type of the resource that received a positive (like) rating.
LikeResourceIdVideoId	String				The Id that YouTube uses to uniquely identify the video, if the rated resource is a video. This column is only present if the ResourceIdKind is youtube#video.
FavoriteResourceIdKind	String				The type of the YouTube entity marked as a favorite.
FavoriteResourceIdVideoId	String				The Id that YouTube uses to uniquely identify the favorite video.
CommentResourceIdKind	String				The comment on the API resource.
CommentResourceIdVideoId	String				The Id that YouTube uses to uniquely identify the video associated with a comment.
CommentResourceIdChannelId	String				The Id that YouTube uses to uniquely identify the channel associated with a comment.
SubscriptionResourceIdKind	String				The type of the subscription. A subscription is a channel that a user subscribed to.
SubscriptionResourceIdChannelId	String				The Id that YouTube uses to uniquely identify the channel that the user subscribed to.
PlaylistItemResourceIdKind	String				The type of the playlist item.
PlaylistItemResourceIdVideoId	String				The Id that YouTube uses to uniquely identify the video that was added to the playlist.
PlaylistItemPlaylistId	String				The value that YouTube uses to uniquely identify the playlist.
PlaylistItemPlaylistItemId	String				The value that YouTube uses to uniquely identify the item in the playlist.
RecommendationResourceIdKind	String				The type of the recommendation.
RecommendationResourceIdVideoId	String				The Id that YouTube uses to uniquely identify the video, if the recommended resource is a video.
RecommendationResourceIdChannelId	String				The Id that YouTube uses to uniquely identify the channel, if the recommended resource is a channel.
RecommendationReason	String				The reason that the YouTube entity was recommended to the user. Valid values for this column : unspecified, videoFavorited, videoLiked, and videoWatched.
RecommendationSeedResourceIdKind	String				The type of the YouTube entity that caused the recommendation.
RecommendationSeedResourceIdVideoId	String				The Id that YouTube uses to uniquely identify the video, if the recommendation was caused by a particular video.
RecommendationSeedResourceIdChannelId	String				The Id that YouTube uses to uniquely identify the channel, if the recommendation was caused by a particular channel.
RecommendationSeedResourceIdPlaylistId	String				The Id that YouTube uses to uniquely identify the playlist, if the recommendation was caused by a particular playlist.
SocialType	String				The name of the social network post. Valid values for this column: facebook, googlePlus, twitter, and unspecified.
SocialResourceIdKind	String				The type of the social network post.
SocialResourceIdVideoId	String				The Id that YouTube uses to uniquely identify the video featured in a social network post, if the post refers to a video.
SocialResourceIdChannelId	String				The Id that YouTube uses to uniquely identify the channel featured in a social network post, if the post refers to a channel.
SocialResourceIdPlaylistId	String				The Id that YouTube uses to uniquely identify the playlist featured in a social network post.
SocialAuthor	String				The author of the social network post.
SocialReferenceUrl	String				The URL of the social network post.
SocialImageUrl	String				An image of the author of the post.
ChannelItemResourceId	String				The Id of the YouTube entity that was added to the channel.

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
Region	String	Instructs the API to filter by region. The parameter value is an ISO 3166-1 alpha-2 country code.

Query Ad Performance Reports. Ad Performance Reports provide impression-based metrics for ads that ran during video playbacks. These metrics account for each ad impression, and each video playback can yield multiple impressions.

Table Specific Information

Select

Get GrossRevenue for a video in a specific country grouped by ad type and day:

SELECT Country, AdType, Day, GrossRevenue, StartDate, EndDate FROM AdPerformanceReports WHERE video = 'vid123' AND continent = '019'

Select Rules

Ad performance reports for content owners:

Dimensions	Required	adType
	Optional	day
Metrics	Use 1 or more	grossRevenue,adImpressions,cpm
Filter	Use exactly one	video, group, or a supported combination of uploaderType and claimedStatus
	Use 0 or one	country,continent,subContinent

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Video	String	True			The Id of a YouTube video.
Group	String	True			(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 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				(filter only) A U.N. statistical region code that identifies a geographical subregion.
AdType	String	True			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: auctionDisplay, auctionInstream, auctionTrueviewInslate, auctionTrueviewInstream, auctionUnknown, reservedClickToPlay, reservedDisplay, reservedInstream, reservedInstreamSelect, reservedMasthead, reservedUnknown.
Day	String	True			When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day.
ClaimedStatus	String				(only used in content owner reports) This dimension lets you indicate that a result set should only contain metrics for claimed content. The allowed value is claimed.
UploaderType	String				(only used in content owner reports) This dimension lets you indicate whether a result set should 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.
GrossRevenue	Decimal		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 earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
Cpm	Decimal		False		The estimated gross revenue per thousand ad impressions.
AdImpressions	Double		False		The number of verified ad impressions served.
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.

Query YouTube Captions. A Caption resource represents a YouTube caption track.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. The VideoId column must be specified. Extra optional columns supported are Id and OnBehalfOfContentOwner.

All columns support the '=' operator.

SELECT * FROM Captions WHERE VideoId = '123456789'

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the caption track.
VideoId	String				The Id that YouTube uses to uniquely identify the video associated with the caption track.
LastUpdated	Datetime				The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
TrackKind	String				The type of the caption track. Valid values for this column: ASR (a caption track generated using automatic speech recognition); Forced (a caption track that plays when no other track is selected in the player. For example, a video that shows aliens speaking in an alien language might have a forced caption track to only show subtitles for the alien language); standard (a regular caption track. This is the default value).
Language	String				The language of the caption track. The column value is a BCP-47 language tag.
Name	String				The name of the caption track. The name is intended to be visible to the user as an option during playback.
AudioTrackType	String				The type of audio track associated with the caption track. Valid values for this column: commentary (the caption track corresponds to an alternate audio track that includes commentary, such as director commentary); descriptive (the caption track corresponds to an alternate audio track that includes additional descriptive audio); primary (the caption track corresponds to the primary audio track for the video, which is the audio track normally associated with the video); unknown (this is the default value).
IsCC	Boolean				Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
IsLarge	Boolean				Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
IsEasyReader	Boolean				Indicates whether the caption track is formatted for easy reader, meaning it is at a third-grade level for language learners. The default value is false.
IsDraft	Boolean				Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
IsAutoSynced	Boolean				Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
Status	String				The status of the caption track. Valid values for this column: failed, serving, syncing.
FailureReason	String				The reason that YouTube failed to process the caption track. Valid values: processingFailed (YouTube failed to process the uploaded caption track); unknownFormat (the format of the caption track was not recognized); unsupportedFormat (the format of the caption track is not supported).

Query YouTube Channels.

Table Specific Information

Select

By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube Analytics if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

By default, if no filters are specified, the driver will return all channels owned by the authenticated user.

YouTube Analytics allows only a subset of columns to be used as filter criteria. The channels can be filtered by the Id. Extra optional columns supported are Language and ChannelId.

A search against all channels in YouTube Analytics may be triggered by specifying one or more of SearchTerms, ChannelId, Region, SafeSearch, Rating, or Relevance to search all channels.

All columns support the '=' operator. 'PublishedAt', also supports '>', '>=', '<', and '<='.

Order by is supported for the Rating, Relevance, and Title columns.

SELECT * FROM Channels WHERE Id = 'abc123'

SELECT * FROM Channels WHERE ChannelId = 'abc123' AND SearchTerms = 'music|movies-horror' ORDER BY Rating LIMIT 10

Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the channel.
Title	String				The title of the channel.
Description	String				The description of the channel. The value of the column has a maximum length of 1000 characters.
CustomUrl	String				The channel's custom URL.
PublishedAt	Datetime				The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ThumbnailsDefaultUrl	String				The URL of the default image thumbnail.
DefaultLanguage	String				This column is confidential to trusted testers.
LiveBroadcastContent	String				An indication of whether a video or channel resource has live broadcast content.
LocalizedTitle	String				This column is confidential to trusted testers. The localized video title.
LocalizedDescription	String				This column is confidential to trusted testers. The localized video description.
Country	String				The country with which the channel is associated.
ViewCount	Long				The number of times the channel has been viewed.
SubscriberCount	Long				The number of subscribers that the channel has. This value is rounded down to three significant figures.
HiddenSubscriberCount	Boolean				Indicates whether the subscriber count of the channel is publicly visible.
VideoCount	Long				The number of videos uploaded to the channel.
RelatedPlaylistsLikes	String				The Id of the playlist that contains the liked videos of the channel.
RelatedPlaylistsUploads	String				The Id of the playlist that contains the uploaded videos of the channel.
PrivacyStatus	String				Privacy status of the channel. Valid values for this column: private, public, unlisted.
IsLinked	Boolean				Indicates whether the channel data identifies a user who is already linked to either a YouTube username or a Google+ account. A user who has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos.
LongUploadsStatus	String				Indicates whether the channel is eligible to upload videos that are more than 15 minutes long. This column is only returned if the channel owner authorized the API request. See the YouTube Help Center for more information about this feature.
MadeForKids	Boolean				This value indicates whether the channel is designated as child-directed, and it contains the current 'made for kids' status of the channel.
Keywords	String				Keywords associated with your channel. The value is a space-separated list of strings.
TrackingAnalyticsAccountId	String				The Id for a Google Analytics account that you want to use to track and measure traffic to your channel.
ModerateComments	Boolean				This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false.
SearchTerms	String				The SearchTerms parameter specifies the query term to search for.

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
ForUsername	String	The username associated with the channel.
Language	String	Retrieve localized resource metadata for a specific application language that the YouTube website supports.
Language	String	Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ManagedByMe	String	This parameter is intended exclusively for YouTube content partners. Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
OnBehalfOfContentOwner	String	This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
ChannelId	String	The Id that YouTube uses to uniquely identify a channel.
Region	String	The country associated with the channel.
SafeSearch	String	Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
Rating	String	Resources are sorted from highest to lowest rating.
Relevance	String	Resources are sorted based on their relevance to the search query. This is the default value for this parameter.

Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are Language and OnBehalfOfContentOwner.

All columns support the '=' operator.

By default, if no channel id is specified, the driver will return channel sections for the channel owned by authenticated user.

SELECT * FROM ChannelSections WHERE ChannelId = '123456789'

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the channel section.
Type	String				The type of the channel section.
ChannelId	String				The Id that YouTube uses to uniquely identify the channel.
Title	String				The title of the section.
Position	Integer				The position of the section on the channel page.
PlaylistsAggregate	String				A list of one or more playlist Ids that are featured in a channel section. You must specify a list of playlist Ids if the type of the ChannelSection is either singlePlaylist or multiplePlaylists, and this column should not be specified for other types of sections. If the type is singlePlaylist, this list must specify exactly one playlist Id.
ChannelsAggregate	String				A list of one or more channel Ids that are featured in a channel section. You must specify a list of channel Ids if the Type of the ChannelSection is multipleChannels, and this column should not be specified for other types of sections. You cannot include your own channel in the list.

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
Language	String	Retrieve localized resource metadata for a specific application language that the YouTube website supports.
OnBehalfOfContentOwner	String	This parameter is intended exclusively for YouTube content partners.

Query YouTube Comments.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: Id or ParentId. Extra optional columns supported are TextFormat.

All columns support the '=' operator.

SELECT * FROM Comments WHERE Id = '123456789'

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the comment.
ChannelId	String				The Id of the YouTube channel associated with the comment. If the comment is a video comment, then this column identifies the channel of the video, and the VideoId column identifies the video. If the comment is a channel comment, then this column identifies the channel that the comment is about.
VideoId	String				The Id of the video that the comment refers to.
TextDisplay	String				The text of the comment. The text can be retrieved in either plaintext or HTML. The TextFormat pseudo column specifies the desired text format.
TextOriginal	String				The original, raw text of the comment as it was initially posted or last updated. The original text is only returned if it is accessible to the authenticated user, which is only guaranteed if the user is the author of the comment.
ParentId	String				The unique Id of the parent comment. This column value is only set if the comment was submitted as a reply to another comment.
AuthorDisplayName	String				The display name of the user who posted the comment.
AuthorProfileImageUrl	String				The URL for the avatar of the user who posted the comment.
AuthorChannelUrl	String				The URL of the YouTube channel of the comment author, if available.
AuthorChannelIdValue	String				The Id of the YouTube channel of the comment author, if available.
AuthorGoogleplusProfileUrl	String				The URL of the Google+ profile of the comment author, if available.
CanRate	Boolean				This setting indicates whether the current viewer can rate the comment.
ViewerRating	String				The rating the viewer has given to this comment. Valid values for this column: like, none. Note that this column does not currently identify dislike ratings. The column value is like if the viewer has rated the comment positively. The value is none in all other cases, including the user having given the comment a negative rating or not having rated the comment.
LikeCount	Integer				The total number of likes (positive ratings) the comment has received.
ModerationStatus	String				The moderation status of the comment. This value is only returned if the API request was authorized by the owner of the channel or the video on which the requested comments were made. In addition, note that this value is not set if the query filtered on the Id column. Valid values: heldForReview, likelySpam, published, rejected.
PublishedAt	Datetime				The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
UpdatedAt	Datetime				The date and time when the comment was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

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
TextFormat	String	This parameter indicates whether the API should return comments formatted as HTML or as plaintext.

Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: AllThreadsRelatedToChannelId, ChannelId, Id, or VideoId.

Extra optional columns supported are ModerationStatus, SearchTerms, and TextFormat. All columns support the '=' operator.

Order is supported for CommentThreads. Relevance are the supported order columns.

SELECT * FROM CommentThreads WHERE VideoId = 'abcdef123456' ORDER BY Relevance DESC LIMIT 10

Note: Ordering is not supported for use in conjunction with the Id parameter.

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the comment thread.
ChannelId	String				The YouTube channel that is associated with the comments in the thread. The VideoId column identifies the video. If the comments are about a video, then the value identifies the channel that uploaded the video. If the comments refer to the channel itself, the VideoId column will not have a value.
VideoId	String				The Id of the video that the comments refer to, if any. If this column is not present or does not have a value, then the thread applies to the channel and not to a specific video.
TopCommentId	String				The Id of the top-level comment of the thread.
PublishedAt	Datetime				The publish date of the top-level comment of the thread.
UpdatedAt	Datetime				The last update date of the top-level comment of the thread.
TopCommentChannelId	String				The Id of the channel associated with the top-level comment of the thread.
TopCommentVideoId	String				The Id of the video associated with the top-level comment of the thread.
TopCommentTextDisplay	String				The display text of the top-level comment of the thread.
TopCommentTextOriginal	String				The original text of the top-level comment of the thread.
TopCommentParentId	String				The Id of the parent of the top-level comment of the thread.
TopCommentAuthorDisplayName	String				The display name of the author of the top-level comment of the thread.
TopCommentAuthorChannelIdValue	String				The Id of the channel of the author of the top-level comment of the thread.
TopCommentCanRate	Boolean				Whether the current user can rate the top-level comment of the thread.
TopCommentViewerRating	String				The viewer rating of the top-level comment of the thread.
TopCommentLikeCount	Integer				The like count of the top-level comment of the thread.
TopCommentModerationStatus	String				The moderation status of the top-level comment of the thread.
CanReply	Boolean				This setting indicates whether the current viewer can reply to the thread.
TotalReplyCount	Integer				The total number of replies that have been submitted in response to the top-level comment.
IsPublic	Boolean				This setting indicates whether the thread, including all of its comments and comment replies, is visible to all YouTube users.
CommentsAggregate	String				A list of one or more replies to the top-level comment.

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
AllThreadsRelatedToChannelId	String	Instructs the API to return all comment threads associated with the specified channel.
ModerationStatus	String	Set this parameter to limit the returned comment threads to a particular moderation state.
TextFormat	String	Set the value of this parameter to HTML or plainText.

Query YouTubeAnalytics Demographics grouped by age groups and gender.

Table Specific Information

Select

Aggregate viewing statistics for videos based on viewers' age group and gender:

SELECT * FROM Demographics

Trim down Demographics for just one Video:

SELECT * FROM Demographics WHERE Video = 'video_Id'

Aggregate viewing statistics for playlists based on viewers' age group and gender:

SELECT * FROM Demographics WHERE IsCurated = true

Select Rules

You can use the following tables to build other queries to Top Videos.

Demographics for videos:

Dimensions	Use 1 or more	ageGroup,gender,video
	Use 0 or more	creatorContentType,liveOrOnDemand,subscribedStatus,youtubeProduct
Metrics	Use 1 or more	viewerPercentage
Filter	Use 0 or one	country,province,continent,subContinent
	Use 0 or one	video,group
	Use 0 or more	liveOrOnDemand,subscribedStatus,youtubeProduct

Demographics for playlists:

Dimensions	Use 1 or more	ageGroup,gender
	Use 0 or more	subscribedStatus,youtubeProduct
Metrics	Required	viewerPercentage
Filter	Required	isCurated=true
	Use 0 or one	country,province,continent,subContinent
	Use 0 or one	video,group
	Use 0 or more	subscribedStatus,youtubeProduct

Demographics for content owners:

Dimensions	Use 1 or more	ageGroup,gender
	Use 0 or more	creatorContentType,liveOrOnDemand,subscribedStatus,youtubeProduct
Metrics	Use 1 or more	viewerPercentage
Filter	Use exactly one	video,channel,group
	Use 0 or one	country,province,continent,subContinent
	Use 0 or more	liveOrOnDemand,subscribedStatus,youtubeProduct

Demographics for content owner playlists:

Dimensions	Use 1 or more	ageGroup,gender
	Use 0 or more	subscribedStatus,youtubeProduct
Metrics	Required	viewerPercentage
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
Video	String	True		False	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			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.
Province	String	True			The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
Continent	String	True			(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.
SubContinent	String	True			(filter only) A U.N. statistical region code that identifies a geographical subregion.
LiveOrOnDemand	String	True			This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND.
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 and 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.
AgeGroup	String	True		True	This dimension identifies the age group of the logged-in users associated with the report data. The allowed values are age13-17, age18-24, age25-34, age35-44, age45-54, age55-64, age65-
Gender	String	True		False	This dimension identifies the gender of the logged-in users associated with the query. The allowed values are female, male and user_specified.
ViewerPercentage	Double	False	True		The percentage of viewers who were logged in when watching the video or playlist. The viewerPercentage values in this report are not normalized for different values or combinations of values for playback detail dimensions (subscribedStatus and youtubeProduct). For example, a report that uses the subscribedStatus dimension returns viewerPercentage data adding up to 100 percent for subscribed views and viewerPercentage data adding up to 100 percent for unsubscribed views. (The total value of all viewerPercentage fields in the report is 200 percent.) You can use filters to ensure that the report only contains viewerPercentage data for one value (or combination of values) for playback detail dimensions.
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.

Query YouTubeAnalytics Devices or Operating System statistics. This table allows you to aggregate viewing statistics based on the manner in which viewers reached your video content. For example, you can identify the number of views that occurred on mobile devices or game consoles.

Table Specific Information

Select

By default, grouping is done by Device Type:

SELECT * FROM Devices

However, you can group views by other dimensions such as Operating System:

SELECT OperatingSystem, Views, EstimatedMinutesWatched FROM Devices

Notice that you cannot mix both Device Type and Operating System in the same query due to limitations in the YouTube Analytics API.

Select Rules

You can use the following tables to build other queries to Devices:

Devices for videos:

Dimensions	Use exactly one	deviceType,operatingSystem
	Use 0 or more	creatorContentType,day,liveOrOnDemand,subscribedStatus,youtubeProduct
Metrics	Use 1 or more	views,estimatedMinutesWatched
Filter	Use 0 or one	country,province,continent,subContinent
	Use 0 or one	video,group
	Use 0 or more	operatingSystem,liveOrOnDemand,subscribedStatus,youtubeProduct

Device data for playlists:

Dimensions	Use exactly one	deviceType,operatingSystem
	Use 0 or more	day,subscribedStatus,youtubeProduct
Metrics	Use 1 or more	views,estimatedMinutesWatched,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	operatingSystem,subscribedStatus,youtubeProduct

Device data for content owners:

Dimensions	Required	deviceType
	Use 0 or more	creatorContentType,day,liveOrOnDemand,subscribedStatus,youtubeProduct
Metrics	Use 1 or more	views,estimatedMinutesWatched
Filter	Use exactly one	video,channel,group
	Use 0 or one	country,province,continent,subContinent
	Use 0 or more	operatingSystem,liveOrOnDemand,subscribedStatus,youtubeProduct

Device data for content owner playlists:

Dimensions	Required	deviceType
	Use 0 or more	day,subscribedStatus,youtubeProduct
Metrics	Use 1 or more	views,estimatedMinutesWatched,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist
Filters	Required	isCurated=true
	Use 0 or one	country,province,continent,subContinent
	Use 0 or one	playlist,channel,group
	Use 0 or more	operatingSystem,subscribedStatus,youtubeProduct

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Video	String	True			The Id of a YouTube video.
Group	String	True			(filter only) The Id of a YouTube Analytics group.
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.
Playlist	String	True			The Id of a YouTube playlist.
Country	String	True			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.
Province	String	True			The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
Continent	String	True			(filter only) A United Nations (U.N.) statistical region code: 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.
Day	String	True			When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day.
LiveOrOnDemand	String	True			This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND.
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.
DeviceType	String	True		True	This dimension identifies the physical form factor of the device on which the view occurred. The allowed values are DESKTOP, GAME_CONSOLE, MOBILE, TABLET, TV, UNKNOWN_PLATFORM.
OperatingSystem	String	True		False	This dimension identifies the software system of the device on which the view occurred. The allowed values are ANDROID, BADA, BLACKBERRY, DOCOMO, HIPTOP, IOS, LINUX, MACINTOSH, MEEGO, NINTENDO_3DS, OTHER, PLAYSTATION, PLAYSTATION_VITA, SMART_TV, SYMBIAN, WEBOS.
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 the 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 the 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.
EstimatedMinutesWatched	Double	False	True		The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
PlaylistStarts	Double	False	False		The number of times that viewers initiated playback of a playlist.
ViewsPerPlaylistStart	Double	False	False		The average number of video views that occurred each time a playlist was initiated.
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.
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.

Query Engagement Reports info. For example, how many times a user shared a video.

Table Specific Information

Select

By default, results are grouped by Day. The following query returns Comments, Likes, Dislikes, etc., grouped by Day:

SELECT * FROM EngagementReports

Select Rules

The following query returns how frequently the channel's videos were shared on different social platforms:

SELECT SharingService, Shares FROM EngagementReports

You can use the following tables to build other queries to Engagement Reports:

Engagement Reports for videos:

Dimensions	Required	sharingService
	Optional	creatorContentType,subscribedStatus
Metrics	Use 1 or more	shares
Filter	Use 0 or one	country,continent,subContinent
	Use 0 or one	video,group
	Optional	subscribedStatus

Engagement Reports for content owners:

Dimensions	Required	sharingService
	Optional	creatorContentType,subscribedStatus
Metrics	Use 1 or more	shares
Filter	Use exactly one	video,channel,group
	Use 0 or one	country,continent,subContinent
	Optional	subscribedStatus

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
SharingService	String	True			This dimension identifies the service that was used to share videos. Videos can be shared on YouTube (or via the YouTube player) using the Share button.
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.
Group	String	True			(filter only) The Id of a YouTube Analytics group.
Country	String	True			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: 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. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs.
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.
Shares	Double	False	True		The number of times that users shared a video through the Share button.
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.

Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language.

Table Specific Information

Select

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the i18n language.
Language	String				A BCP-47 code that uniquely identifies a language.
Name	String				The name of the language as it is written in that language.

Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList.

Table Specific Information

Select

You must specify exactly one of the following columns in the WHERE clause: Id or PlayListId. Extra optional columns supported are OnBehalfOfContentOwner and VideoId.

All columns support the '=' operator.

SELECT * FROM PlaylistItems WHERE PlaylistId = 'abcdef123456'

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the playlist item.
PublishedAt	Datetime				The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId	String				The Id that YouTube uses to uniquely identify the user that added the item to the playlist.
Title	String				The title of the item.
Description	String				The description of the item.
ThumbnailsDefaultUrl	String				The URL of the item.
ChannelTitle	String				The channel title of the channel that the playlist item belongs to.
VideoOwnerChannelTitle	String				The channel title of the channel that uploaded this video.
VideoOwnerChannelId	String				The channel ID of the channel that uploaded this video.
PlaylistId	String				The Id that YouTube uses to uniquely identify the playlist that the playlist item is in.
Position	String				The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
ResourceIdKind	String				The kind, or type, of the referred resource.
ResourceIdVideoId	String				If the ResourceIdKind value of the column is youtube#video, then this column will be present and its value will contain the Id that YouTube uses to uniquely identify the video in the playlist.
VideoId	String				The Id that YouTube uses to uniquely identify a video. To retrieve the video resource, set the Id column to this value.
Note	String				A user-generated note for this item.
VideoOwnerPublishedAt	Datetime				The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
PrivacyStatus	String				The privacy status of the playlist item.

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
OnBehalfOfContentOwner	String	This parameter is intended exclusively for YouTube content partners.

Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users.

Table Specific Information

Select

By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube Analytics if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

By default, if no filters are specified, the CData Sync App will return all playlists for the channel owned by authenticated user.

YouTube Analytics allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are PublishedAt, Language, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel.

A search against all channels in YouTube Analytics may be triggered by specifying one or more of SearchTerms, ForContentOwner, Region, SafeSearch, Rating and Rating to search all playlists.

All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='.

Order by is supported for the Rating, Relevance, and Title columns.

SELECT * FROM PlayLists WHERE Id = 'abcdef123456'

SELECT title FROM PlayLists WHERE PublishedAt >= '2016-01-01' ORDER BY Title LIMIT 10

Note: Ordering is not supported when specifying one of the colums used for searching playlists such as SearchTerms.

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the playlist.
PublishedAt	Datetime				The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId	String				The Id that YouTube uses to uniquely identify the channel that published the playlist.
Title	String				The title of the playlist.
Description	String				The description of the playlist.
ThumbnailsDefaultUrl	String				The URL of the image.
ChannelTitle	String				Channel title of the channel that the video belongs to.
DefaultLanguage	String				This column is confidential to trusted testers. The language of the text in the Title and Description columns.
LocalizedTitle	String				This column is confidential to trusted testers. The localized playlist title.
LocalizedDescription	String				This column is confidential to trusted testers. The localized playlist description.
PrivacyStatus	String				The privacy status of the playlist. Valid values for this column: private, public, unlisted.
VideoCount	Integer				The number of videos in the playlist.
EmbedHtml	String				An iframe tag that embeds a player that will play the playlist.
SearchTerms	String				The SearchTerms parameter specifies the query term to search for.

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
Language	String	A value of hl instructs the API to retrieve localized resource metadata for a specific application language that the YouTube supports.
OnBehalfOfContentOwner	String	This parameter is intended exclusively for YouTube content partners.
OnBehalfOfContentOwnerChannel	String	Specifies the YouTube channel Id of the channel to which a video is being added.
ForContentOwner	String	Restricts the search to only retrieve playlists owned by the content owner specified by the OnBehalfOfContentOwner column.
Region	String	Instructs the API to return search results for the specified country.
SafeSearch	String	Indicates whether the search results should include restricted content as well as standard content. Valid values: moderate, none, or strict.
Rating	String	Specifies that playlists are sorted from highest to lowest rating.

Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale.

Table Specific Information

Select

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the i18n region.
Country	String				The two-letter ISO country code that identifies the region.
Name	String				The name of the region.

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
Language	String	The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US.

Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video.

Table Specific Information

Select

You can specify exactly one of the following columns: ChannelId, Id, MyRecentSubscribers, or MySubscribers.

Extra optional columns supported are ForChannelId, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel. All columns support the '=' operator.

Order is supported for Subscriptions. 'Alphabetical', 'Relevance', and 'Unread' are the supported order columns.

By default, if no filters are specified, the driver will return a list of channels subscribed by authenticated user.

SELECT Title FROM Subscriptions WHERE ChannelId = 'abc123' ORDER BY Unread DESC

The default value is SUBSCRIPTION_ORDER_RELEVANCE.

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the subscription.
PublishedAt	Datetime				The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelTitle	String				The title of the channel that the subscription belongs to.
Title	String				The title of the subscription.
Description	String				The details of the subscription.
ResourceIdKind	String				The type of the API resource.
ResourceIdChannelId	String				The value that YouTube uses to uniquely identify the channel that the user subscribed to.
ChannelId	String				The Id that YouTube uses to uniquely identify the channel of the subscriber.
ThumbnailsDefaultUrl	String				The URL of the default image.
TotalItemCount	Integer				The approximate number of items that the subscription points to.
NewItemCount	Integer				The number of new items in the subscription since its content was last read.
ActivityType	String				The type of activity this subscription is for. Valid values: all, uploads.
SubscriberTitle	String				The title of the channel of the subscriber.
SubscriberDescription	String				The description of the channel of the subscriber.
SubscriberChannelId	String				The Id that YouTube assigns to uniquely identify the channel of the subscriber.
SubscriberThumbnailsDefaultUrl	String				The URL of the default image.

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
MySubscribers	String	Set this value of this parameter to true to retrieve a feed of the subscribers of the authenticated user.
ForChannelId	String	The ForChannelId column specifies a comma-separated list of channel Ids.
OnBehalfOfContentOwner	String	This column is intended exclusively for YouTube content partners.
OnBehalfOfContentOwnerChannel	String	Specifies the YouTube ChannelId of the channel to which a video is being added.
Alphabetical	String	Sort alphabetically
Relevance	String	Sort by relevance.
Unread	String	Sort by order of activity.

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
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.
Group	String	True			(filter only) The Id of a YouTube Analytics group.
Playlist	String	True			The Id of a YouTube playlist.
Country	String	True			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.
Province	String	True			The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
Continent	String	True			(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	True			(filter only) A U.N. statistical region code that identifies a geographical subregion.
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.
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.
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. Possible values are SUBSCRIBED and 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.
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.
ViewerPercentage	Double	False	False		The percentage of viewers who were logged in when watching the video or playlist.
EstimatedMinutesWatched	Double	False	True		The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
AverageViewDuration	Double	False	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.
AverageViewPercentage	Double	False	True		The average percentage of a video watched during a video playback.
Comments	Double	False	True		The number of times that users commented on a video.
Likes	Double	False	True		The number of times that users indicated that they liked a video by giving it a positive rating.
Dislikes	Double	False	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.
Shares	Double	False	True		The number of times that users shared a video through the Share button.
SubscribersGained	Double	False	True		The number of times that users subscribed to a channel or video.
SubscribersLost	Double	False	True		The number of times that users unsubscribed from a channel or video.
VideosAddedToPlaylists	Double	False	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	False	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.
PlaylistStarts	Double	False	False		The number of times that viewers initiated playback of a playlist.
ViewsPerPlaylistStart	Double	False	False		The average number of video views that occurred each time a playlist was initiated.
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.
AnnotationImpressions	Double	False	True		The total number of annotation impressions.
AnnotationClickableImpressions	Double	False	True		The number of annotations that appeared and could be clicked.
AnnotationClicks	Double	False	True		The number of clicked annotations.
AnnotationClickThroughRate	Double	False	True		The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationClosableImpressions	Double	False	True		The number of annotations that appeared and could be closed.
AnnotationCloses	Double	False	True		The number of closed annotations.
AnnotationCloseRate	Double	False	True		The ratio of annotations that viewers closed to the total number of annotation impressions.
EstimatedRevenue	Decimal	False	False		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	False	False		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.
EstimatedRedPartnerRevenue	Decimal	False	False		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.
GrossRevenue	Decimal	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 earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
Cpm	Decimal	False	False		The estimated gross revenue per thousand ad impressions.
AdImpressions	Double	False	False		The number of verified ad impressions served.
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	Decimal	False	False		The estimated gross revenue per thousand playbacks.
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.

Query the TopVideos for a channel or the TopPlaylists if you are a content owner. You can also use this view to query playback detail and geographic filters.

Table Specific Information

Select

The following query returns a channel's top videos:

SELECT * FROM TopVideos

The following query returns a channel's top videos by most minutes watched in a specific country:

SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country = 'US'

The following query returns a channel's top playlists by most minutes watched:

SELECT Playlist, Views, EstimatedMinutesWatched, PlaylistStarts, AverageViewDuration FROM TopVideos WHERE IsCurated = true

Select Rules

You can use the following tables to build other queries to Top Videos:

Top Videos for videos:

Dimensions	Required	video
	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
Filter	Use 0 or one	country,continent,subContinent
Sort	Use 0 or more (only descending order)	views,estimatedMinutesWatched,subscribersGained,subscribersLost

Top Videos for playlists:

Dimensions	Required	playlist
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 more	playlist,subscribedStatus,youtubeProduct
Sort	Use 0 or more (only descending order)	views,estimatedMinutesWatched,playlistStarts

Top Videos for content owners:

Dimensions	Required	video
	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,earnings,adEarnings,grossRevenue,redPartnerRevenue,monetizedPlaybacks,playbackBasedCpm,impressions,impressionBasedCpm
Filter	Use exactly one	channel
	Use 0 or one	country,continent,subContinent
Sort	Use 0 or more (only descending order)	views,earnings,redPartnerRevenue,estimatedMinutesWatched,subscribersGained,subscribersLost

Top Videos for content owner playlists:

Dimensions	Required	playlist
Metrics	Use 1 or more	views,estimatedMinutesWatched,averageViewDuration,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist
Filter	Required	isCurated=true
	Use 0 or one	playlist,channel
	Use 0 or one	country,province,continent,subContinent
	Use 0 or more	subscribedStatus,youtubeProduct
Sort	Use 0 or more (only descending order)	views,estimatedMinutesWatched,playlistStarts

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		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			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.
Province	String	True			The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
Continent	String	True			(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	True			(filter only) A U.N. statistical region code that identifies a geographical subregion.
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.
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. Possible values are SUBSCRIBED and 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.
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.
EstimatedMinutesWatched	Double	False	True		The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
AverageViewDuration	Double	False	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.
AverageViewPercentage	Double	False	False		The average percentage of a video watched during a video playback.
PlaylistStarts	Double	False	False		The number of times that viewers initiated playback of a playlist.
Likes	Double	False	False		The number of times that users indicated that they liked a video by giving it a positive rating.
ViewerPercentage	Double	False	False		The percentage of viewers who were logged in when watching the video or playlist.
Comments	Double	False	True		The number of times that users commented on a video.
Dislikes	Double	False	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.
Shares	Double	False	True		The number of times that users shared a video through the Share button.
SubscribersGained	Double	False	True		The number of times that users subscribed to a channel or video.
SubscribersLost	Double	False	True		The number of times that users unsubscribed from a channel or video.
VideosAddedToPlaylists	Double	False	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	False	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.
ViewsPerPlaylistStart	Double	False	False		The average number of video views that occurred each time a playlist was initiated.
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.
AnnotationImpressions	Double	False	True		The total number of annotation impressions.
AnnotationClickableImpressions	Double	False	True		The number of annotations that appeared and could be clicked.
AnnotationClicks	Double	False	True		The number of clicked annotations.
AnnotationClickThroughRate	Double	False	True		The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationClosableImpressions	Double	False	True		The number of annotations that appeared and could be closed.
AnnotationCloses	Double	False	True		The number of closed annotations.
AnnotationCloseRate	Double	False	True		The ratio of annotations that viewers closed to the total number of annotation impressions.
EstimatedRevenue	Decimal	False	False		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	False	False		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.
EstimatedRedPartnerRevenue	Decimal	False	False		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.
GrossRevenue	Decimal	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 earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
Cpm	Decimal	False	False		The estimated gross revenue per thousand ad impressions.
AdImpressions	Double	False	False		The number of verified ad impressions served.
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	Decimal	False	False		The estimated gross revenue per thousand playbacks.
StartDate	Date				Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
EndDate	Date				End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).

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.

Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content.

Table Specific Information

Select

The following query aggregates viewing statistics based on the manner in which viewers reached your video content; for example, to identify the number of views that stemmed from a Google search or from a link to a related video.

SELECT * FROM TrafficSources

The following query displays the Views and EstimatedMinutesWatched metrics grouped by the Day and InsightTrafficSourceType dimensions:

SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources

The following query filters the statistics to be compiled for a specific Video and Country:

SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources WHERE Video = 'video_id' AND Country = 'US'

The following query aggregates viewing statistics based on the manner in which viewers reached your playlist content; for example, to identify the number of views that stemmed from a Google search.

SELECT InsightTrafficSourceType, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated = true

The following query returns search terms that generated the most views from YouTube search results for videos located in playlists. Notice that ordering and limiting are required for such a query due to restrictions in the YouTube Analytics API.

SELECT InsightTrafficSourceDetail, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated = true AND InsightTrafficSourceType = 'YT_SEARCH' ORDER BY Views DESC LIMIT 25

Select Rules

You can use the following tables to build other queries to Traffic Sources:

Traffic Sources for videos:

Dimensions	Use exactly one	insightTrafficSourceType,insightTrafficSourceDetail
	Use 0 or more	creatorContentType,day,liveOrOnDemand,subscribedStatus
Metrics	Use 1 or more	views,estimatedMinutesWatched
Filter	Use 0 or one	country,province,continent,subContinent
	Use 0 or one	video,group
	Use 0 or more	liveOrOnDemand,subscribedStatus
Sort	Use 0 or more(only descending order)	views,estimatedMinutesWatched

Traffic Sources for playlists:

Dimensions	Use exactly one	insightTrafficSourceType,insightTrafficSourceDetail
	Use 0 or more	day,subscribedStatus
Metrics	Use 1 or more	views,estimatedMinutesWatched,playlistStarts,viewsPerPlaylistStart,averageTimeInPlaylist
Filter	Required	isCurated=true
	Use 0 or one	country,province,continent,subContinent
	Use 0 or one	playlist,channel,group
	Optional	subscribedStatus
Sort	Use 0 or more(only descending order)	views,estimatedMinutesWatched,playlistStarts

Traffic Sources for content owners:

Dimensions	Required	insightTrafficSourceType
	Use 0 or more	creatorContentType,day,liveOrOnDemand,subscribedStatus
Metrics	Use 1 or more	views,estimatedMinutesWatched
Filter	Use exactly one	video,channel,group
	Use 0 or one	country,province,continent,subContinent
	Use 0 or more	liveOrOnDemand,subscribedStatus

Traffic Sources for content owner playlists:

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

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			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.
Province	String	True			The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
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.
Day	String	True			When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day.
LiveOrOnDemand	String	True			This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ONDEMAND.
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.
InsightTrafficSourceType	String	True		True	Data in the report is aggregated based on the referrer type, which describes the manner in which users reached the video. The allowed values are ADVERTISING, ANNOTATION, EXT_URL, NO_LINK_EMBEDDED, NO_LINK_OTHER, NOTIFICATION, PLAYLIST, PROMOTED, RELATED_VIDEO, SUBSCRIBER, YT_CHANNEL, YT_OTHER_PAGE, YT_SEARCH.
InsightTrafficSourceDetail	String	True			Details about the InsightTrafficSourceType.
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.
EstimatedMinutesWatched	Double	False	True		The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
PlaylistStarts	Double	False	False		The number of times that viewers initiated playback of a playlist.
ViewsPerPlaylistStart	Double	False	False		The average number of video views that occurred each time a playlist was initiated.
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.
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.

This report provides user activity statistics, sorted by city.

Table Specific Information

Select Rules

Querying user activity by city requires you to set maxResults to an integer value of 250 or less. You must also specify a value for the sort request parameter.

Video Reports:

Dimensions	Required	city
	Use 0 or more	creatorContentType, country, province, subscribedStatus Note: If you include the province dimension, you must also use the country==US filter.
	Use 0 or 1	day, month
Metrics	Use 1 or more	views, estimatedMinutesWatched, averageViewDuration, averageViewPercentage
Filters	Use 0 or 1	country, province, continent, subContinent
	Use 0 or 1	video, group
Sorting options:	-views
	-estimatedMinutesWatched

Content Owner Reports:

Dimensions	Required	city
	Use 0 or more	creatorContentType,country,province, subscribedStatus Note: If you include the province dimension, you must also use the country==US filter.
	Use 0 or 1	day,month
Metrics	Use 1 or more	views, estimatedMinutesWatched, averageViewDuration, averageViewPercentage
Filters	Use exactly 1	video, channel, group, or a supported combination of uploaderType and claimedStatus
	Use 0 or 1	country, province, continent, subContinent
Sorting options	-views
	-estimatedMinutesWatched

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.
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.
City	String	True		True	The estimated city associated with the metrics in the report row. Data for this dimension is available for dates beginning January 1, 2022.
Province	String	True		False	The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
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.
Day	String	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.
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.
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.
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.
EstimatedMinutesWatched	Double	False	False		The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
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. As of December 13, 2021, this metric excludes looping clips traffic.
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.

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.

This report provides user activity statistics, sorted by province (includes Washington DC).

Table Specific Information

Select Rules

User activity by province applies to U.S. states and the District of Columbia. Province requires you to set the filters parameter value to country==US.

Video Reports:

Dimensions	Required	province
	Optional	creatorContentType
Metrics	Use 1 or more	views, redViews, estimatedMinutesWatched, estimatedRedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, cardClickRate, cardTeaserClickRate, cardImpressions, cardTeaserImpressions, cardClicks, cardTeaserClicks
Filters	Required	country==US
	Use 0 or 1	video, group

Playlist Reports:

This report provides playlist activity statistics for US states and Washington DC. For this report you must include country==US in the filters parameter value.

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

Content Owner Reports:

Dimensions	Required	province
	Optional	creatorContentType
Metrics	Use 1 or more	views, redViews, estimatedMinutesWatched, estimatedRedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, cardClickRate, cardTeaserClickRate, cardImpressions, cardTeaserImpressions, cardClicks, cardTeaserClicks
Filters	Use exactly 1	video, channel, group, or a supported combination of uploaderType and claimedStatus
	Required	country==US

Content Owner Playlist Reports:

Dimensions	Required	province
	Use 0 or more	subscribedStatus,estimatedMinutesWatched, estimatedRedMinutesWatched, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist
Filters	Required	isCurated==1;country==US
	Use 0 or 1	playlist, channel, group
	Use 0 or more	subscribedStatus, youtubeProduct

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.
Province	String	True			The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
Country	String	True			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.
CreatorContentType	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.
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.
EstimatedMinutesWatched	Double	False	True		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.
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.

Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content.

Table Specific Information

Select

There are no required filters for this table. An optional column is Language.

The '=' operator is supported for this column.

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to identify the reason.
Label	String				The label text for the reason.
SecondaryReasonsAggregate	String				A list of secondary reasons associated with the reason, if any available. There might be 0 or more.

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
Language	String	The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US.

Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos.

Table Specific Information

Select

You can specify exactly one of the following columns: Id or Region. If you do not specify any filtering criteria, by default you will get results for the US Region. An extra optional parameter is Language.

SELECT * FROM VideoCategories WHERE Region = 'JP'

The IN operator can be used to filter on multiple Ids:

SELECT Id, Kind, Etag, ChannelId, Title, Assignable
FROM   VideoCategories
WHERE  (ID IN ('1', '2', '10'))

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The unique identifier for the video category.
ChannelId	String				The YouTube channel that created the video category.
Title	String				The title of the video category.
Assignable	Boolean				Indicates whether videos can be associated with the category.
Region	String				The country from which to retrieve video categories.

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
Language	String	Specifies the language that should be used for text values in the API response. The default value is en_US.

Query YouTube Videos.

Table Specific Information

Select

By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube Analytics if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

By default, if no filters are specified, the driver will return all videos owned by the authenticated user.

Only one of the following columns may be filtered by at a time: Id, MyRating, ChannelId, or Chart. Extra columns supported are ForMine, Language, ForContentOwner, OnBehalfOfContentOwner.

A search against all videos on Youtube may be executed by specifying SearchTerms, RelatedToVideoId, VideoDuration, VideoCategoryId, or Region.

All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='. Id and ChannelId supports IN.

Order by is supported for the Date, Rating, Relevance and Title columns.

SELECT * FROM Videos WHERE Id = '12345679'

SELECT * FROM Videos WHERE PublishedAt >= '2016-01-01T20:30:00Z' LIMIT 10

SELECT Description FROM Videos WHERE ForMine = True ORDER BY Date

Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.

The IN operator can be used to specify a list of channels. This call returns a list of videos for each specified channel.

SELECT * FROM Videos WHERE ChannelId IN (a, b, c)
SELECT * FROM Videos WHERE ChannelId IN (SELECT Id FROM Channels)

IN operator can also be used for getting data for multiple videos.

SELECT * FROM Videos WHERE Id IN (a, b, c)

Columns

Name	Type	Dimension	DefaultMetric	DefaultDimension	Description
Id [KEY]	String				The Id that YouTube uses to uniquely identify the video.
ChannelId	String				The Id that YouTube uses to uniquely identify the channel that the video was uploaded to.
CategoryId	String				The YouTube video category associated with the video.
Title	String				The title of the video.
ChannelTitle	String				Channel title for the channel that the video belongs to.
PublishedAt	Datetime				The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Description	String				The description of the video.
Duration	String				The length of the video. The property value is an ISO 8601 duration.
ViewCount	Long				The number of times the video has been viewed.
LikeCount	Long				The number of users who have indicated that they liked the video.
DislikeCount	Long				The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner.
CommentCount	Long				The number of comments for the video.
EmbedHtml	String				An iframe tag that embeds a player that will play the video.
PublicStatsViewable	Boolean				This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false.
TagsAggregate	String				A list of keyword tags associated with the video.
LiveBroadcastContent	String				Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming.
Dimension	String				Indicates whether the video is available in 3D or in 2D.
Definition	String				Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd.
Caption	String				Indicates whether captions are available for the video. Valid values for this column: false, true.
LicensedContent	Boolean				Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner.
AllowedAggregate	String				A list of region codes that identify countries where the video is viewable.
BlockedAggregate	String				A list of region codes that identify countries where the video is blocked.
Projection	String				Specifies the projection format of the video. Valid values: 360, rectangular.
PrivacyStatus	String				The privacy status of the playlist. Valid values: private, public, unlisted.
MadeForKids	Boolean				This value indicates whether the video is Made For Kids.
License	String				The license. Valid values: creativeCommon, youtube.
Embeddable	Boolean				This value indicates whether the video can be embedded on another website.
ThumbnailsDefaultUrl	String				The URL of the default image.
DefaultLanguage	String				This column is confidential to trusted testers. The language of the text in the Title and Description columns.
DefaultAudioLanguage	String				The default_audio_language column specifies the language spoken in the default audio track of the video.
UploadStatus	String				The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded.
FailureReason	String				This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
RejectionReason	String				This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.
RecordingDate	Datetime				The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
SearchTerms	String				The query term to search for.

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
SafeSearch	String	Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
EventType	String	The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING. The allowed values are COMPLETED, LIVE, UPCOMING.
RelatedToVideoId	String	Retrieves a list of videos that are related to the video that the column value identifies.
VideoDuration	String	Filters video search results based on their duration. Acceptable values: any, long, medium or short.
VideoCategoryId	String	The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
Region	String	Instructs the API to select a video chart available in the specified region. This column can only be used in conjunction with the chart column. The parameter value is an ISO 3166-1 alpha-2 country code.
ForMine	String	Restricts the search to only retrieve videos owned by the authenticated user. It is false by default.
Chart	String	The chart parameter identifies the chart that you want to retrieve. Acceptable values are: mostPopular - Return the most popular videos for the specified content region and video category. The allowed values are mostPopular.
MyRating	String	The rating of the authenticated user. Acceptable values: like or dislike. The allowed values are like, dislike.
Language	String	Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ForContentOwner	String	Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter.
OnBehalfOfContentOwner	String	This parameter is intended exclusively for YouTube content partners.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to YouTube Analytics.
ChannelId	The Id of a channel belonging to the authenticated user.
ContentOwnerId	The Id of the copyright holder for content in YouTube's rights management system.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
DefaultFilter	A default filter to be applied to all queries.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.