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

<code><a href="#list">list(drive_ancestorId=None, drive_fileId=None, groupingStrategy=None, pageSize=None, pageToken=None, source=None, userId=None)</a></code></p>

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.</p>

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[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

6502091

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

[diff] [blame^]

85

<code class="details" id="list">list(drive_ancestorId=None, drive_fileId=None, groupingStrategy=None, pageSize=None, pageToken=None, source=None, userId=None)</code>

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

86

<pre>Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

87

88

Args:

Bu Sun Kim

6502091

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

[diff] [blame^]

89

drive_ancestorId: string, Identifies the Drive folder containing the items for which to return activities.

90

drive_fileId: string, Identifies the Drive item to return activities for.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

91

groupingStrategy: string, Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.

92

Allowed values

93

driveUi -

94

none -

Bu Sun Kim

6502091

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

[diff] [blame^]

95

pageSize: integer, The maximum number of events to return on a page. The response includes a continuation token if there are more events.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

96

pageToken: string, A token to retrieve a specific page of results.

Bu Sun Kim

6502091

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

[diff] [blame^]

97

source: string, The Google service from which to return activities. Possible values of source are:

98

- drive.google.com

99

userId: string, The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

100

101

Returns:

102

An object of the form:

103

104

{ # The response from the list request. Contains a list of activities and a token to retrieve the next page of results.

Bu Sun Kim

6502091

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

[diff] [blame^]

105

"activities": [ # List of activities.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

106

{ # An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.

Bu Sun Kim

6502091

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

[diff] [blame^]

107

"combinedEvent": { # Represents the changes associated with an action taken by a user. # The fields common to all of the singleEvents that make up the Activity.

108

"additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.

109

"A String",

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

110

],

Bu Sun Kim

6502091

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

[diff] [blame^]

111

"eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.

112

"fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.

113

"move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.

114

"addedParents": [ # The added parent(s).

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

115

{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.

Bu Sun Kim

6502091

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

[diff] [blame^]

116

"id": "A String", # The parent's ID.

117

"isRoot": True or False, # Whether this is the root folder.

118

"title": "A String", # The parent's title.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

119

},

120

],

Bu Sun Kim

6502091

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

[diff] [blame^]

121

"removedParents": [ # The removed parent(s).

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

122

{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.

Bu Sun Kim

6502091

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

[diff] [blame^]

123

"id": "A String", # The parent's ID.

124

"isRoot": True or False, # Whether this is the root folder.

125

"title": "A String", # The parent's title.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

126

},

127

],

128

},

Bu Sun Kim

6502091

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

[diff] [blame^]

129

"permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.

130

{ # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.

131

"addedPermissions": [ # Lists all Permission objects added.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

132

{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.

Bu Sun Kim

6502091

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

[diff] [blame^]

133

"name": "A String", # The name of the user or group the permission applies to.

134

"permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.

135

"role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.

136

"type": "A String", # Indicates how widely permissions are granted.

137

"user": { # A representation of a user. # The user's information if the type is USER.

138

"isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.

139

"isMe": True or False, # Whether the user is the authenticated user.

140

"name": "A String", # The displayable name of the user.

141

"permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.

142

"photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.

143

"url": "A String", # The URL of the photo.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

144

},

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

145

},

Bu Sun Kim

6502091

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

[diff] [blame^]

146

"withLink": True or False, # Whether the permission requires a link to the file.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

147

},

148

],

Bu Sun Kim

6502091

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

[diff] [blame^]

149

"removedPermissions": [ # Lists all Permission objects removed.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

150

{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.

Bu Sun Kim

6502091

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

[diff] [blame^]

151

"name": "A String", # The name of the user or group the permission applies to.

152

"permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.

153

"role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.

154

"type": "A String", # Indicates how widely permissions are granted.

155

"user": { # A representation of a user. # The user's information if the type is USER.

156

"isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.

157

"isMe": True or False, # Whether the user is the authenticated user.

158

"name": "A String", # The displayable name of the user.

159

"permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.

160

"photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.

161

"url": "A String", # The URL of the photo.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

162

},

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

163

},

Bu Sun Kim

6502091

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

[diff] [blame^]

164

"withLink": True or False, # Whether the permission requires a link to the file.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

6502091

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

[diff] [blame^]

169

"primaryEventType": "A String", # The main type of event that occurred.

170

"rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.

171

"newTitle": "A String", # The new title.

172

"oldTitle": "A String", # The old title.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

173

},

Bu Sun Kim

6502091

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

[diff] [blame^]

174

"target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.

175

"id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.

176

"mimeType": "A String", # The MIME type of the target.

177

"name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.

178

},

179

"user": { # A representation of a user. # Represents the user responsible for the event.

180

"isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.

181

"isMe": True or False, # Whether the user is the authenticated user.

182

"name": "A String", # The displayable name of the user.

183

"permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.

184

"photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.

185

"url": "A String", # The URL of the photo.

186

},

187

},

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

188

},

