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

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

[diff] [blame]

85

<p class="firstline">Retrieves a list of resources, possibly filtered.</p>

Nathaniel Manista

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

[diff] [blame]

86

87

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

88

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

89

Bu Sun Kim

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

[diff] [blame]

90

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

91

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

Nathaniel Manista

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

[diff] [blame]

92

<h3>Method Details</h3>

93

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

<code class="details" id="close">close()</code>

95

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

99

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

100

<pre>Inserts a new resource into this collection.

Nathaniel Manista

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

[diff] [blame]

101

102

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

103

part: string, The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

104

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

105

The object takes the form of:

106

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

107

{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

108

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

109

"comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.

110

{ # A *comment* represents a single YouTube comment.

111

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

112

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

113

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

114

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

115

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

116

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

117

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

118

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

119

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

120

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

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

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

123

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

124

"value": "A String",

125

},

126

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

127

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.

128

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

129

},

130

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

131

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

132

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

},

],

},

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

137

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

138

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

139

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

140

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

141

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

142

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

143

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

144

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

145

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

146

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

147

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

148

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

149

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

150

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

151

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

Bu Sun Kim

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

[diff] [blame]

152

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

153

"value": "A String",

154

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

155

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

156

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

157

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

Bu Sun Kim

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

[diff] [blame]

158

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

159

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

160

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

161

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

Bu Sun Kim

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

[diff] [blame]

162

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

163

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

164

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

165

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

Nathaniel Manista

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

[diff] [blame]

166

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

167

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

168

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

169

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

170

}

Nathaniel Manista

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

[diff] [blame]

171

Bu Sun Kim

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

[diff] [blame]

172

x__xgafv: string, V1 error format.

173

Allowed values

174

1 - v1 error format

175

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

176

177

Returns:

178

An object of the form:

179

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

180

{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

181

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

182

"comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.

183

{ # A *comment* represents a single YouTube comment.

184

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

185

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

186

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

187

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

188

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

"value": "A String",

198

},

199

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

200

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.

201

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

202

},

203

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

204

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

205

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

},

],

},

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

210

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

211

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

212

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

213

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

214

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

215

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

216

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

217

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

218

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

219

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

220

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

221

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

222

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

223

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

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

226

"value": "A String",

227

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

228

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

229

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

230

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

Bu Sun Kim

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

[diff] [blame]

231

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

232

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

233

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

234

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

Bu Sun Kim

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

[diff] [blame]

235

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

236

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

237

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

238

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

Nathaniel Manista

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

[diff] [blame]

239

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

240

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

241

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

242

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

243

}</pre>

Nathaniel Manista

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

Nathaniel Manista

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

[diff] [blame]

249

250

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

251

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

252

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

253

channelId: string, Returns the comment threads for all the channel comments (ie does not include comments left on videos).

254

pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

255

order: string, A parameter

256

Allowed values

257

orderUnspecified -

258

time - Order by time.

259

relevance - Order by relevance.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

260

searchTerms: string, Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

261

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

262

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

263

Allowed values

264

textFormatUnspecified -

265

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

266

plainText - Returns the comments in plain text format.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

267

moderationStatus: string, Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.

268

Allowed values

269

published - The comment is available for public display.

270

heldForReview - The comment is awaiting review by a moderator.

271

likelySpam -

272

rejected - The comment is unfit for display.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

273

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

274

allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the channel comments as well.

Bu Sun Kim

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

[diff] [blame]

275

x__xgafv: string, V1 error format.

Nathaniel Manista

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

[diff] [blame]

276

Allowed values

Bu Sun Kim

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

[diff] [blame]

277

1 - v1 error format

278

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

279

280

Returns:

281

An object of the form:

282

283

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

284

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

285

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

286

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

287

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

288

{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

289

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

290

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

291

{ # A *comment* represents a single YouTube comment.

292

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

293

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

294

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

295

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

296

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

"value": "A String",

306

},

307

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

308

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.

309

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

310

},

311

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

312

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

313

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

},

],

},

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

318

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

319

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

320

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

321

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

322

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

323

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

324

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

325

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

326

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

327

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

328

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

329

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

330

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

331

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

332

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

333

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

334

"value": "A String",

335

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

336

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

337

"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

338

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

339

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

340

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

341

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

342

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

343

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

344

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

345

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

346

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

347

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

348

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

349

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

350

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

351

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

352

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

353

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

354

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

355

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

356

},

357

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

358

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

359

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

360

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

366

<pre>Retrieves the next page of results.

367

368

Args:

369

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

370

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

371

372

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

373

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

Nathaniel Manista

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

[diff] [blame]

374

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]

379

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

380

<pre>Updates an existing resource.

Nathaniel Manista

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

[diff] [blame]

381

382

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

383

part: string, The *part* parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

384

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

385

The object takes the form of:

386

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

387

{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

388

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

389

"comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.

390

{ # A *comment* represents a single YouTube comment.

391

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

392

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

393

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

394

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

395

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

"value": "A String",

405

},

406

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

407

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

408

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

409

},

410

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

411

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

412

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

},

],

},

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

417

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

418

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

419

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

420

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

421

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

422

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

423

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

424

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

425

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

426

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

427

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

428

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

429

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

430

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

431

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

Bu Sun Kim

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

[diff] [blame]

432

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

433

"value": "A String",

434

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

435

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

436

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

437

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

Bu Sun Kim

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

[diff] [blame]

438

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

439

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

440

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

441

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

Bu Sun Kim

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

[diff] [blame]

442

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

443

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

444

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

445

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

Nathaniel Manista

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

[diff] [blame]

446

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

447

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

448

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

449

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

450

}

Nathaniel Manista

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

[diff] [blame]

451

Bu Sun Kim

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

[diff] [blame]

452

x__xgafv: string, V1 error format.

453

Allowed values

454

1 - v1 error format

455

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

456

457

Returns:

458

An object of the form:

459

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

460

{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

461

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

462

"comments": [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.

463

{ # A *comment* represents a single YouTube comment.

464

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

465

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

466

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

467

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

468

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

"value": "A String",

478

},

479

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

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

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

482

},

483

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

484

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

485

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

},

],

},

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

490

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

491

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

492

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

493

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

494

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

495

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

496

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

497

"updatedAt": "A String", # The date and time when was last updated . The value is specified in ISO 8601 format.

498

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

499

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

500

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

501

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

502

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

503

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

504

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

Bu Sun Kim

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

[diff] [blame]

505

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

506

"value": "A String",

507

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

508

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

509

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

510

"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

Bu Sun Kim

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

[diff] [blame]

511

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

512

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

513

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

514

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

Bu Sun Kim

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

[diff] [blame]

515

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

516

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

517

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

518

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

Nathaniel Manista

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

[diff] [blame]

519

},

Yoshi Automation Bot