Cmdlets for YouTube Analytics

Build 21.0.7930

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.

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.

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