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

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

[diff] [blame]

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

87

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

88

<p class="firstline">Updates an existing resource.</p>

Nathaniel Manista

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

[diff] [blame]

89

<h3>Method Details</h3>

90

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

91

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

92

<pre>Inserts a new resource into this collection.

Nathaniel Manista

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

[diff] [blame]

93

94

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

95

part: string, The <code><strong>part</strong></code> parameter identifies the properties

96

that the API response will include. Set the parameter value to

97

<code>snippet</code>. The <code>snippet</code> part has a quota cost of 2

98

units. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

99

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

100

The object takes the form of:

101

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

102

{ # A <code><strong>comment thread</strong></code> represents information that

103

# applies to a top level comment and all its replies. It can also include the

104

# top level comment itself and some of the replies.

Bu Sun Kim

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

[diff] [blame]

105

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

106

"snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment

107

# thread and also the top level comment.

108

"channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel

109

# with the video the comments refer to. If video_id isn't set the comments

110

# refer to the channel itself.

111

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

112

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

113

# channel discussion comment.

114

"canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer

115

# specific - other viewers may see a different value for this field.

116

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

117

# YouTube users.

118

"topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.

119

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

120

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

121

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

122

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

123

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

124

# requested through the id filter.

125

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

126

"value": "A String",

127

},

128

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

129

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

130

# what has been requested. Even the plain text representation may differ

131

# from the text originally posted in that it may replace video links with

132

# video titles etc.

133

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

134

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

135

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

136

# This may change in the future.

137

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

138

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

139

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

140

# this is the channel the comment refers to. In case of a video comment

141

# it's the video's channel.

142

"updatedAt": "A String", # The date and time when was last updated . The value is

143

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

144

# format.

145

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

146

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

147

# format.

148

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

149

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

150

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

151

# original text will only be returned if it is accessible to the viewer,

152

# which is only guaranteed if the viewer is the comment's author.

153

},

154

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

155

# <code>"youtube#comment"</code>.

156

},

157

},

158

"replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if

159

# any) to the top level comment found in the snippet.

160

"comments": [ # A limited number of replies. Unless the number of replies returned equals

161

# total_reply_count in the snippet the returned replies are only a subset

162

# of the total number of replies.

163

{ # A <code><strong>comment</strong></code> represents a single YouTube comment.

Bu Sun Kim

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

[diff] [blame]

164

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

165

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

166

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

Bu Sun Kim

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

[diff] [blame]

167

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

168

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

169

# requested through the id filter.

170

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

171

"value": "A String",

172

},

173

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

174

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

175

# what has been requested. Even the plain text representation may differ

176

# from the text originally posted in that it may replace video links with

177

# video titles etc.

Bu Sun Kim

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

[diff] [blame]

178

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

179

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

180

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

181

# This may change in the future.

182

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

183

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

184

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

185

# this is the channel the comment refers to. In case of a video comment

186

# it's the video's channel.

187

"updatedAt": "A String", # The date and time when was last updated . The value is

188

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

189

# format.

190

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

191

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

192

# format.

Bu Sun Kim

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

[diff] [blame]

193

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

Bu Sun Kim

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

[diff] [blame]

194

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

195

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

196

# original text will only be returned if it is accessible to the viewer,

197

# which is only guaranteed if the viewer is the comment's author.

Nathaniel Manista

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

[diff] [blame]

198

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

199

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

200

# <code>"youtube#comment"</code>.

Nathaniel Manista

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

[diff] [blame]

201

},

202

],

203

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

204

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

205

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

206

# <code>"youtube#commentThread"</code>.

Nathaniel Manista

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

[diff] [blame]

207

}

208

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

209

x__xgafv: string, V1 error format.

210

Allowed values

211

1 - v1 error format

212

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

213

214

Returns:

215

An object of the form:

216

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

217

{ # A <code><strong>comment thread</strong></code> represents information that

218

# applies to a top level comment and all its replies. It can also include the

219

# top level comment itself and some of the replies.

Bu Sun Kim

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

[diff] [blame]

220

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

221

"snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment

222

# thread and also the top level comment.

223

"channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel

224

# with the video the comments refer to. If video_id isn't set the comments

225

# refer to the channel itself.

226

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

227

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

228

# channel discussion comment.

229

"canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer

230

# specific - other viewers may see a different value for this field.

231

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

232

# YouTube users.

233

"topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.

234

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

235

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

236

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

237

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

238

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

239

# requested through the id filter.

240

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

241

"value": "A String",

242

},

243

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

244

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

245

# what has been requested. Even the plain text representation may differ

246

# from the text originally posted in that it may replace video links with

247

# video titles etc.

248

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

249

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

250

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

251

# This may change in the future.

252

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

253

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

254

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

255

