Cmdlets for YouTube Analytics

Build 24.0.9060

Channels

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.

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