Bu Sun Kim

6502091

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

[diff] [blame^]

189

"singleEvents": [ # A list of all the Events that make up the Activity.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

190

{ # Represents the changes associated with an action taken by a user.

Bu Sun Kim

6502091

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

[diff] [blame^]

191

"additionalEventTypes": [ # Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.

192

"A String",

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

193

],

Bu Sun Kim

6502091

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

[diff] [blame^]

194

"eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.

195

"fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.

196

"move": { # Contains information about changes in an object's parents as a result of a move type event. # Extra information for move type events, such as changes in an object's parents.

197

"addedParents": [ # The added parent(s).

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

198

{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.

Bu Sun Kim

6502091

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

[diff] [blame^]

199

"id": "A String", # The parent's ID.

200

"isRoot": True or False, # Whether this is the root folder.

201

"title": "A String", # The parent's title.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

202

},

203

],

Bu Sun Kim

6502091

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

[diff] [blame^]

204

"removedParents": [ # The removed parent(s).

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

205

{ # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.

Bu Sun Kim

6502091

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

[diff] [blame^]

206

"id": "A String", # The parent's ID.

207

"isRoot": True or False, # Whether this is the root folder.

208

"title": "A String", # The parent's title.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

209

},

210

],

211

},

Bu Sun Kim

6502091

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

[diff] [blame^]

212

"permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.

213

{ # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.

214

"addedPermissions": [ # Lists all Permission objects added.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

215

{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.

Bu Sun Kim

6502091

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

[diff] [blame^]

216

"name": "A String", # The name of the user or group the permission applies to.

217

"permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.

218

"role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.

219

"type": "A String", # Indicates how widely permissions are granted.

220

"user": { # A representation of a user. # The user's information if the type is USER.

221

"isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.

222

"isMe": True or False, # Whether the user is the authenticated user.

223

"name": "A String", # The displayable name of the user.

224

"permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.

225

"photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.

226

"url": "A String", # The URL of the photo.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

227

},

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

228

},

Bu Sun Kim

6502091

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

[diff] [blame^]

229

"withLink": True or False, # Whether the permission requires a link to the file.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

230

},

231

],

Bu Sun Kim

6502091

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

[diff] [blame^]

232

"removedPermissions": [ # Lists all Permission objects removed.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

233

{ # Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.

Bu Sun Kim

6502091

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

[diff] [blame^]

234

"name": "A String", # The name of the user or group the permission applies to.

235

"permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.

236

"role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.

237

"type": "A String", # Indicates how widely permissions are granted.

238

"user": { # A representation of a user. # The user's information if the type is USER.

239

"isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.

240

"isMe": True or False, # Whether the user is the authenticated user.

241

"name": "A String", # The displayable name of the user.

242

"permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.

243

"photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.

244

"url": "A String", # The URL of the photo.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

245

},

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

246

},

Bu Sun Kim

6502091

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

[diff] [blame^]

247

"withLink": True or False, # Whether the permission requires a link to the file.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

6502091

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

[diff] [blame^]

252

"primaryEventType": "A String", # The main type of event that occurred.

253

"rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.

254

"newTitle": "A String", # The new title.

255

"oldTitle": "A String", # The old title.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

256

},

Bu Sun Kim

6502091

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

[diff] [blame^]

257

"target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.

258

"id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.

259

"mimeType": "A String", # The MIME type of the target.

260

"name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.

261

},

262

"user": { # A representation of a user. # Represents the user responsible for the event.

263

"isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.

264

"isMe": True or False, # Whether the user is the authenticated user.

265

"name": "A String", # The displayable name of the user.

266

"permissionId": "A String", # The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.

267

"photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.

268

"url": "A String", # The URL of the photo.

269

},

270

},

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]