FireDAC Components for YouTube Analytics

Build 22.0.8462

TrafficSources

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 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 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.
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.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462