docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/youtube_v3.commentThreads.html b/docs/dyn/youtube_v3.commentThreads.html
index 9d14cfb..4160fc4 100644
--- a/docs/dyn/youtube_v3.commentThreads.html
+++ b/docs/dyn/youtube_v3.commentThreads.html
@@ -75,10 +75,13 @@
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.commentThreads.html">commentThreads</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
- <code><a href="#list">list(part, searchTerms=None, maxResults=None, videoId=None, order=None, moderationStatus=None, allThreadsRelatedToChannelId=None, pageToken=None, id=None, channelId=None, textFormat=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, allThreadsRelatedToChannelId=None, maxResults=None, channelId=None, id=None, searchTerms=None, order=None, textFormat=None, moderationStatus=None, pageToken=None, videoId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -88,123 +91,83 @@
<p class="firstline">Updates an existing resource.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
<pre>Inserts a new resource into this collection.
Args:
- part: string, The <code><strong>part</strong></code> parameter identifies the properties
-that the API response will include. Set the parameter value to
-<code>snippet</code>. The <code>snippet</code> part has a quota cost of 2
-units. (required) (repeated)
+ part: string, The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. (required) (repeated)
body: object, The request body.
The object takes the form of:
-{ # A <code><strong>comment thread</strong></code> represents information that
- # applies to a top level comment and all its replies. It can also include the
- # top level comment itself and some of the replies.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
- "snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment
- # thread and also the top level comment.
- "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel
- # with the video the comments refer to. If video_id isn't set the comments
- # refer to the channel itself.
- "totalReplyCount": 42, # The total number of replies (not including the top level comment).
- "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a
- # channel discussion comment.
- "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer
- # specific - other viewers may see a different value for this field.
- "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all
- # YouTube users.
- "topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
+{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A *comment* represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
},
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- },
- "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if
- # any) to the top level comment found in the snippet.
- "comments": [ # A limited number of replies. Unless the number of replies returned equals
- # total_reply_count in the snippet the returned replies are only a subset
- # of the total number of replies.
- { # A <code><strong>comment</strong></code> represents a single YouTube comment.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
- "canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
- "authorChannelId": { # The id of the author's YouTube channel, if any.
- "value": "A String",
- },
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
- },
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ ],
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
},
- ],
+ },
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#commentThread"</code>.
- }
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -214,141 +177,101 @@
Returns:
An object of the form:
- { # A <code><strong>comment thread</strong></code> represents information that
- # applies to a top level comment and all its replies. It can also include the
- # top level comment itself and some of the replies.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
- "snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment
- # thread and also the top level comment.
- "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel
- # with the video the comments refer to. If video_id isn't set the comments
- # refer to the channel itself.
- "totalReplyCount": 42, # The total number of replies (not including the top level comment).
- "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a
- # channel discussion comment.
- "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer
- # specific - other viewers may see a different value for this field.
- "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all
- # YouTube users.
- "topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
+ { # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A *comment* represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
},
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- },
- "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if
- # any) to the top level comment found in the snippet.
- "comments": [ # A limited number of replies. Unless the number of replies returned equals
- # total_reply_count in the snippet the returned replies are only a subset
- # of the total number of replies.
- { # A <code><strong>comment</strong></code> represents a single YouTube comment.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
- "canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
- "authorChannelId": { # The id of the author's YouTube channel, if any.
- "value": "A String",
- },
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
- },
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ ],
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
},
- ],
+ },
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#commentThread"</code>.
- }</pre>
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part, searchTerms=None, maxResults=None, videoId=None, order=None, moderationStatus=None, allThreadsRelatedToChannelId=None, pageToken=None, id=None, channelId=None, textFormat=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, allThreadsRelatedToChannelId=None, maxResults=None, channelId=None, id=None, searchTerms=None, order=None, textFormat=None, moderationStatus=None, pageToken=None, videoId=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
- part: string, The <code><strong>part</strong></code> parameter specifies a
-comma-separated list of one or more <code>commentThread</code> resource
-properties that the API response will include. (required) (repeated)
- searchTerms: string, Limits the returned comment threads to those matching the specified
-key words. Not compatible with the 'id' filter.
- maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the
-maximum number of items that should be returned in the result set.
- videoId: string, Returns the comment threads of the specified video.
- order: string, A parameter
- moderationStatus: string, Limits the returned comment threads to those with the specified
-moderation status. Not compatible with the 'id' filter.
-Valid values: published, heldForReview, likelySpam.
- allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the
-channel comments as well.
- pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific
-page in the result set that should be returned. In an API response, the
-<code>nextPageToken</code> and <code>prevPageToken</code> properties
-identify other pages that could be retrieved.
+ part: string, The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. (required) (repeated)
+ allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the channel comments as well.
+ maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
+ channelId: string, Returns the comment threads for all the channel comments (ie does not include comments left on videos).
id: string, Returns the comment threads with the given IDs for Stubby or Apiary. (repeated)
- channelId: string, Returns the comment threads for all the channel comments (ie does not
-include comments left on videos).
+ searchTerms: string, Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.
+ order: string, A parameter
+ Allowed values
+ orderUnspecified -
+ time - Order by time.
+ relevance - Order by relevance.
textFormat: string, The requested text format for the returned comments.
+ Allowed values
+ textFormatUnspecified -
+ html - Returns the comments in HTML format. This is the default value.
+ plainText - Returns the comments in plain text format.
+ moderationStatus: string, Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.
+ Allowed values
+ published - The comment is available for public display.
+ heldForReview - The comment is awaiting review by a moderator.
+ likelySpam -
+ rejected - The comment is unfit for display.
+ pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
+ videoId: string, Returns the comment threads of the specified video.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -358,128 +281,83 @@
An object of the form:
{
- "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
- "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.
- # available and number of resources returned in a single page.
+ "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
+ "visitorId": "A String", # The visitorId identifies the visitor.
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
+ "etag": "A String", # Etag of this resource.
+ "kind": "youtube#commentThreadListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse".
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
"items": [ # A list of comment threads that match the request criteria.
- { # A <code><strong>comment thread</strong></code> represents information that
- # applies to a top level comment and all its replies. It can also include the
- # top level comment itself and some of the replies.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
- "snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment
- # thread and also the top level comment.
- "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel
- # with the video the comments refer to. If video_id isn't set the comments
- # refer to the channel itself.
- "totalReplyCount": 42, # The total number of replies (not including the top level comment).
- "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a
- # channel discussion comment.
- "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer
- # specific - other viewers may see a different value for this field.
- "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all
- # YouTube users.
- "topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
+ { # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A *comment* represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
},
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- },
- "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if
- # any) to the top level comment found in the snippet.
- "comments": [ # A limited number of replies. Unless the number of replies returned equals
- # total_reply_count in the snippet the returned replies are only a subset
- # of the total number of replies.
- { # A <code><strong>comment</strong></code> represents a single YouTube comment.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
- "canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
- "authorChannelId": { # The id of the author's YouTube channel, if any.
- "value": "A String",
- },
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
- },
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
- },
- ],
- },
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#commentThread"</code>.
+ ],
},
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
+ },
+ },
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
+ },
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ },
+ },
],
- "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
- # parameter to retrieve the next page in the result set.
- "etag": "A String", # Etag of this resource.
- "tokenPagination": { # Stub token pagination template to suppress results.
- },
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "kind": "youtube#commentThreadListResponse", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#commentThreadListResponse"</code>.
}</pre>
</div>
@@ -502,120 +380,74 @@
<pre>Updates an existing resource.
Args:
- part: string, The <code><strong>part</strong></code> parameter specifies a
-comma-separated list of <code>commentThread</code> resource properties that
-the API response will include. You must at least include the
-<code>snippet</code> part in the parameter value since that part contains
-all of the properties that the API request can update. (required) (repeated)
+ part: string, The *part* parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. (required) (repeated)
body: object, The request body.
The object takes the form of:
-{ # A <code><strong>comment thread</strong></code> represents information that
- # applies to a top level comment and all its replies. It can also include the
- # top level comment itself and some of the replies.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
- "snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment
- # thread and also the top level comment.
- "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel
- # with the video the comments refer to. If video_id isn't set the comments
- # refer to the channel itself.
- "totalReplyCount": 42, # The total number of replies (not including the top level comment).
- "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a
- # channel discussion comment.
- "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer
- # specific - other viewers may see a different value for this field.
- "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all
- # YouTube users.
- "topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
+{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A *comment* represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
},
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- },
- "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if
- # any) to the top level comment found in the snippet.
- "comments": [ # A limited number of replies. Unless the number of replies returned equals
- # total_reply_count in the snippet the returned replies are only a subset
- # of the total number of replies.
- { # A <code><strong>comment</strong></code> represents a single YouTube comment.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
- "canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
- "authorChannelId": { # The id of the author's YouTube channel, if any.
- "value": "A String",
- },
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
- },
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ ],
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
},
- ],
+ },
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#commentThread"</code>.
- }
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -625,112 +457,70 @@
Returns:
An object of the form:
- { # A <code><strong>comment thread</strong></code> represents information that
- # applies to a top level comment and all its replies. It can also include the
- # top level comment itself and some of the replies.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
- "snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment
- # thread and also the top level comment.
- "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel
- # with the video the comments refer to. If video_id isn't set the comments
- # refer to the channel itself.
- "totalReplyCount": 42, # The total number of replies (not including the top level comment).
- "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a
- # channel discussion comment.
- "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer
- # specific - other viewers may see a different value for this field.
- "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all
- # YouTube users.
- "topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
+ { # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
+ "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
+ "comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
+ { # A *comment* represents a single YouTube comment.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
"canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorChannelId": { # The id of the author's YouTube channel, if any.
"value": "A String",
},
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
},
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- },
- "replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if
- # any) to the top level comment found in the snippet.
- "comments": [ # A limited number of replies. Unless the number of replies returned equals
- # total_reply_count in the snippet the returned replies are only a subset
- # of the total number of replies.
- { # A <code><strong>comment</strong></code> represents a single YouTube comment.
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
- "snippet": { # Basic details about a comment, such as its author and text. # The <code>snippet</code> object contains basic details about the comment.
- "canRate": True or False, # Whether the current viewer can rate this comment.
- "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were
- # requested through the id filter.
- "authorChannelId": { # The id of the author's YouTube channel, if any.
- "value": "A String",
- },
- "authorDisplayName": "A String", # The name of the user who posted the comment.
- "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on
- # what has been requested. Even the plain text representation may differ
- # from the text originally posted in that it may replace video links with
- # video titles etc.
- "likeCount": 42, # The total number of likes this comment has received.
- "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this
- # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
- # This may change in the future.
- "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
- "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
- "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment
- # this is the channel the comment refers to. In case of a video comment
- # it's the video's channel.
- "updatedAt": "A String", # The date and time when was last updated . The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "publishedAt": "A String", # The date and time when the comment was orignally published. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "parentId": "A String", # The unique id of the parent comment, only set for replies.
- "videoId": "A String", # The ID of the video the comment refers to, if any.
- "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The
- # original text will only be returned if it is accessible to the viewer,
- # which is only guaranteed if the viewer is the comment's author.
- },
- "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#comment"</code>.
+ ],
+ },
+ "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.
+ "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
+ "canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
+ "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
+ "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
+ "videoId": "A String", # The ID of the video the comment refers to, if any.
+ "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
+ "canRate": True or False, # Whether the current viewer can rate this comment.
+ "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
+ "likeCount": 42, # The total number of likes this comment has received.
+ "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.
+ "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.
+ "viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
+ "textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
+ "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
+ "parentId": "A String", # The unique id of the parent comment, only set for replies.
+ "authorDisplayName": "A String", # The name of the user who posted the comment.
+ "textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
+ "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
+ "authorChannelId": { # The id of the author's YouTube channel, if any.
+ "value": "A String",
},
- ],
+ },
+ "etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the comment.
+ "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#commentThread"</code>.
- }</pre>
+ "totalReplyCount": 42, # The total number of replies (not including the top level comment).
+ "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
+ "channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.
+ "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
+ },
+ }</pre>
</div>
</body></html>
\ No newline at end of file