| 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 | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 84 | <code><a href="#list">list(part, order=None, maxResults=None, searchTerms=None, textFormat=None, channelId=None, pageToken=None, videoId=None, moderationStatus=None, id=None, allThreadsRelatedToChannelId=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> |
| 89 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 90 | <code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Updates an existing resource.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 99 | <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code> |
| 100 | <pre>Inserts a new resource into this collection. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 101 | |
| 102 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | 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] | 104 | body: object, The request body. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 105 | The object takes the form of: |
| 106 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 107 | { # 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 | c2228be | 2020-11-24 15:48: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. |
| 111 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 112 | "etag": "A String", # Etag of this resource. |
| 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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 115 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 116 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 117 | "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. |
| 118 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 119 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 120 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 121 | "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. |
| 122 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 123 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 124 | "value": "A String", |
| 125 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 126 | "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 | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 127 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 128 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 129 | "likeCount": 42, # The total number of likes this comment has received. |
| 130 | "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. |
| 131 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 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 | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 134 | ], |
| 135 | }, |
| 136 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 137 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| 138 | "etag": "A String", # Etag of this resource. |
| 139 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 140 | "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. |
| 141 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 142 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 143 | "etag": "A String", # Etag of this resource. |
| 144 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 145 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 146 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| 147 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 148 | "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. |
| 149 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 150 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| 151 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 152 | "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. |
| 153 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 154 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 155 | "value": "A String", |
| 156 | }, |
| 157 | "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. |
| 158 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 159 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 160 | "likeCount": 42, # The total number of likes this comment has received. |
| 161 | "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. |
| 162 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 163 | }, |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 164 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 165 | "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. |
| 166 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 167 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 168 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 169 | }, |
| 170 | } |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 171 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 172 | x__xgafv: string, V1 error format. |
| 173 | Allowed values |
| 174 | 1 - v1 error format |
| 175 | 2 - v2 error format |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 176 | |
| 177 | Returns: |
| 178 | An object of the form: |
| 179 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 180 | { # 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 | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 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 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 185 | "etag": "A String", # Etag of this resource. |
| 186 | "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] | 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 | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 188 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 189 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 190 | "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. |
| 191 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 192 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 193 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 194 | "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. |
| 195 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 196 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 197 | "value": "A String", |
| 198 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 199 | "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 | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 200 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 201 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 202 | "likeCount": 42, # The total number of likes this comment has received. |
| 203 | "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. |
| 204 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 205 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 206 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 207 | ], |
| 208 | }, |
| 209 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 210 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| 211 | "etag": "A String", # Etag of this resource. |
| 212 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 213 | "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. |
| 214 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 215 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 216 | "etag": "A String", # Etag of this resource. |
| 217 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 218 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 219 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| 220 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 221 | "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. |
| 222 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 223 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| 224 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 225 | "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. |
| 226 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 227 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 228 | "value": "A String", |
| 229 | }, |
| 230 | "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. |
| 231 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 232 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 233 | "likeCount": 42, # The total number of likes this comment has received. |
| 234 | "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. |
| 235 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 236 | }, |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 237 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 238 | "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. |
| 239 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 240 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 241 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 242 | }, |
| 243 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 244 | </div> |
| 245 | |
| 246 | <div class="method"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 247 | <code class="details" id="list">list(part, order=None, maxResults=None, searchTerms=None, textFormat=None, channelId=None, pageToken=None, videoId=None, moderationStatus=None, id=None, allThreadsRelatedToChannelId=None, x__xgafv=None)</code> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 248 | <pre>Retrieves a list of resources, possibly filtered. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 249 | |
| 250 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 251 | 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) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 252 | order: string, A parameter |
| 253 | Allowed values |
| 254 | orderUnspecified - |
| 255 | time - Order by time. |
| 256 | relevance - Order by relevance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 257 | maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| 258 | searchTerms: string, Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter. |
| 259 | textFormat: string, The requested text format for the returned comments. |
| 260 | Allowed values |
| 261 | textFormatUnspecified - |
| 262 | html - Returns the comments in HTML format. This is the default value. |
| 263 | plainText - Returns the comments in plain text format. |
| 264 | channelId: string, Returns the comment threads for all the channel comments (ie does not include comments left on videos). |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 265 | 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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 266 | videoId: string, Returns the comment threads of the specified video. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 267 | 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. |
| 268 | Allowed values |
| 269 | published - The comment is available for public display. |
| 270 | heldForReview - The comment is awaiting review by a moderator. |
| 271 | likelySpam - |
| 272 | rejected - The comment is unfit for display. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 273 | id: string, Returns the comment threads with the given IDs for Stubby or Apiary. (repeated) |
| 274 | allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the channel comments as well. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 275 | x__xgafv: string, V1 error format. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 276 | Allowed values |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 277 | 1 - v1 error format |
| 278 | 2 - v2 error format |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 279 | |
| 280 | Returns: |
| 281 | An object of the form: |
| 282 | |
| 283 | { |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 284 | "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. |
| 285 | "totalResults": 42, # The total number of results in the result set. |
| 286 | "resultsPerPage": 42, # The number of results included in the API response. |
| 287 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 288 | "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. |
| 289 | "kind": "youtube#commentThreadListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse". |
| 290 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 291 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 292 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 293 | "items": [ # A list of comment threads that match the request criteria. |
| 294 | { # 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. |
| 295 | "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. |
| 296 | "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. |
| 297 | { # A *comment* represents a single YouTube comment. |
| 298 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 299 | "etag": "A String", # Etag of this resource. |
| 300 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 301 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 302 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| 303 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 304 | "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. |
| 305 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 306 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| 307 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 308 | "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. |
| 309 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 310 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 311 | "value": "A String", |
| 312 | }, |
| 313 | "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. |
| 314 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 315 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 316 | "likeCount": 42, # The total number of likes this comment has received. |
| 317 | "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. |
| 318 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 319 | }, |
| 320 | }, |
| 321 | ], |
| 322 | }, |
| 323 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 324 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| 325 | "etag": "A String", # Etag of this resource. |
| 326 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 327 | "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. |
| 328 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 329 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 330 | "etag": "A String", # Etag of this resource. |
| 331 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 332 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 333 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| 334 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 335 | "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. |
| 336 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 337 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| 338 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 339 | "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. |
| 340 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 341 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 342 | "value": "A String", |
| 343 | }, |
| 344 | "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. |
| 345 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 346 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 347 | "likeCount": 42, # The total number of likes this comment has received. |
| 348 | "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. |
| 349 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 350 | }, |
| 351 | }, |
| 352 | "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. |
| 353 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 354 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 355 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 356 | }, |
| 357 | }, |
| 358 | ], |
| 359 | "visitorId": "A String", # The visitorId identifies the visitor. |
| 360 | "etag": "A String", # Etag of this resource. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 361 | }</pre> |
| 362 | </div> |
| 363 | |
| 364 | <div class="method"> |
| 365 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 366 | <pre>Retrieves the next page of results. |
| 367 | |
| 368 | Args: |
| 369 | previous_request: The request for the previous page. (required) |
| 370 | previous_response: The response from the request for the previous page. (required) |
| 371 | |
| 372 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | 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] | 374 | page. Returns None if there are no more items in the collection. |
| 375 | </pre> |
| 376 | </div> |
| 377 | |
| 378 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 379 | <code class="details" id="update">update(part, body=None, x__xgafv=None)</code> |
| 380 | <pre>Updates an existing resource. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 381 | |
| 382 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 383 | 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) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 384 | body: object, The request body. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 385 | The object takes the form of: |
| 386 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 387 | { # 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 | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 388 | "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. |
| 389 | "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. |
| 390 | { # A *comment* represents a single YouTube comment. |
| 391 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 392 | "etag": "A String", # Etag of this resource. |
| 393 | "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] | 394 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 395 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 396 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 397 | "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. |
| 398 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 399 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 400 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 401 | "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. |
| 402 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 403 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 404 | "value": "A String", |
| 405 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 406 | "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 | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 407 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 408 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 409 | "likeCount": 42, # The total number of likes this comment has received. |
| 410 | "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. |
| 411 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 412 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 413 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 414 | ], |
| 415 | }, |
| 416 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 417 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| 418 | "etag": "A String", # Etag of this resource. |
| 419 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 420 | "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. |
| 421 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 422 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 423 | "etag": "A String", # Etag of this resource. |
| 424 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 425 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 426 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| 427 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 428 | "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. |
| 429 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 430 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| 431 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 432 | "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. |
| 433 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 434 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 435 | "value": "A String", |
| 436 | }, |
| 437 | "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. |
| 438 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 439 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 440 | "likeCount": 42, # The total number of likes this comment has received. |
| 441 | "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. |
| 442 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 443 | }, |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 444 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 445 | "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. |
| 446 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 447 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 448 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 449 | }, |
| 450 | } |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 451 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 452 | x__xgafv: string, V1 error format. |
| 453 | Allowed values |
| 454 | 1 - v1 error format |
| 455 | 2 - v2 error format |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 456 | |
| 457 | Returns: |
| 458 | An object of the form: |
| 459 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 460 | { # 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 | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 461 | "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. |
| 462 | "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. |
| 463 | { # A *comment* represents a single YouTube comment. |
| 464 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 465 | "etag": "A String", # Etag of this resource. |
| 466 | "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] | 467 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 468 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 469 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 470 | "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. |
| 471 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 472 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 473 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 474 | "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. |
| 475 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 476 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 477 | "value": "A String", |
| 478 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 479 | "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 | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 480 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 481 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 482 | "likeCount": 42, # The total number of likes this comment has received. |
| 483 | "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. |
| 484 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 485 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 486 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 487 | ], |
| 488 | }, |
| 489 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment thread. |
| 490 | "kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". |
| 491 | "etag": "A String", # Etag of this resource. |
| 492 | "snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment. |
| 493 | "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. |
| 494 | "topLevelComment": { # A *comment* represents a single YouTube comment. # The top level comment of this thread. |
| 495 | "id": "A String", # The ID that YouTube uses to uniquely identify the comment. |
| 496 | "etag": "A String", # Etag of this resource. |
| 497 | "kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment". |
| 498 | "snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment. |
| 499 | "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 format. |
| 500 | "authorDisplayName": "A String", # The name of the user who posted the comment. |
| 501 | "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. |
| 502 | "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. |
| 503 | "updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format. |
| 504 | "videoId": "A String", # The ID of the video the comment refers to, if any. |
| 505 | "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. |
| 506 | "canRate": True or False, # Whether the current viewer can rate this comment. |
| 507 | "authorChannelId": { # The id of the author's YouTube channel, if any. |
| 508 | "value": "A String", |
| 509 | }, |
| 510 | "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. |
| 511 | "authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. |
| 512 | "parentId": "A String", # The unique id of the parent comment, only set for replies. |
| 513 | "likeCount": 42, # The total number of likes this comment has received. |
| 514 | "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. |
| 515 | "authorChannelUrl": "A String", # Link to the author's YouTube channel, if any. |
| 516 | }, |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 517 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 518 | "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. |
| 519 | "isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users. |
| 520 | "videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. |
| 521 | "totalReplyCount": 42, # The total number of replies (not including the top level comment). |
| 522 | }, |
| 523 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 524 | </div> |
| 525 | |
| 526 | </body></html> |