Blame - docs/dyn/youtube_v3.commentThreads.html - platform/external/python/google-api-python-client

2015-06-15 16:44:50 +0000

[diff] [blame]

82

<p class="firstline">Returns a list of comment threads that match the API request parameters.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#update">update(part, body=None)</a></code></p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

88

<p class="firstline">Modifies the top-level comment in a comment thread.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

89

<h3>Method Details</h3>

90

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

91

<code class="details" id="insert">insert(part, body=None)</code>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

92

<pre>Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

93

94

Args:

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

95

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)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

97

The object takes the form of:

98

99

{ # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

100

"etag": "A String", # Etag of this resource.

101

"id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.

102

"kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".

103

"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.

104

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

105

{ # A comment represents a single YouTube comment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

106

"etag": "A String", # Etag of this resource.

107

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

108

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

109

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

110

"authorChannelId": "", # The id of the author's YouTube channel, if any.

111

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

112

"authorDisplayName": "A String", # The name of the user who posted the comment.

113

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

114

"canRate": True or False, # Whether the current viewer can rate this comment.

115

"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.

116

"likeCount": 42, # The total number of likes this comment has received.

117

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

118

"parentId": "A String", # The unique id of the parent comment, only set for replies.

119

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

120

"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.

121

"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.

122

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

123

"videoId": "A String", # The ID of the video the comment refers to, if any.

124

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

125

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

126

},

127

],

128

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

129

"snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.

130

"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.

131

"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.

132

"isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.

133

"topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.

134

"etag": "A String", # Etag of this resource.

135

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

136

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

137

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

138

"authorChannelId": "", # The id of the author's YouTube channel, if any.

139

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

140

"authorDisplayName": "A String", # The name of the user who posted the comment.

141

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

142

"canRate": True or False, # Whether the current viewer can rate this comment.

143

"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.

144

"likeCount": 42, # The total number of likes this comment has received.

145

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

146

"parentId": "A String", # The unique id of the parent comment, only set for replies.

147

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

148

"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.

149

"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.

150

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

151

"videoId": "A String", # The ID of the video the comment refers to, if any.

152

"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.

153

},

154

},

155

"totalReplyCount": 42, # The total number of replies (not including the top level comment).

156

"videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.

157

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

158

}

159

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

160

161

Returns:

162

An object of the form:

163

164

{ # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

165

"etag": "A String", # Etag of this resource.

166

"id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.

167

"kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".

168

"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.

169

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

170

{ # A comment represents a single YouTube comment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

171

"etag": "A String", # Etag of this resource.

172

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

173

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

174

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

175

"authorChannelId": "", # The id of the author's YouTube channel, if any.

176

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

177

"authorDisplayName": "A String", # The name of the user who posted the comment.

178

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

179

"canRate": True or False, # Whether the current viewer can rate this comment.

180

"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.

181

"likeCount": 42, # The total number of likes this comment has received.

182

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

183

"parentId": "A String", # The unique id of the parent comment, only set for replies.

184

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

185

"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.

186

"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.

187

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

188

"videoId": "A String", # The ID of the video the comment refers to, if any.

189

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

190

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

191

},

192

],

193

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

194

"snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.

195

"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.

196

"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.

197

"isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.

198

"topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.

199

"etag": "A String", # Etag of this resource.

200

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

201

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

202

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

203

"authorChannelId": "", # The id of the author's YouTube channel, if any.

204

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

205

"authorDisplayName": "A String", # The name of the user who posted the comment.

206

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

207

"canRate": True or False, # Whether the current viewer can rate this comment.

208

"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.

209

"likeCount": 42, # The total number of likes this comment has received.

210

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

211

"parentId": "A String", # The unique id of the parent comment, only set for replies.

212

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

213

"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.

214

"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.

215

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

216

"videoId": "A String", # The ID of the video the comment refers to, if any.

217

"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.

218

},

219

},

220

"totalReplyCount": 42, # The total number of replies (not including the top level comment).

221

"videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.

222

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

<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)</code>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