# this is the channel the comment refers to. In case of a video comment

256

# it's the video's channel.

257

"updatedAt": "A String", # The date and time when was last updated . The value is

258

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

259

# format.

260

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

261

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

262

# format.

263

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

264

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

265

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

266

# original text will only be returned if it is accessible to the viewer,

267

# which is only guaranteed if the viewer is the comment's author.

268

},

269

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

270

# <code>"youtube#comment"</code>.

271

},

272

},

273

"replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if

274

# any) to the top level comment found in the snippet.

275

"comments": [ # A limited number of replies. Unless the number of replies returned equals

276

# total_reply_count in the snippet the returned replies are only a subset

277

# of the total number of replies.

278

{ # A <code><strong>comment</strong></code> represents a single YouTube comment.

Bu Sun Kim

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

[diff] [blame]

279

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

280

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

281

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

Bu Sun Kim

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

[diff] [blame]

282

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

283

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

284

# requested through the id filter.

285

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

286

"value": "A String",

287

},

288

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

289

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

290

# what has been requested. Even the plain text representation may differ

291

# from the text originally posted in that it may replace video links with

292

# video titles etc.

Bu Sun Kim

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

[diff] [blame]

293

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

294

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

295

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

296

# This may change in the future.

297

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

298

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

299

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

300

# this is the channel the comment refers to. In case of a video comment

301

# it's the video's channel.

302

"updatedAt": "A String", # The date and time when was last updated . The value is

303

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

304

# format.

305

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

306

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

307

# format.

Bu Sun Kim

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

[diff] [blame]

308

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

Bu Sun Kim

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

[diff] [blame]

309

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

310

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

311

# original text will only be returned if it is accessible to the viewer,

312

# which is only guaranteed if the viewer is the comment's author.

Nathaniel Manista

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

[diff] [blame]

313

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

314

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

315

# <code>"youtube#comment"</code>.

Nathaniel Manista

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

[diff] [blame]

316

},

317

],

318

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

319

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

320

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

321

# <code>"youtube#commentThread"</code>.

Nathaniel Manista

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

326

<code class="details" id="list">list(part, searchTerms=None, maxResults=None, videoId=None, order=None, moderationStatus=None, allThreadsRelatedToChannelId=None, pageToken=None, id=None, channelId=None, textFormat=None, x__xgafv=None)</code>

327

<pre>Retrieves a list of resources, possibly filtered.

Nathaniel Manista

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

[diff] [blame]

328

329

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

330

part: string, The <code><strong>part</strong></code> parameter specifies a

331

comma-separated list of one or more <code>commentThread</code> resource

332

properties that the API response will include. (required) (repeated)

333

searchTerms: string, Limits the returned comment threads to those matching the specified

334

key words. Not compatible with the 'id' filter.

335

maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the

336

maximum number of items that should be returned in the result set.

337

videoId: string, Returns the comment threads of the specified video.

338

order: string, A parameter

339

moderationStatus: string, Limits the returned comment threads to those with the specified

340

moderation status. Not compatible with the 'id' filter.

341

Valid values: published, heldForReview, likelySpam.

342

allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the

343

channel comments as well.

344

pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific

345

page in the result set that should be returned. In an API response, the

346

<code>nextPageToken</code> and <code>prevPageToken</code> properties

347

identify other pages that could be retrieved.

348

id: string, Returns the comment threads with the given IDs for Stubby or Apiary. (repeated)

349

channelId: string, Returns the comment threads for all the channel comments (ie does not

350

include comments left on videos).

351

textFormat: string, The requested text format for the returned comments.

352

x__xgafv: string, V1 error format.

Nathaniel Manista

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

[diff] [blame]

353

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

354

1 - v1 error format

355

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

356

357

Returns:

358

An object of the form:

359

360

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

361

"visitorId": "A String", # The <code>visitorId</code> identifies the visitor.

362

"pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.

363

# available and number of resources returned in a single page.

Bu Sun Kim

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

[diff] [blame]

364

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

365

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

Nathaniel Manista

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

[diff] [blame]

366

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

367

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

368

{ # A <code><strong>comment thread</strong></code> represents information that

369

# applies to a top level comment and all its replies. It can also include the

370

# top level comment itself and some of the replies.

371

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

372

"snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment

373

# thread and also the top level comment.

374

"channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel

375

# with the video the comments refer to. If video_id isn't set the comments

376

# refer to the channel itself.

377

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

378

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

379

# channel discussion comment.

380

"canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer

381

# specific - other viewers may see a different value for this field.

382

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

383

# YouTube users.

384

"topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.

385

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

386

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

387

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

388

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

389

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

390

# requested through the id filter.

391

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

392

"value": "A String",

393

},

394

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

395

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

396

# what has been requested. Even the plain text representation may differ

