| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.commentThreads.html">commentThreads</a></h1> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Inserts a new resource into this collection.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 83 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(part, allThreadsRelatedToChannelId=None, channelId=None, id=None, maxResults=None, moderationStatus=None, order=None, pageToken=None, searchTerms=None, textFormat=None, videoId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 85 | <p class="firstline">Retrieves a list of resources, possibly filtered.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 96 | <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code> |
| 97 | <pre>Inserts a new resource into this collection. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 98 | |
| 99 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | 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) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | body: object, The request body. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 102 | The object takes the form of: |
| 103 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 104 | { # 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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 105 | "etag": "A String", # Etag of this resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 106 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 107 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 108 | "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. |
| 109 | "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. |
| 110 | { # A *comment* represents a single YouTube comment. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 111 | "etag": "A String", # Etag of this resource. |
| 112 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 113 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 114 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 115 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 116 | "value": "A String", |
| 117 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 118 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 119 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 120 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 121 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 122 | "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. |
| 123 | "likeCount": 42, # The total number of likes this comment has received. |
| 124 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 125 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 126 | "publishedAt": "A String", # The date and time when the comment was originally published. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 127 | "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. |
| 128 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 129 | "updatedAt": "A String", # The date and time when the comment was last updated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 130 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 131 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 132 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 133 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 134 | ], |
| 135 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 136 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 137 | "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. |
| 138 | "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. |
| 139 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 140 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 141 | "etag": "A String", # Etag of this resource. |
| 142 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 143 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 144 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 145 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 146 | "value": "A String", |
| 147 | }, |
| 148 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 149 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 150 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 151 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 152 | "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. |
| 153 | "likeCount": 42, # The total number of likes this comment has received. |
| 154 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 155 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 156 | "publishedAt": "A String", # The date and time when the comment was originally published. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 157 | "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. |
| 158 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 159 | "updatedAt": "A String", # The date and time when the comment was last updated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 160 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 161 | "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. |
| 162 | }, |
| 163 | }, |
| 164 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 165 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 166 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 167 | } |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 168 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 169 | x__xgafv: string, V1 error format. |
| 170 | Allowed values |
| 171 | 1 - v1 error format |
| 172 | 2 - v2 error format |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 173 | |
| 174 | Returns: |
| 175 | An object of the form: |
| 176 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 177 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 178 | "etag": "A String", # Etag of this resource. |
| 179 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 180 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| 181 | "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. |
| 182 | "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. |
| 183 | { # A *comment* represents a single YouTube comment. |
| 184 | "etag": "A String", # Etag of this resource. |
| 185 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 186 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 187 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 188 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 189 | "value": "A String", |
| 190 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 191 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 192 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 193 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 194 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 195 | "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. |
| 196 | "likeCount": 42, # The total number of likes this comment has received. |
| 197 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 198 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 199 | "publishedAt": "A String", # The date and time when the comment was originally published. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 200 | "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. |
| 201 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 202 | "updatedAt": "A String", # The date and time when the comment was last updated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 203 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 204 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 205 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 206 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 207 | ], |
| 208 | }, |
| 209 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 210 | "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. |
| 211 | "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. |
| 212 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 213 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 214 | "etag": "A String", # Etag of this resource. |
| 215 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 216 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 217 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 218 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 219 | "value": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 220 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 221 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 222 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 223 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 224 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 225 | "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. |
| 226 | "likeCount": 42, # The total number of likes this comment has received. |
| 227 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 228 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 229 | "publishedAt": "A String", # The date and time when the comment was originally published. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 230 | "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. |
| 231 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 232 | "updatedAt": "A String", # The date and time when the comment was last updated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 233 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 234 | "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. |
| 235 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 236 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 237 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 238 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 239 | }, |
| 240 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 241 | </div> |
| 242 | |
| 243 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 244 | <code class="details" id="list">list(part, allThreadsRelatedToChannelId=None, channelId=None, id=None, maxResults=None, moderationStatus=None, order=None, pageToken=None, searchTerms=None, textFormat=None, videoId=None, x__xgafv=None)</code> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 245 | <pre>Retrieves a list of resources, possibly filtered. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 246 | |
| 247 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 248 | 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) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 249 | allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the channel comments as well. |
| 250 | channelId: string, Returns the comment threads for all the channel comments (ie does not include comments left on videos). |
| 251 | id: string, Returns the comment threads with the given IDs for Stubby or Apiary. (repeated) |
| 252 | maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 253 | 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. |
| 254 | Allowed values |
| 255 | published - The comment is available for public display. |
| 256 | heldForReview - The comment is awaiting review by a moderator. |
| 257 | likelySpam - |
| 258 | rejected - The comment is unfit for display. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 259 | order: string, A parameter |
| 260 | Allowed values |
| 261 | orderUnspecified - |
| 262 | time - Order by time. |
| 263 | relevance - Order by relevance. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 264 | 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. |
| 265 | searchTerms: string, Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 266 | textFormat: string, The requested text format for the returned comments. |
| 267 | Allowed values |
| 268 | textFormatUnspecified - |
| 269 | html - Returns the comments in HTML format. This is the default value. |
| 270 | plainText - Returns the comments in plain text format. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 271 | videoId: string, Returns the comment threads of the specified video. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 272 | x__xgafv: string, V1 error format. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 273 | Allowed values |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 274 | 1 - v1 error format |
| 275 | 2 - v2 error format |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 276 | |
| 277 | Returns: |
| 278 | An object of the form: |
| 279 | |
| 280 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 281 | "etag": "A String", # Etag of this resource. |
| 282 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| 283 | "items": [ # A list of comment threads that match the request criteria. |
| 284 | { # 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. |
| 285 | "etag": "A String", # Etag of this resource. |
| 286 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 287 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| 288 | "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. |
| 289 | "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. |
| 290 | { # A *comment* represents a single YouTube comment. |
| 291 | "etag": "A String", # Etag of this resource. |
| 292 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 293 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 294 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 295 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 296 | "value": "A String", |
| 297 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 298 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 299 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 300 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 301 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 302 | "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. |
| 303 | "likeCount": 42, # The total number of likes this comment has received. |
| 304 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 305 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 306 | "publishedAt": "A String", # The date and time when the comment was originally published. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 307 | "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. |
| 308 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 309 | "updatedAt": "A String", # The date and time when the comment was last updated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 310 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 311 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 312 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 313 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 314 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 315 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 316 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 317 | "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. |
| 318 | "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. |
| 319 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 320 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 321 | "etag": "A String", # Etag of this resource. |
| 322 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 323 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 324 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 325 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 326 | "value": "A String", |
| 327 | }, |
| 328 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 329 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 330 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 331 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 332 | "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. |
| 333 | "likeCount": 42, # The total number of likes this comment has received. |
| 334 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 335 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 336 | "publishedAt": "A String", # The date and time when the comment was originally published. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 337 | "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. |
| 338 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 339 | "updatedAt": "A String", # The date and time when the comment was last updated. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 340 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 341 | "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. |
| 342 | }, |
| 343 | }, |
| 344 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 345 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 346 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 347 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 348 | ], |
| 349 | "kind": "youtube#commentThreadListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse". |
| 350 | "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. |
| 351 | "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. |
| 352 | "resultsPerPage": 42, # The number of results included in the API response. |
| 353 | "totalResults": 42, # The total number of results in the result set. |
| 354 | }, |
| 355 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 356 | }, |
| 357 | "visitorId": "A String", # The visitorId identifies the visitor. |
| 358 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 359 | </div> |
| 360 | |
| 361 | <div class="method"> |
| 362 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 363 | <pre>Retrieves the next page of results. |
| 364 | |
| 365 | Args: |
| 366 | previous_request: The request for the previous page. (required) |
| 367 | previous_response: The response from the request for the previous page. (required) |
| 368 | |
| 369 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 370 | A request object that you can call 'execute()' on to request the next |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 371 | page. Returns None if there are no more items in the collection. |
| 372 | </pre> |
| 373 | </div> |
| 374 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 375 | </body></html> |