228

<pre>Returns a list of comment threads that match the API request parameters.

229

230

Args:

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

231

part: string, The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

allThreadsRelatedToChannelId: string, The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

233

channelId: string, The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.)

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

234

id: string, The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

235

maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

236

237

Note: This parameter is not supported for use in conjunction with the id parameter.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

238

moderationStatus: string, Set this parameter to limit the returned comment threads to a particular moderation state.

239

240

Note: This parameter is not supported for use in conjunction with the id parameter.

241

Allowed values

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

242

heldForReview - Retrieve comment threads that are awaiting review by a moderator. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment are awaiting review.

243

likelySpam - Retrieve comment threads classified as likely to be spam. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment is considered likely to be spam.

244

published - Retrieve threads of published comments. This is the default value. A comment thread can be included in the response if its top-level comment has been published.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

245

order: string, The order parameter specifies the order in which the API response should list comment threads. Valid values are:

246

- time - Comment threads are ordered by time. This is the default behavior.

247

- relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

248

Allowed values

249

relevance - Order by relevance.

250

time - Order by time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

251

pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.

252

253

Note: This parameter is not supported for use in conjunction with the id parameter.

254

searchTerms: string, The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.

255

256

Note: This parameter is not supported for use in conjunction with the id parameter.

257

textFormat: string, Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.

258

Allowed values

259

html - Returns the comments in HTML format. This is the default value.

260

plainText - Returns the comments in plain text format.

261

videoId: string, The videoId parameter instructs the API to return comment threads associated with the specified video ID.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

262

263

Returns:

264

An object of the form:

265

266

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

267

"etag": "A String", # Etag of this resource.

268

"eventId": "A String", # Serialized EventId of the request which produced this response.

269

"items": [ # A list of comment threads that match the request criteria.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

270

{ # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

271

"etag": "A String", # Etag of this resource.

272

"id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.

273

"kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".

274

"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.

275

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

276

{ # A comment represents a single YouTube comment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

277

"etag": "A String", # Etag of this resource.

278

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

279

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

280

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

281

"authorChannelId": "", # The id of the author's YouTube channel, if any.

282

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

283

"authorDisplayName": "A String", # The name of the user who posted the comment.

284

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

285

"canRate": True or False, # Whether the current viewer can rate this comment.

286

"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.

287

"likeCount": 42, # The total number of likes this comment has received.

288

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

289

"parentId": "A String", # The unique id of the parent comment, only set for replies.

290

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

291

"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.

292

"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.

293

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

294

"videoId": "A String", # The ID of the video the comment refers to, if any.

295

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

296

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

297

},

298

],

299

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

"snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.

301

"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.

302

"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.

303

"isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.

304

"topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.

305

"etag": "A String", # Etag of this resource.

306

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

307

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

308

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

309

"authorChannelId": "", # The id of the author's YouTube channel, if any.

310

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

311

"authorDisplayName": "A String", # The name of the user who posted the comment.

312

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

313

"canRate": True or False, # Whether the current viewer can rate this comment.

314

"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.

315

"likeCount": 42, # The total number of likes this comment has received.

316

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

317

"parentId": "A String", # The unique id of the parent comment, only set for replies.

318

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

319

"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.

320

"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.

321

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

322

"videoId": "A String", # The ID of the video the comment refers to, if any.

323

"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.

324

},

325

},

326

"totalReplyCount": 42, # The total number of replies (not including the top level comment).

327

"videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.

328

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

329

},

330

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

331

"kind": "youtube#commentThreadListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse".

332

"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.

333

"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.

334

"resultsPerPage": 42, # The number of results included in the API response.

335

"totalResults": 42, # The total number of results in the result set.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

336

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

337

"tokenPagination": { # Stub token pagination template to suppress results.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

338

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

339

"visitorId": "A String", # The visitorId identifies the visitor.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

345

<pre>Retrieves the next page of results.

346

347

Args:

348

previous_request: The request for the previous page. (required)

349

previous_response: The response from the request for the previous page. (required)

350

351

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

352

A request object that you can call 'execute()' on to request the next

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

353

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

358

<code class="details" id="update">update(part, body=None)</code>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

359

<pre>Modifies the top-level comment in a comment thread.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

360

361

Args:

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

362

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)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

