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

<code><a href="#list">list(part, mine=None, pageToken=None, publishedBefore=None, maxResults=None, home=None, channelId=None, regionCode=None, publishedAfter=None, x__xgafv=None)</a></code></p>

79

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

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

80

81

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

82

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

83

<h3>Method Details</h3>

84

Bu Sun Kim

d059ad8

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

[diff] [blame]

85

<code class="details" id="list">list(part, mine=None, pageToken=None, publishedBefore=None, maxResults=None, home=None, channelId=None, regionCode=None, publishedAfter=None, x__xgafv=None)</code>

86

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

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

87

88

Args:

Bu Sun Kim

d059ad8

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

[diff] [blame]

89

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

90

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

91

properties that the API response will include.<br><br>If the parameter

92

identifies a property that contains child properties, the child properties

93

will be included in the response. For example, in an <code>activity</code>

94

resource, the <code>snippet</code> property contains other properties that

95

identify the type of activity, a display title for the activity, and so

96

forth. If you set <code><strong>part=snippet</strong></code>, the API

97

response will also contain all of those nested properties. (required) (repeated)

98

mine: boolean, A parameter

99

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

100

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

101

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

102

identify other pages that could be retrieved.

103

publishedBefore: string, A parameter

104

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

105

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

106

home: boolean, A parameter

107

channelId: string, A parameter

108

regionCode: string, A parameter

109

publishedAfter: string, A parameter

110

x__xgafv: string, V1 error format.

111

Allowed values

112

1 - v1 error format

113

2 - v2 error format

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

114

115

Returns:

116

An object of the form:

117

118

{

Bu Sun Kim

d059ad8

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

[diff] [blame]

119

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

120

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

Bu Sun Kim

6502091

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

[diff] [blame]

121

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

122

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

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

123

},

Bu Sun Kim

d059ad8

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

[diff] [blame]

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

"items": [

134

{ # An <code><strong>activity</strong></code> resource contains

135

# information about an action that a particular channel, or user, has

136

# taken on YouTube.The actions reported in activity feeds include rating

137

# a video, sharing a video, marking a video as a favorite, commenting on

138

# a video, uploading a video, and so forth. Each <code>activity</code>

139

# resource identifies the type of action, the channel associated with

140

# the action, and the resource(s) associated with the action, such as

141

# the video that was rated or uploaded.

142

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

143

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

144

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

145

"contentDetails": { # Details about the content of an activity: the video that was shared, the # The <code>contentDetails</code> object contains information about the

146

# content associated with the activity. For example, if the

147

# <code>snippet.type</code> value is <code>videoRated</code>, then the

148

# <code>contentDetails</code> object's content identifies the rated video.

149

# channel that was subscribed to, etc.

150

"like": { # Information about a resource that received a positive (like) rating. # The <code>like</code> object contains information about a resource that

151

# received a positive (like) rating. This property is only present if

152

# the <code>snippet.type</code> is <code>like</code>.

153

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information that identifies

154

# the rated resource.

155

"kind": "A String", # The type of the API resource.

156

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

157

# that resource is a video. This property is only present if the

158

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

159

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

160

# that resource is a channel. This property is only present if the

161

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

162

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

163

# that resource is a playlist. This property is only present if the

164

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

165

},

166

},

167

"social": { # Details about a social network post. # The <code>social</code> object contains details about a social network

168

# post. This property is only present if the <code>snippet.type</code>

169

# is <code>social</code>.

170

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object encapsulates information that

171

# identifies the resource associated with a social network post.

172

"kind": "A String", # The type of the API resource.

173

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

174

# that resource is a video. This property is only present if the

175

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

176

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

177

# that resource is a channel. This property is only present if the

178

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

179

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

180

# that resource is a playlist. This property is only present if the

181

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

182

},

183

"author": "A String", # The author of the social network post.

184

"referenceUrl": "A String", # The URL of the social network post.

185

"type": "A String", # The name of the social network.

186

"imageUrl": "A String", # An image of the post's author.

187

},

188

"channelItem": { # Details about a resource which was added to a channel. # The <code>channelItem</code> object contains details about a resource

189

# which was added to a channel. This property is only present if the

190

# <code>snippet.type</code> is <code>channelItem</code>.

191

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information that

192

# identifies the resource that was added to the channel.

193

"kind": "A String", # The type of the API resource.

194

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

195

# that resource is a video. This property is only present if the

196

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

197

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

198

# that resource is a channel. This property is only present if the

199

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

200

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

201

# that resource is a playlist. This property is only present if the

202

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

203

},

204

},