397

# from the text originally posted in that it may replace video links with

398

# video titles etc.

399

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

400

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

401

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

402

# This may change in the future.

403

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

404

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

405

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

406

# this is the channel the comment refers to. In case of a video comment

407

# it's the video's channel.

408

"updatedAt": "A String", # The date and time when was last updated . The value is

409

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

410

# format.

411

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

412

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

413

# format.

414

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

415

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

416

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

417

# original text will only be returned if it is accessible to the viewer,

418

# which is only guaranteed if the viewer is the comment's author.

419

},

420

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

421

# <code>"youtube#comment"</code>.

422

},

423

},

424

"replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if

425

# any) to the top level comment found in the snippet.

426

"comments": [ # A limited number of replies. Unless the number of replies returned equals

427

# total_reply_count in the snippet the returned replies are only a subset

428

# of the total number of replies.

429

{ # A <code><strong>comment</strong></code> represents a single YouTube comment.

430

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

431

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

432

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

433

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

434

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

435

# requested through the id filter.

436

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

437

"value": "A String",

438

},

439

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

440

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

441

# what has been requested. Even the plain text representation may differ

442

# from the text originally posted in that it may replace video links with

443

# video titles etc.

444

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

445

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

446

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

447

# This may change in the future.

448

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

449

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

450

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

451

# this is the channel the comment refers to. In case of a video comment

452

# it's the video's channel.

453

"updatedAt": "A String", # The date and time when was last updated . The value is

454

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

455

# format.

456

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

457

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

458

# format.

459

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

460

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

461

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

462

# original text will only be returned if it is accessible to the viewer,

463

# which is only guaranteed if the viewer is the comment's author.

464

},

465

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

466

# <code>"youtube#comment"</code>.

},

],

},

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

471

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

472

# <code>"youtube#commentThread"</code>.

473

},

474

],

475

"nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>

476

# parameter to retrieve the next page in the result set.

477

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

Bu Sun Kim

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

[diff] [blame]

478

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

Nathaniel Manista

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

[diff] [blame]

479

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

480

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

481

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

482

# <code>"youtube#commentThreadListResponse"</code>.

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>

488

<pre>Retrieves the next page of results.

489

490

Args:

491

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

492

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

493

494

Returns:

Bu Sun Kim

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

[diff] [blame]

495

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

Nathaniel Manista

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

[diff] [blame]

496

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

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

501

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

502

<pre>Updates an existing resource.

Nathaniel Manista

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

[diff] [blame]

503

504

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

505

part: string, The <code><strong>part</strong></code> parameter specifies a

506

comma-separated list of <code>commentThread</code> resource properties that

507

the API response will include. You must at least include the

508

<code>snippet</code> part in the parameter value since that part contains

509

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]

510

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

511

The object takes the form of:

512

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

513

{ # A <code><strong>comment thread</strong></code> represents information that

514

# applies to a top level comment and all its replies. It can also include the

515

# top level comment itself and some of the replies.

Bu Sun Kim

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

[diff] [blame]

516

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

517

"snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment

518

# thread and also the top level comment.

519

"channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel

520

# with the video the comments refer to. If video_id isn't set the comments

521

# refer to the channel itself.

522

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

523

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

524

# channel discussion comment.

525

"canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer

526

# specific - other viewers may see a different value for this field.

527

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

528

# YouTube users.

529

"topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.

530

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

531

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

532

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

533

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

534

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

535

# requested through the id filter.

536

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

537

"value": "A String",

538

},

539

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

540

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

541

# what has been requested. Even the plain text representation may differ

542

# from the text originally posted in that it may replace video links with

543

# video titles etc.

544

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

545

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

546

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

547

# This may change in the future.

548

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

549

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

550

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

551

# this is the channel the comment refers to. In case of a video comment

552

# it's the video's channel.

553

"updatedAt": "A String", # The date and time when was last updated . The value is

554

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

555

# format.

556

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

557

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

558

# format.

559

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

560

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

561

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

562

# original text will only be returned if it is accessible to the viewer,

563

# which is only guaranteed if the viewer is the comment's author.

564

},

565

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

566

# <code>"youtube#comment"</code>.

567

},

568

},

569

"replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if

570

# any) to the top level comment found in the snippet.

571