363

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

364

The object takes the form of:

365

366

{ # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

367

"etag": "A String", # Etag of this resource.

368

"id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.

369

"kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".

370

"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.

371

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

372

{ # A comment represents a single YouTube comment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

373

"etag": "A String", # Etag of this resource.

374

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

375

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

376

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

377

"authorChannelId": "", # The id of the author's YouTube channel, if any.

378

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

379

"authorDisplayName": "A String", # The name of the user who posted the comment.

380

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

381

"canRate": True or False, # Whether the current viewer can rate this comment.

382

"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.

383

"likeCount": 42, # The total number of likes this comment has received.

384

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

385

"parentId": "A String", # The unique id of the parent comment, only set for replies.

386

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

387

"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.

388

"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.

389

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

390

"videoId": "A String", # The ID of the video the comment refers to, if any.

391

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

392

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

393

},

394

],

395

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

396

"snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.

397

"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.

398

"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.

399

"isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.

400

"topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.

401

"etag": "A String", # Etag of this resource.

402

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

403

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

404

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

405

"authorChannelId": "", # The id of the author's YouTube channel, if any.

406

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

407

"authorDisplayName": "A String", # The name of the user who posted the comment.

408

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

409

"canRate": True or False, # Whether the current viewer can rate this comment.

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

"likeCount": 42, # The total number of likes this comment has received.

412

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

413

"parentId": "A String", # The unique id of the parent comment, only set for replies.

414

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

415

"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.

416

"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.

417

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

418

"videoId": "A String", # The ID of the video the comment refers to, if any.

419

"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.

420

},

421

},

422

"totalReplyCount": 42, # The total number of replies (not including the top level comment).

423

"videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.

424

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}

Returns:

An object of the form:

430

431

{ # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

432

"etag": "A String", # Etag of this resource.

433

"id": "A String", # The ID that YouTube uses to uniquely identify the comment thread.

434

"kind": "youtube#commentThread", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".

435

"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.

436

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

437

{ # A comment represents a single YouTube comment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

438

"etag": "A String", # Etag of this resource.

439

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

440

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

441

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

442

"authorChannelId": "", # The id of the author's YouTube channel, if any.

443

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

444

"authorDisplayName": "A String", # The name of the user who posted the comment.

445

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

446

"canRate": True or False, # Whether the current viewer can rate this comment.

447

"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.

448

"likeCount": 42, # The total number of likes this comment has received.

449

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

450

"parentId": "A String", # The unique id of the parent comment, only set for replies.

451

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

452

"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.

453

"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.

454

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

455

"videoId": "A String", # The ID of the video the comment refers to, if any.

456

"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.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

457

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

458

},

459

],

460

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

461

"snippet": { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.

462

"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.

463

"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.

464

"isPublic": True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.

465

"topLevelComment": { # A comment represents a single YouTube comment. # The top level comment of this thread.

466

"etag": "A String", # Etag of this resource.

467

"id": "A String", # The ID that YouTube uses to uniquely identify the comment.

468

"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

469

"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.

470

"authorChannelId": "", # The id of the author's YouTube channel, if any.

471

"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.

472

"authorDisplayName": "A String", # The name of the user who posted the comment.

473

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.

474

"canRate": True or False, # Whether the current viewer can rate this comment.

475

"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.

476

"likeCount": 42, # The total number of likes this comment has received.

477

"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.

478

"parentId": "A String", # The unique id of the parent comment, only set for replies.

479

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

480

"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.

481

"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.

482

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

483

"videoId": "A String", # The ID of the video the comment refers to, if any.

484

"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.

485

},

486

},

487

"totalReplyCount": 42, # The total number of replies (not including the top level comment).

488

"videoId": "A String", # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.

489

},

Nathaniel Manista