205

"recommendation": { # Information that identifies the recommended resource. # The <code>recommendation</code> object contains information about a

206

# recommended resource. This property is only present if the

207

# <code>snippet.type</code> is <code>recommendation</code>.

208

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information that

209

# identifies the recommended resource.

210

"kind": "A String", # The type of the API resource.

211

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

212

# that resource is a video. This property is only present if the

213

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

214

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

215

# that resource is a channel. This property is only present if the

216

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

217

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

218

# that resource is a playlist. This property is only present if the

219

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

220

},

221

"reason": "A String", # The reason that the resource is recommended to the user.

222

"seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>seedResourceId</code> object contains information about

223

# the resource that caused the recommendation.

224

"kind": "A String", # The type of the API resource.

225

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

226

# that resource is a video. This property is only present if the

227

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

228

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

229

# that resource is a channel. This property is only present if the

230

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

231

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

232

# that resource is a playlist. This property is only present if the

233

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

234

},

235

},

236

"promotedItem": { # Details about a resource which is being promoted. # The <code>promotedItem</code> object contains details about a resource

237

# which is being promoted. This property is only present if the

238

# <code>snippet.type</code> is <code>promotedItem</code>.

239

"ctaType": "A String", # The type of call-to-action, a message to the user indicating action that

240

# can be taken.

241

"impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to

242

# indicate that the user was shown this promoted item.

243

"A String",

244

],

245

"adTag": "A String", # The URL the client should fetch to request a promoted item.

246

"clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through

247

# on this promoted item.

248

"descriptionText": "A String", # The text description to accompany the promoted item.

249

"creativeViewUrl": "A String", # The URL the client should ping to indicate that the user was shown this

250

# promoted item.

251

"destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to

252

# visit the advertiser's website.

253

"videoId": "A String", # The ID that YouTube uses to uniquely identify the promoted video.

254

"customCtaButtonText": "A String", # The custom call-to-action button text. If specified, it will override

255

# the default button text for the cta_type.

256

"forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs

257

# when a promoted item is not available, to indicate that a promoted item

258

# could have been shown.

"A String",

],

},

"subscription": { # Information about a channel that a user subscribed to. # The <code>subscription</code> object contains information about a

263

# channel that a user subscribed to. This property is only

264

# present if the <code>snippet.type</code> is <code>subscription</code>.

265

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information that

266

# identifies the resource that the user subscribed to.

267

"kind": "A String", # The type of the API resource.

268

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

269

# that resource is a video. This property is only present if the

270

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

271

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

272

# that resource is a channel. This property is only present if the

273

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

274

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

275

# that resource is a playlist. This property is only present if the

276

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

277

},

278

},

279

"favorite": { # Information about a video that was marked as a favorite video. # The <code>favorite</code> object contains information about a video that

280

# was marked as a favorite video. This property is only present if the

281

# <code>snippet.type</code> is <code>favorite</code>.

282

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information that

283

# identifies the resource that was marked as a favorite.

284

"kind": "A String", # The type of the API resource.

285

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

286

# that resource is a video. This property is only present if the

287

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

288

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

289

# that resource is a channel. This property is only present if the

290

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

291

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

292

# that resource is a playlist. This property is only present if the

293

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

294

},

295

},

296

"bulletin": { # Details about a channel bulletin post. # The <code>bulletin</code> object contains details about a channel

297

# bulletin post. This object is only present if the

298

# <code>snippet.type</code> is <code>bulletin</code>.

299

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information that

300

# identifies the resource associated with a bulletin post.

301

# @mutable youtube.activities.insert

302

"kind": "A String", # The type of the API resource.

303

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

304

# that resource is a video. This property is only present if the

305

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

306

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

307

# that resource is a channel. This property is only present if the

308

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

309

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

310

# that resource is a playlist. This property is only present if the

311

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

312

},