"comments": [ # A limited number of replies. Unless the number of replies returned equals

572

# total_reply_count in the snippet the returned replies are only a subset

573

# of the total number of replies.

574

{ # A <code><strong>comment</strong></code> represents a single YouTube comment.

Bu Sun Kim

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

[diff] [blame]

575

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

576

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

577

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

Bu Sun Kim

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

[diff] [blame]

578

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

579

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

580

# requested through the id filter.

581

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

582

"value": "A String",

583

},

584

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

585

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

586

# what has been requested. Even the plain text representation may differ

587

# from the text originally posted in that it may replace video links with

588

# video titles etc.

Bu Sun Kim

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

[diff] [blame]

589

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

590

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

591

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

592

# This may change in the future.

593

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

594

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

595

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

596

# this is the channel the comment refers to. In case of a video comment

597

# it's the video's channel.

598

"updatedAt": "A String", # The date and time when was last updated . The value is

599

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

600

# format.

601

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

602

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

603

# format.

Bu Sun Kim

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

[diff] [blame]

604

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

Bu Sun Kim

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

[diff] [blame]

605

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

606

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

607

# original text will only be returned if it is accessible to the viewer,

608

# which is only guaranteed if the viewer is the comment's author.

Nathaniel Manista

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

[diff] [blame]

609

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

610

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

611

# <code>"youtube#comment"</code>.

Nathaniel Manista

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

[diff] [blame]

612

},

613

],

614

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

615

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

616

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

617

# <code>"youtube#commentThread"</code>.

Nathaniel Manista

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

[diff] [blame]

618

}

619

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

620

x__xgafv: string, V1 error format.

621

Allowed values

622

1 - v1 error format

623

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

624

625

Returns:

626

An object of the form:

627

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

628

{ # A <code><strong>comment thread</strong></code> represents information that

629

# applies to a top level comment and all its replies. It can also include the

630

# top level comment itself and some of the replies.

Bu Sun Kim

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

[diff] [blame]

631

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

632

"snippet": { # Basic details about a comment thread. # The <code>snippet</code> object contains basic details about the comment

633

# thread and also the top level comment.

634

"channelId": "A String", # The YouTube channel the comments in the thread refer to or the channel

635

# with the video the comments refer to. If video_id isn't set the comments

636

# refer to the channel itself.

637

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

638

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

639

# channel discussion comment.

640

"canReply": True or False, # Whether the current viewer of the thread can reply to it. This is viewer

641

# specific - other viewers may see a different value for this field.

642

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

643

# YouTube users.

644

"topLevelComment": { # A <code><strong>comment</strong></code> represents a single YouTube comment. # The top level comment of this thread.

645

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

646

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

647

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

648

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

649

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

650

# requested through the id filter.

651

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

652

"value": "A String",

653

},

654

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

655

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

656

# what has been requested. Even the plain text representation may differ

657

# from the text originally posted in that it may replace video links with

658

# video titles etc.

659

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

660

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

661

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

662

# This may change in the future.

663

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

664

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

665

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

666

# this is the channel the comment refers to. In case of a video comment

667

# it's the video's channel.

668

"updatedAt": "A String", # The date and time when was last updated . The value is

669

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

670

# format.

671

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

672

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

673

# format.

674

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

675

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

676

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

677

# original text will only be returned if it is accessible to the viewer,

678

# which is only guaranteed if the viewer is the comment's author.

679

},

680

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

681

# <code>"youtube#comment"</code>.

682

},

683

},

684

"replies": { # Comments written in (direct or indirect) reply to the top level comment. # The <code>replies</code> object contains a limited number of replies (if

685

# any) to the top level comment found in the snippet.

686

"comments": [ # A limited number of replies. Unless the number of replies returned equals

687

# total_reply_count in the snippet the returned replies are only a subset

688

# of the total number of replies.

689

{ # A <code><strong>comment</strong></code> represents a single YouTube comment.

Bu Sun Kim

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

[diff] [blame]

690

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

691

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

692

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

Bu Sun Kim

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

[diff] [blame]

693

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

694

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

695

# requested through the id filter.

696

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

697

"value": "A String",

698

},

699

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

700

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on

701

# what has been requested. Even the plain text representation may differ

702

# from the text originally posted in that it may replace video links with

703

# video titles etc.

Bu Sun Kim

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

[diff] [blame]

704

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

705

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this

706

# will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.

707

# This may change in the future.

708

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

709

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

710

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment

711

# this is the channel the comment refers to. In case of a video comment

712

# it's the video's channel.

713

"updatedAt": "A String", # The date and time when was last updated . The value is

714

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

715

# format.

716

"publishedAt": "A String", # The date and time when the comment was orignally published. The value is

717

# specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

718

# format.

Bu Sun Kim

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

[diff] [blame]

719

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

Bu Sun Kim

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

[diff] [blame]

720

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

721

"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The

722

# original text will only be returned if it is accessible to the viewer,

723

# which is only guaranteed if the viewer is the comment's author.

Nathaniel Manista

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

[diff] [blame]

724

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

725

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

726

# <code>"youtube#comment"</code>.

Nathaniel Manista

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

[diff] [blame]

727

},

728

],

729

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

730

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

731

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

732

# <code>"youtube#commentThread"</code>.

Nathaniel Manista