Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / appsactivity_v1.activities.html
blob: 4fceeae14c59041cd9b48f50faf66553c73e3398 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="appsactivity_v1.html">Google Apps Activity API</a> . <a href="appsactivity_v1.activities.html">activities</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(pageSize=None, source=None, groupingStrategy=None, userId=None, drive_ancestorId=None, pageToken=None, drive_fileId=None)</a></code></p>
79<p class="firstline">Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity 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>
80<p class="toc_element">
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<div class="method">
85 <code class="details" id="list">list(pageSize=None, source=None, groupingStrategy=None, userId=None, drive_ancestorId=None, pageToken=None, drive_fileId=None)</code>
86 <pre>Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity 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.
87
88Args:
89 pageSize: integer, The maximum number of events to return on a page. The response includes a continuation token if there are more events.
90 source: string, The Google service from which to return activities. Possible values of source are:
91- drive.google.com
92 groupingStrategy: string, Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.
93 Allowed values
94 driveUi -
95 none -
96 userId: string, Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.
97 drive_ancestorId: string, Identifies the Drive folder containing the items for which to return activities.
98 pageToken: string, A token to retrieve a specific page of results.
99 drive_fileId: string, Identifies the Drive item to return activities for.
100
101Returns:
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.
105 "nextPageToken": "A String", # Token for the next page of results.
106 "activities": [ # List of activities.
107 { # 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.
108 "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.
109 "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
110 "newTitle": "A String", # The new title.
111 "oldTitle": "A String", # The old title.
112 },
113 "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
114 "mimeType": "A String", # The MIME type of the target.
115 "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
116 "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
117 },
118 "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.
119 "A String",
120 ],
121 "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.
122 "removedParents": [ # The removed parent(s).
123 { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
124 "id": "A String", # The parent's ID.
125 "isRoot": True or False, # Whether this is the root folder.
126 "title": "A String", # The parent's title.
127 },
128 ],
129 "addedParents": [ # The added parent(s).
130 { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
131 "id": "A String", # The parent's ID.
132 "isRoot": True or False, # Whether this is the root folder.
133 "title": "A String", # The parent's title.
134 },
135 ],
136 },
137 "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
138 { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
139 "removedPermissions": [ # Lists all Permission objects removed.
140 { # 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.
141 "withLink": True or False, # Whether the permission requires a link to the file.
142 "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
143 "name": "A String", # The name of the user or group the permission applies to.
144 "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
145 "user": { # A representation of a user. # The user's information if the type is USER.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]146 "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]147 "url": "A String", # The URL of the photo.
148 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]149 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]150 "name": "A String", # The displayable name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]151 "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]152 },
153 "type": "A String", # Indicates how widely permissions are granted.
154 },
155 ],
156 "addedPermissions": [ # Lists all Permission objects added.
157 { # 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.
158 "withLink": True or False, # Whether the permission requires a link to the file.
159 "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
160 "name": "A String", # The name of the user or group the permission applies to.
161 "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
162 "user": { # A representation of a user. # The user's information if the type is USER.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]164 "url": "A String", # The URL of the photo.
165 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]166 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]167 "name": "A String", # The displayable name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]168 "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]169 },
170 "type": "A String", # Indicates how widely permissions are granted.
171 },
172 ],
173 },
174 ],
175 "user": { # A representation of a user. # Represents the user responsible for the event.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176 "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]177 "url": "A String", # The URL of the photo.
178 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]179 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]180 "name": "A String", # The displayable name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]181 "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 },
183 "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
184 "primaryEventType": "A String", # The main type of event that occurred.
185 "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
186 },
187 "singleEvents": [ # A list of all the Events that make up the Activity.
188 { # Represents the changes associated with an action taken by a user.
189 "rename": { # Contains information about a renametype event. # Extra information for rename type events, such as the old and new names.
190 "newTitle": "A String", # The new title.
191 "oldTitle": "A String", # The old title.
192 },
193 "target": { # Information about the object modified by the event. # Information specific to the Target object modified by the event.
194 "mimeType": "A String", # The MIME type of the target.
195 "id": "A String", # The ID of the target. For example, in Google Drive, this is the file or folder ID.
196 "name": "A String", # The name of the target. For example, in Google Drive, this is the title of the file.
197 },
198 "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.
199 "A String",
200 ],
201 "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.
202 "removedParents": [ # The removed parent(s).
203 { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
204 "id": "A String", # The parent's ID.
205 "isRoot": True or False, # Whether this is the root folder.
206 "title": "A String", # The parent's title.
207 },
208 ],
209 "addedParents": [ # The added parent(s).
210 { # Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.
211 "id": "A String", # The parent's ID.
212 "isRoot": True or False, # Whether this is the root folder.
213 "title": "A String", # The parent's title.
214 },
215 ],
216 },
217 "permissionChanges": [ # Extra information for permissionChange type events, such as the user or group the new permission applies to.
218 { # Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.
219 "removedPermissions": [ # Lists all Permission objects removed.
220 { # 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.
221 "withLink": True or False, # Whether the permission requires a link to the file.
222 "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
223 "name": "A String", # The name of the user or group the permission applies to.
224 "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
225 "user": { # A representation of a user. # The user's information if the type is USER.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]226 "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]227 "url": "A String", # The URL of the photo.
228 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]229 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]230 "name": "A String", # The displayable name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]231 "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]232 },
233 "type": "A String", # Indicates how widely permissions are granted.
234 },
235 ],
236 "addedPermissions": [ # Lists all Permission objects added.
237 { # 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.
238 "withLink": True or False, # Whether the permission requires a link to the file.
239 "permissionId": "A String", # The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.
240 "name": "A String", # The name of the user or group the permission applies to.
241 "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.
242 "user": { # A representation of a user. # The user's information if the type is USER.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]243 "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]244 "url": "A String", # The URL of the photo.
245 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]246 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]247 "name": "A String", # The displayable name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]248 "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]249 },
250 "type": "A String", # Indicates how widely permissions are granted.
251 },
252 ],
253 },
254 ],
255 "user": { # A representation of a user. # Represents the user responsible for the event.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]257 "url": "A String", # The URL of the photo.
258 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]259 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260 "name": "A String", # The displayable name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]261 "isDeleted": True or False, # A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]262 },
263 "eventTimeMillis": "A String", # The time at which the event occurred formatted as Unix time in milliseconds.
264 "primaryEventType": "A String", # The main type of event that occurred.
265 "fromUserDeletion": True or False, # Whether this event is caused by a user being deleted.
266 },
267 ],
268 },
269 ],
270 }</pre>
271</div>
272
273<div class="method">
274 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
275 <pre>Retrieves the next page of results.
276
277Args:
278 previous_request: The request for the previous page. (required)
279 previous_response: The response from the request for the previous page. (required)
280
281Returns:
282 A request object that you can call 'execute()' on to request the next
283 page. Returns None if there are no more items in the collection.
284 </pre>
285</div>
286
287</body></html>