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

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

[diff] [blame]

82

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

John Asmuth

614db98

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

[diff] [blame]

83

84

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

85

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

86

<h3>Method Details</h3>

87

Dmitry Frenkel

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

[diff] [blame]

88

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

89

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame^]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

John Asmuth

614db98

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

[diff] [blame]

95

96

Args:

Dmitry Frenkel

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

[diff] [blame]

97

part: string, The *part* parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set *part=snippet*, the API response will also contain all of those nested properties. (required) (repeated)

Bu Sun Kim

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

[diff] [blame]

98

mine: boolean, A parameter

Yoshi Automation Bot

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

[diff] [blame^]

99

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.

Bu Sun Kim

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

[diff] [blame]

100

home: boolean, A parameter

Yoshi Automation Bot

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

[diff] [blame^]

101

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

Bu Sun Kim

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

[diff] [blame]

102

regionCode: string, A parameter

Bu Sun Kim

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

[diff] [blame]

103

publishedAfter: string, A parameter

Yoshi Automation Bot

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

[diff] [blame^]

104

channelId: string, A parameter

105

publishedBefore: string, A parameter

Bu Sun Kim

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

[diff] [blame]

106

x__xgafv: string, V1 error format.

107

Allowed values

108

1 - v1 error format

109

2 - v2 error format

John Asmuth

614db98

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

[diff] [blame]

110

111

Returns:

112

An object of the form:

113

114

{

Bu Sun Kim

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

[diff] [blame]

115

"items": [

Dmitry Frenkel

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

[diff] [blame]

116

{ # An *activity* resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.

Bu Sun Kim

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

[diff] [blame]

117

"snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. Next ID: 12 # The snippet object contains basic details about the activity, including the activity's type and group ID.

Yoshi Automation Bot

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

[diff] [blame^]

118

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

Bu Sun Kim

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

[diff] [blame]

119

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

120

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

121

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

122

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

123

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

Dmitry Frenkel

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

[diff] [blame]

124

},

Bu Sun Kim

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

[diff] [blame]

125

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

126

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

127

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

128

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

129

},

130

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

131

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

132

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

133

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

134

},

135

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

136

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

137

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

138

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

139

},

Yoshi Automation Bot

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

[diff] [blame^]

140

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

141

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

142

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

143

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

144

},

Bu Sun Kim

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

[diff] [blame]

145

},

Bu Sun Kim

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

[diff] [blame]

146

"description": "A String", # The description of the resource primarily associated with the activity. @mutable youtube.activities.insert

Bu Sun Kim

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

[diff] [blame]

147

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

Yoshi Automation Bot

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

[diff] [blame^]

148

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

149

"groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.

150

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

151

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

Bu Sun Kim

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

[diff] [blame]

152

},

153

"contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.

Bu Sun Kim

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

[diff] [blame]

154

"recommendation": { # Information that identifies the recommended resource. # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.

Bu Sun Kim

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

[diff] [blame]

155

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource.

156

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

Bu Sun Kim

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

[diff] [blame]

157

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

158

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

Yoshi Automation Bot

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

[diff] [blame^]

159

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

Bu Sun Kim

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

[diff] [blame]

160

},

Yoshi Automation Bot

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

[diff] [blame^]

161

"seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation.

162

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

163

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

164

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

165

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

166

},

167

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

168

},

169

"playlistItem": { # Information about a new playlist item. # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.

170

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist.

171

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

172

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

173

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

174

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

175

},

176

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

177

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

Bu Sun Kim

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

[diff] [blame]

178

},

179

"social": { # Details about a social network post. # The social object contains details about a social network post. This property is only present if the snippet.type is social.

180

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

181

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

Bu Sun Kim

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

[diff] [blame]

182

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post.

183

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

Bu Sun Kim

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

[diff] [blame]

184

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

Dmitry Frenkel

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

[diff] [blame]

185

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

Yoshi Automation Bot

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

[diff] [blame^]

186

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

187

},

188

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

189

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

190

},

191

"favorite": { # Information about a video that was marked as a favorite video. # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.

192

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite.

193

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

194

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

195

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

196

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

Dmitry Frenkel

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

[diff] [blame]

197

},

198

},

199

"like": { # Information about a resource that received a positive (like) rating. # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.

200

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource.

201

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

Bu Sun Kim

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

[diff] [blame]

202

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

Dmitry Frenkel

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

[diff] [blame]

203

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

Yoshi Automation Bot

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

[diff] [blame^]

204

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

Dmitry Frenkel

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

[diff] [blame]

205

},

206

},

Yoshi Automation Bot

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

[diff] [blame^]

207

"channelItem": { # Details about a resource which was added to a channel. # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.

208

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel.

Dmitry Frenkel

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

[diff] [blame]

209

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

Dmitry Frenkel

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

[diff] [blame]

210

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

Dmitry Frenkel

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

[diff] [blame]

211

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

Dmitry Frenkel

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

[diff] [blame]

212

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

Dmitry Frenkel

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

[diff] [blame]

213

},

214

},

Bu Sun Kim

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

[diff] [blame]

215

"subscription": { # Information about a channel that a user subscribed to. # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.

216

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to.

Dmitry Frenkel

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

[diff] [blame]

217

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

Bu Sun Kim

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

[diff] [blame]

218

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

Dmitry Frenkel

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

[diff] [blame]

219

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

Yoshi Automation Bot

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

[diff] [blame^]

220

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

Dmitry Frenkel

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

[diff] [blame]

221

},

222

},

Bu Sun Kim

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

[diff] [blame]

223

"upload": { # Information about the uploaded video. # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.

224

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

Bu Sun Kim

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

[diff] [blame]

225

},

Yoshi Automation Bot

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

[diff] [blame^]

226

"bulletin": { # Details about a channel bulletin post. # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.

227

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post. @mutable youtube.activities.insert

228

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

229

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

230

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

231

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

232

},

233

},

234

"comment": { # Information about a resource that received a comment. # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.

235

"resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment.

236

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

237

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

238

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

239

"playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

240

},

241

},

242

"promotedItem": { # Details about a resource which is being promoted. # The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem.

243

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

244

"destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to visit the advertiser's website.

245

"impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.

246

"A String",

247

],

248

"forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.

249

"A String",

250

],

251

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

252

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

253

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

254

"clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through on this promoted item.

255

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

256

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

257

},

Bu Sun Kim

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

[diff] [blame]

258

},

Yoshi Automation Bot

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

[diff] [blame^]

259

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

260

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

261

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

Bu Sun Kim

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

[diff] [blame]

262

},

263

],

Yoshi Automation Bot

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

[diff] [blame^]

264

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

265

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

266

},

Dmitry Frenkel

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

[diff] [blame]

267

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

Dmitry Frenkel

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

[diff] [blame]

268

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

Bu Sun Kim