1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_reports_v1.html">Admin SDK API</a> . <a href="admin_reports_v1.activities.html">activities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(userKey, applicationName, actorIpAddress=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, orgUnitID=None, pageToken=None, startTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. </p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#watch">watch(userKey, applicationName, actorIpAddress=None, body=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, orgUnitID=None, pageToken=None, startTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Start receiving notifications for account activities. For more information, see Receiving Push Notifications.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(userKey, applicationName, actorIpAddress=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, orgUnitID=None, pageToken=None, startTime=None, x__xgafv=None)</code>
<pre>Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.
Args:
userKey: string, Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`. (required)
applicationName: string, Application name for which the events are to be retrieved. (required)
Allowed values
access_transparency - The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.
admin - The Admin console application's activity reports return account information about different types of administrator activity events.
calendar - The Google Calendar application's activity reports return information about various Calendar activity events.
chat - The Chat activity reports return information about various Chat activity events.
drive - The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Enterprise customers.
gcp - The Google Cloud Platform application's activity reports return information about various GCP activity events.
gmail - The Gmail application's activity reports return information about various [Gmail activity events](/admin-sdk/reports/v1/appendix/activity/gmail).
gplus - The Google+ application's activity reports return information about various Google+ activity events.
groups - The Google Groups application's activity reports return information about various Groups activity events.
groups_enterprise - The Enterprise Groups activity reports return information about various Enterprise group activity events.
jamboard - The Jamboard activity reports return information about various Jamboard activity events.
login - The Login application's activity reports return account information about different types of Login activity events.
meet - The Meet Audit activity report returns information about different types of Meet Audit activity events.
mobile - The Device Audit activity report returns information about different types of Device Audit activity events.
rules - The Rules activity report returns information about different types of Rules activity events.
saml - The SAML activity report returns information about different types of SAML activity events.
token - The Token application's activity reports return account information about different types of Token activity events.
user_accounts - The User Accounts application's activity reports return account information about different types of User Accounts activity events.
context_aware_access - The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.
chrome - The Chrome activity reports return information about Chrome browser and Chrome OS events.
data_studio - The Data Studio activity reports return information about various types of Data Studio activity events.
keep - The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers.
vault - The Vault activity reports return information about various types of Vault activity events.
gemini_in_workspace_apps - The Gemini for Workspace activity reports return information about various types of Gemini activity events performed by users within a Workspace application.
classroom - The Classroom activity reports return information about different types of [Classroom activity events](https://developers.google.com/workspace/admin/reports/v1/appendix/activity/classroom).
actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
customerId: string, The unique ID of the customer to retrieve data for.
endTime: string, Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days.
eventName: string, The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.
filters: string, The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request's parameter doesn't belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded in the request's query string (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—'equal to'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
groupIdFilter: string, Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)
maxResults: integer, Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
orgUnitID: string, ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.
pageToken: string, The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.
startTime: string, Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # JSON template for a collection of activities.
"etag": "A String", # ETag of the resource.
"items": [ # Each activity record in the response.
{ # JSON template for the activity resource.
"actor": { # User doing the action.
"applicationInfo": { # Details of the application that was the actor for the activity.
"applicationName": "A String", # Name of the application used to perform the action.
"impersonation": True or False, # Whether the application was impersonating a user.
"oauthClientId": "A String", # OAuth client id of the third party application used to perform the action.
},
"callerType": "A String", # The type of actor.
"email": "A String", # The primary email address of the actor. May be absent if there is no email address associated with the actor.
"key": "A String", # Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts.
"profileId": "A String", # The unique Google Workspace profile ID of the actor. This value might be absent if the actor is not a Google Workspace user, or may be the number 105250506097979753968 which acts as a placeholder ID.
},
"etag": "A String", # ETag of the entry.
"events": [ # Activity events in the report.
{
"name": "A String", # Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.
"parameters": [ # Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`.
{
"boolValue": True or False, # Boolean value of the parameter.
"intValue": "A String", # Integer value of the parameter.
"messageValue": { # Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`
"parameter": [ # Parameter values
{ # JSON template for a parameter used in various reports.
"boolValue": True or False, # Boolean value of the parameter.
"intValue": "A String", # Integer value of the parameter.
"multiBoolValue": [ # Multiple boolean values of the parameter.
True or False,
],
"multiIntValue": [ # Multiple integer values of the parameter.
"A String",
],
"multiValue": [ # Multiple string values of the parameter.
"A String",
],
"name": "A String", # The name of the parameter.
"value": "A String", # String value of the parameter.
},
],
},
"multiIntValue": [ # Integer values of the parameter.
"A String",
],
"multiMessageValue": [ # List of `messageValue` objects.
{
"parameter": [ # Parameter values
{ # JSON template for a parameter used in various reports.
"boolValue": True or False, # Boolean value of the parameter.
"intValue": "A String", # Integer value of the parameter.
"multiBoolValue": [ # Multiple boolean values of the parameter.
True or False,
],
"multiIntValue": [ # Multiple integer values of the parameter.
"A String",
],
"multiValue": [ # Multiple string values of the parameter.
"A String",
],
"name": "A String", # The name of the parameter.
"value": "A String", # String value of the parameter.
},
],
},
],
"multiValue": [ # String values of the parameter.
"A String",
],
"name": "A String", # The name of the parameter.
"value": "A String", # String value of the parameter.
},
],
"resourceIds": [ # Resource ids associated with the event.
"A String",
],
"type": "A String", # Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.
},
],
"id": { # Unique identifier for each activity record.
"applicationName": "A String", # Application name to which the event belongs. For possible values see the list of applications above in `applicationName`.
"customerId": "A String", # The unique identifier for a Google Workspace account.
"time": "A String", # Time of occurrence of the activity. This is in UNIX epoch time in seconds.
"uniqueQualifier": "A String", # Unique qualifier if multiple events have the same time.
},
"ipAddress": "A String", # IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.
"kind": "admin#reports#activity", # The type of API resource. For an activity report, the value is `audit#activity`.
"networkInfo": { # Network information of the user doing the action. # Network information of the user doing the action.
"ipAsn": [ # IP Address of the user doing the action.
42,
],
"regionCode": "A String", # ISO 3166-1 alpha-2 region code of the user doing the action.
"subdivisionCode": "A String", # ISO 3166-2 region code (states and provinces) for countries of the user doing the action.
},
"ownerDomain": "A String", # This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.
"resourceDetails": [ # Details of the resource on which the action was performed.
{ # Details of the resource on which the action was performed.
"appliedLabels": [ # List of labels applied on the resource
{ # Details of the label applied on the resource.
"fieldValues": [ # List of fields which are part of the label and have been set by the user. If label has a field which was not set by the user, it would not be present in this list.
{ # Details of the field value set by the user for the particular label.
"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Setting a date value.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"displayName": "A String", # Display name of the field
"id": "A String", # Identifier of the field
"integerValue": "A String", # Setting an integer value.
"longTextValue": "A String", # Setting a long text value.
"reason": { # The reason why the label/field was applied. # The reason why the field was applied to the label.
"reasonType": "A String", # The type of the reason.
},
"selectionListValue": { # Setting a selection list value by selecting multiple values from a dropdown. # Setting a selection list value by selecting multiple values from a dropdown.
"values": [ # List of selections.
{ # Setting a selection value by selecting a single value from a dropdown.
"badged": True or False, # Whether the selection is badged.
"displayName": "A String", # Display name of the selection.
"id": "A String", # Identifier of the selection.
},
],
},
"selectionValue": { # Setting a selection value by selecting a single value from a dropdown. # Setting a selection value by selecting a single value from a dropdown.
"badged": True or False, # Whether the selection is badged.
"displayName": "A String", # Display name of the selection.
"id": "A String", # Identifier of the selection.
},
"textListValue": { # Setting a text list value. # Setting a text list value.
"values": [ # List of text values.
"A String",
],
},
"textValue": "A String", # Setting a text value.
"type": "A String", # Type of the field
"unsetValue": True or False, # If the field is unset, this will be true.
"userListValue": { # Setting a user list value by selecting multiple users. # Setting a user list value by selecting multiple users.
"values": [ # List of users.
{ # Setting a user value by selecting a single user.
"email": "A String", # Email of the user.
},
],
},
"userValue": { # Setting a user value by selecting a single user. # Setting a user value by selecting a single user.
"email": "A String", # Email of the user.
},
},
],
"id": "A String", # Identifier of the label - Only the label id, not the full OnePlatform resource name.
"reason": { # The reason why the label/field was applied. # The reason why the label was applied on the resource.
"reasonType": "A String", # The type of the reason.
},
"title": "A String", # Title of the label
},
],
"id": "A String", # Identifier of the resource.
"relation": "A String", # Defines relationship of the resource to the events
"title": "A String", # Title of the resource. For instance, in case of a drive document, this would be the title of the document. In case of an email, this would be the subject.
"type": "A String", # Type of the resource - document, email, chat message
},
],
},
],
"kind": "admin#reports#activities", # The type of API resource. For an activity report, the value is `reports#activities`.
"nextPageToken": "A String", # Token for retrieving the follow-on next page of the report. The `nextPageToken` value is used in the request's `pageToken` query string.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="watch">watch(userKey, applicationName, actorIpAddress=None, body=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, orgUnitID=None, pageToken=None, startTime=None, x__xgafv=None)</code>
<pre>Start receiving notifications for account activities. For more information, see Receiving Push Notifications.
Args:
userKey: string, Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`. (required)
applicationName: string, Application name for which the events are to be retrieved. (required)
Allowed values
access_transparency - The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.
admin - The Admin console application's activity reports return account information about different types of administrator activity events.
calendar - The Google Calendar application's activity reports return information about various Calendar activity events.
chat - The Chat activity reports return information about various Chat activity events.
drive - The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Google Workspace Enterprise customers.
gcp - The Google Cloud Platform application's activity reports return information about various GCP activity events.
gplus - The Google+ application's activity reports return information about various Google+ activity events.
groups - The Google Groups application's activity reports return information about various Groups activity events.
groups_enterprise - The Enterprise Groups activity reports return information about various Enterprise group activity events.
jamboard - The Jamboard activity reports return information about various Jamboard activity events.
login - The Login application's activity reports return account information about different types of Login activity events.
meet - The Meet Audit activity report returns information about different types of Meet Audit activity events.
mobile - The Device Audit activity report returns information about different types of Device Audit activity events.
rules - The Rules activity report returns information about different types of Rules activity events.
saml - The SAML activity report returns information about different types of SAML activity events.
token - The Token application's activity reports return account information about different types of Token activity events.
user_accounts - The User Accounts application's activity reports return account information about different types of User Accounts activity events.
context_aware_access - The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.
chrome - The Chrome activity reports return information about Chrome browser and Chrome OS events.
data_studio - The Data Studio activity reports return information about various types of Data Studio activity events.
keep - The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers.
classroom - The Classroom activity reports return information about different types of [Classroom activity events](https://developers.google.com/workspace/admin/reports/v1/appendix/activity/classroom).
body: object, The request body.
The object takes the form of:
{ # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the request. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. The value should be set to `"web_hook"`.
}
actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
customerId: string, The unique ID of the customer to retrieve data for.
endTime: string, Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.
eventName: string, The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.
filters: string, The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request's parameter doesn't belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded in the request's query string (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—'equal to'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
groupIdFilter: string, `Deprecated`. This field is deprecated and is no longer supported. Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)
maxResults: integer, Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
orgUnitID: string, `Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.
pageToken: string, The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.
startTime: string, Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the request. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. The value should be set to `"web_hook"`.
}</pre>
</div>
</body></html>
|
