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

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

[diff] [blame]

127

The object takes the form of:

128

Dmitry Frenkel

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

[diff] [blame]

129

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

130

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

131

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

132

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

133

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

134

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

Dmitry Frenkel

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

[diff] [blame]

135

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

136

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

137

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

Dmitry Frenkel

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

[diff] [blame]

138

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

139

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

140

"value": "A String",

141

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

142

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

143

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

144

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

145

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

146

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

147

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

Nathaniel Manista

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

[diff] [blame]

148

},

Dmitry Frenkel

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

[diff] [blame]

149

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

150

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

151

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

Nathaniel Manista

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

[diff] [blame]

152

}

153

Bu Sun Kim

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

[diff] [blame]

154

x__xgafv: string, V1 error format.

155

Allowed values

156

1 - v1 error format

157

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

158

159

Returns:

160

An object of the form:

161

Dmitry Frenkel

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

[diff] [blame]

162

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

163

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

164

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

165

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

166

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

167

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

Dmitry Frenkel

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

[diff] [blame]

168

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

169

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

170

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

Dmitry Frenkel

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

[diff] [blame]

171

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

172

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

173

"value": "A String",

174

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

175

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

176

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

177

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

178

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

179

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

180

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

Nathaniel Manista

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

[diff] [blame]

181

},

Dmitry Frenkel

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

[diff] [blame]

182

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

183

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

184

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

Nathaniel Manista

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

189

<code class="details" id="list">list(part, pageToken=None, maxResults=None, id=None, parentId=None, textFormat=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

190

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

Nathaniel Manista

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

[diff] [blame]

191

192

Args:

Dmitry Frenkel

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

[diff] [blame]

193

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

194

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.

195

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

Bu Sun Kim

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

[diff] [blame]

196

id: string, Returns the comments with the given IDs for One Platform. (repeated)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

197

parentId: string, Returns replies to the specified comment. Note, currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.

Dmitry Frenkel

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

[diff] [blame]

198

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

199

Allowed values

200

textFormatUnspecified -

201

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

202

plainText - Returns the comments in plain text format.

Bu Sun Kim

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

[diff] [blame]

203

x__xgafv: string, V1 error format.

Nathaniel Manista

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

[diff] [blame]

204

Allowed values

Bu Sun Kim

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

[diff] [blame]

205

1 - v1 error format

206

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

207

208

Returns:

209

An object of the form:

210

211

{

Dmitry Frenkel

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

[diff] [blame]

212

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

Dmitry Frenkel

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

[diff] [blame]

213

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

214

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

215

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

216

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

217

},

218

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

219

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

220

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

221

},

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

"value": "A String",

235

},

236

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

237

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

238

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

239

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

240

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

241

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

242

},

243

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

244

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

245

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

246

},

247

],

248

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

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>

254

<pre>Retrieves the next page of results.

255

256

Args:

257

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

258

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

259

260

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

261

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

Nathaniel Manista

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

[diff] [blame]

262

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]

267

<code class="details" id="markAsSpam">markAsSpam(id, x__xgafv=None)</code>

Dmitry Frenkel

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

[diff] [blame]

268

<pre>Expresses the caller's opinion that one or more comments should be flagged as spam.

Nathaniel Manista

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

[diff] [blame]

269

270

Args:

Bu Sun Kim

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

[diff] [blame]

271

id: string, Flags the comments with the given IDs as spam in the caller's opinion. (required) (repeated)

272

x__xgafv: string, V1 error format.

Nathaniel Manista

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

[diff] [blame]

273

Allowed values

Bu Sun Kim

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

[diff] [blame]

274

1 - v1 error format

275

2 - v2 error format

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]

280

<code class="details" id="setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)</code>

281

<pre>Sets the moderation status of one or more comments.

Nathaniel Manista

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

[diff] [blame]

282

283

Args:

Bu Sun Kim

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

[diff] [blame]

284

id: string, Modifies the moderation status of the comments with the given IDs (required) (repeated)

Dmitry Frenkel

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

[diff] [blame]

285

moderationStatus: string, Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: MODERATION_STATUS_PUBLISHED, MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED. (required)

286

Allowed values

287

published - The comment is available for public display.

288

heldForReview - The comment is awaiting review by a moderator.

289

likelySpam -

290

rejected - The comment is unfit for display.

291

banAuthor: boolean, If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.

Bu Sun Kim

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

[diff] [blame]

292

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

</pre>

</div>

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

301

<pre>Updates an existing resource.

302

303

Args:

Dmitry Frenkel

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

[diff] [blame]

304

part: string, The *part* parameter identifies the 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]

305

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

306

The object takes the form of:

307

Dmitry Frenkel

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

[diff] [blame]

308

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

309

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

310

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

311

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

312

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

313

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

Dmitry Frenkel

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

[diff] [blame]

314

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

315

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

316

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

Dmitry Frenkel

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

[diff] [blame]

317

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

318

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

319

"value": "A String",

320

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

321

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

322

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

323

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

324

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

325

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

326

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

Nathaniel Manista

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

[diff] [blame]

327

},

Dmitry Frenkel

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

[diff] [blame]

328

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

329

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

330

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

Nathaniel Manista

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

[diff] [blame]

331

}

332

Bu Sun Kim

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

[diff] [blame]

333

x__xgafv: string, V1 error format.

334

Allowed values

335

1 - v1 error format

336

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

337

338

Returns:

339

An object of the form:

340

Dmitry Frenkel

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

[diff] [blame]

341

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

342

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

343

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

344

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

345

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

346

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

Dmitry Frenkel

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

[diff] [blame]

347

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

348

"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.

349

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

Dmitry Frenkel

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

[diff] [blame]

350

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

351

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

352

"value": "A String",

353

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

354

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

355

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

356

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

357

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

358

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

359

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

Nathaniel Manista

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

[diff] [blame]

360

},

Dmitry Frenkel