313

},

314

"comment": { # Information about a resource that received a comment. # The <code>comment</code> object contains information about a resource

315

# that received a comment. This property is only present if the

316

# <code>snippet.type</code> is <code>comment</code>.

317

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information that

318

# identifies the resource associated with the comment.

319

"kind": "A String", # The type of the API resource.

320

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

321

# that resource is a video. This property is only present if the

322

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

323

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

324

# that resource is a channel. This property is only present if the

325

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

326

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

327

# that resource is a playlist. This property is only present if the

328

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

329

},

330

},

331

"upload": { # Information about the uploaded video. # The <code>upload</code> object contains information about the uploaded

332

# video. This property is only present if the <code>snippet.type</code>

333

# is <code>upload</code>.

334

"videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video.

335

},

336

"playlistItem": { # Information about a new playlist item. # The <code>playlistItem</code> object contains information about a

337

# new playlist item. This property is only present if the

338

# <code>snippet.type</code> is <code>playlistItem</code>.

339

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>resourceId</code> object contains information about the

340

# resource that was added to the playlist.

341

"kind": "A String", # The type of the API resource.

342

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

343

# that resource is a video. This property is only present if the

344

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

345

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

346

# that resource is a channel. This property is only present if the

347

# <code>resourceId.kind</code> value is <code>youtube#channel</code>.

348

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

349

# that resource is a playlist. This property is only present if the

350

# <code>resourceId.kind</code> value is <code>youtube#playlist</code>.

351

},

352

"playlistItemId": "A String", # ID of the item within the playlist.

353

"playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist.

354

},

355

},

356

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

357

"snippet": { # Basic details about an activity, including title, description, thumbnails, # The <code>snippet</code> object contains basic details about the

358

# activity, including the activity's type and group ID.

359

# activity type and group.

360

# Next ID: 12

361

"title": "A String", # The title of the resource primarily associated with the activity.

362

"type": "A String", # The type of activity that the resource describes.

363

"groupId": "A String", # The group ID associated with the activity. A group ID identifies user

364

# events that are associated with the same user and resource. For example,

365

# if a user rates a video and marks the same video as a favorite, the

366

# entries for those events would have the same group ID in the user's

367

# activity feed. In your user interface, you can avoid repetition by

368

# grouping events with the same <code>groupId</code> value.

369

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated

370

# with the activity.

371

"channelTitle": "A String", # Channel title for the channel responsible for this activity

372

"description": "A String", # The description of the resource primarily associated with the activity.

373

# @mutable youtube.activities.insert

374

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily

375

# associated with the activity. For each object in the map, the key is the

376

# name of the thumbnail image, and the value is an object that contains

377

# other information about the thumbnail.

378

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

379

"width": 42, # (Optional) Width of the thumbnail image.

380

"url": "A String", # The thumbnail image's URL.

381

"height": 42, # (Optional) Height of the thumbnail image.

382

},

383

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

384

"width": 42, # (Optional) Width of the thumbnail image.

385

"url": "A String", # The thumbnail image's URL.

386

"height": 42, # (Optional) Height of the thumbnail image.

387

},

388

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

389

"width": 42, # (Optional) Width of the thumbnail image.

390

"url": "A String", # The thumbnail image's URL.

391

"height": 42, # (Optional) Height of the thumbnail image.

392

},

393

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

394

"width": 42, # (Optional) Width of the thumbnail image.

395

"url": "A String", # The thumbnail image's URL.

396

"height": 42, # (Optional) Height of the thumbnail image.

397

},

398

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

399

"width": 42, # (Optional) Width of the thumbnail image.

400

"url": "A String", # The thumbnail image's URL.

401

"height": 42, # (Optional) Height of the thumbnail image.

402

},

403

},

404

"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified

405

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

# format.

},

},

],

Bu Sun Kim

6502091

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

[diff] [blame]

410

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

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

},

}</pre>

</div>

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

417

<pre>Retrieves the next page of results.

418

419

Args:

420

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

421

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

422

423

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

424

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

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

425

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

</pre>

</div>

</body></html>