Cmdlets for YouTube Analytics

Build 21.0.7930

PlayLists

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 Cmdlets PowerShell Module for YouTube Analytics 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.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930