FireDAC Components for YouTube Analytics

Build 22.0.8462

TimeBasedReports

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

Table-Specific Information

Select Rules

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

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

Timebased Reports for playlist rules:

Dimensions Use exactly one day, month
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
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.
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.

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