Debian Codegraph @

docs/dyn/admin_reports_v1.activities.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="admin_reports_v1.html">Admin SDK API</a> . <a href="admin_reports_v1.activities.html">activities</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#list">list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, includeSensitiveData=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)</a></code></p>
82 <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>
83 <p class="toc_element">
84 <code><a href="#list_next">list_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <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>
88 <p class="firstline">Start receiving notifications for account activities. For more information, see Receiving Push Notifications.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="list">list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, includeSensitiveData=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)</code>
97 <pre>Retrieves a list of activities for a specific customer&#x27;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&#x27;s parameters, see the activity parameters reference guides.
98
99 Args:
100 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&#x27;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)
101 applicationName: string, Application name for which the events are to be retrieved. (required)
102 Allowed values
103 access_transparency - The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.
104 admin - The Admin console application&#x27;s activity reports return account information about different types of administrator activity events.
105 calendar - The Google Calendar application&#x27;s activity reports return information about various Calendar activity events.
106 chat - The Chat activity reports return information about various Chat activity events.
107 drive - The Google Drive application&#x27;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.
108 gcp - The Google Cloud Platform application&#x27;s activity reports return information about various GCP activity events.
109 gmail - The Gmail application&#x27;s activity reports return information about various [Gmail activity events](/admin-sdk/reports/v1/appendix/activity/gmail).
110 gplus - The Google+ application&#x27;s activity reports return information about various Google+ activity events.
111 groups - The Google Groups application&#x27;s activity reports return information about various Groups activity events.
112 groups_enterprise - The Enterprise Groups activity reports return information about various Enterprise group activity events.
113 jamboard - The Jamboard activity reports return information about various Jamboard activity events.
114 login - The Login application&#x27;s activity reports return account information about different types of Login activity events.
115 meet - The Meet Audit activity report returns information about different types of Meet Audit activity events.
116 mobile - The Device Audit activity report returns information about different types of Device Audit activity events.
117 rules - The Rules activity report returns information about different types of Rules activity events.
118 saml - The SAML activity report returns information about different types of SAML activity events.
119 token - The Token application&#x27;s activity reports return account information about different types of Token activity events.
120 user_accounts - The User Accounts application&#x27;s activity reports return account information about different types of User Accounts activity events.
121 context_aware_access - The Context-aware access activity reports return information about users&#x27; access denied events due to Context-aware access rules.
122 chrome - The Chrome activity reports return information about Chrome browser and Chrome OS events.
123 data_studio - The Data Studio activity reports return information about various types of Data Studio activity events.
124 keep - The Keep application&#x27;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.
125 vault - The Vault activity reports return information about various types of Vault activity events.
126 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.
127 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).
128 assignments - The assignments application&#x27;s activity reports return information about various types of assignments activity events.
129 cloud_search - The Cloud Search application&#x27;s activity reports return information about various types of cloud_search activity events.
130 tasks - The Tasks application&#x27;s activity reports return information about various types of Tasks activity events.
131 data_migration - The Data Migration application&#x27;s activity reports return information about various types of data migration activity events.
132 meet_hardware - The Meet Hardware application&#x27;s activity reports return information about various types of Meet Hardware activity events.
133 directory_sync - The Directory Sync application&#x27;s activity reports return information about various types of Directory Sync activity events.
134 ldap - The ldap application&#x27;s activity reports return information about various types of ldap activity events.
135 profile - The Profile application&#x27;s activity reports return information about various types of Profile activity events.
136 access_evaluation - The Access Evaluation activity reports return information about various types of Access Evaluation activity events.
137 admin_data_action - The Admin Data Action application&#x27;s activity reports return information about various types of Admin Data Action activity events.
138 contacts - The Contacts application&#x27;s activity reports return information about various types of Contacts activity events.
139 takeout - The Takeout application&#x27;s activity reports return information about various types of Takeout activity events.
140 graduation - The Graduation application&#x27;s activity reports return information about various types of Graduation activity events.
141 voice - The Voice application&#x27;s activity reports return information about various types of Voice activity events.
142 chrome_sync - The Chrome Sync application&#x27;s activity reports return information about various types of Chrome Sync activity events.
143 actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report&#x27;s summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user&#x27;s physical location. For example, the IP address can be the user&#x27;s proxy server&#x27;s address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
144 applicationInfoFilter: string, Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&amp;applicationInfoFilter=oAuthClientId=&quot;clientId&quot; GET...&amp;applicationInfoFilter=oAuthClientId=%22clientId%22 ```
145 customerId: string, The unique ID of the customer to retrieve data for.
146 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&#x27;s request for a report*: When the API created and retrieved the report. - *Report&#x27;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&#x27;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.
147 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&#x27;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`.
148 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&#x27;s parameter doesn&#x27;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 `&lt;&gt;` operator is URL-encoded in the request&#x27;s query string (`%3C%3E`): ``` GET...&amp;eventName=edit&amp;filters=doc_id==12345 GET...&amp;eventName=edit&amp;filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—&#x27;equal to&#x27;. * `&lt;&gt;`—&#x27;not equal to&#x27;. Must be URL-encoded (%3C%3E). * `&lt;`—&#x27;less than&#x27;. Must be URL-encoded (%3C). * `&lt;=`—&#x27;less than or equal to&#x27;. Must be URL-encoded (%3C=). * `&gt;`—&#x27;greater than&#x27;. Must be URL-encoded (%3E). * `&gt;=`—&#x27;greater than or equal to&#x27;. Must be URL-encoded (%3E=). **Note:** The API doesn&#x27;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.
149 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: &quot;id:abc123,id:xyz456&quot; *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)
150 includeSensitiveData: boolean, Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter is supported only for Rules (DLP) and Chat applications; using it with any other application will result in a permission error.
151 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&#x27;s `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
152 networkInfoFilter: string, Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&amp;networkInfoFilter=regionCode=&quot;IN&quot; GET...&amp;networkInfoFilter=regionCode=%22IN%22 ```
153 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&#x27;t appear in the filtered results.
154 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.
155 resourceDetailsFilter: string, Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) fields manipulated by relational operators. Resource Details Filters are in the form `{resourceDetails.field1}{relational operator}{field1 value} AND {resourceDetails.field2}{relational operator}{field2 value}...` All the inner fields are traversed using the `.` operator, as shown in the following example: ``` resourceDetails.id = &quot;resourceId&quot; AND resourceDetails.appliedLabels.id = &quot;appliedLabelId&quot; AND resourceDetails.appliedLabels.fieldValue.id = &quot;fieldValueId&quot; ``` `resourceDetailsFilter` query supports these relational operators: * `=`—&#x27;equal to&#x27;. * `!=`—&#x27;not equal to&#x27;. * `:`—&#x27;exists&#x27;. This is used for filtering on repeated fields. [`FieldValue`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#selectionlistvalue) contains `selection_id`: ``` resourceDetails.id = &quot;resourceId&quot; AND resourceDetails.appliedLabels.id = &quot;appliedLabelId&quot; AND resourceDetails.appliedLabels.fieldValue.id = &quot;fieldValueId&quot; AND resourceDetails.appliedLabels.fieldValue.type = &quot;SELECTION_LIST_VALUE&quot; AND resourceDetails.appliedLabels.fieldValue.selectionListValue.id: &quot;id&quot; ``` **Usage** ``` GET...&amp;resourceDetailsFilter=resourceDetails.id = &quot;resourceId&quot; AND resourceDetails.appliedLabels.id = &quot;appliedLabelId&quot; GET...&amp;resourceDetailsFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLabels.id=%22appliedLabelId%22 ``` **Note the following**: * You must URL encode the query string before sending the request. * The API supports a maximum of 5 fields separated by the AND operator. - When filtering on deeper levels (e.g., [`AppliedLabel`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#appliedlabel) ID and resourceDetails ID to be present. *Sample Query*: ``` resourceDetails.id = &quot;resourceId&quot; AND resourceDetails.appliedLabels.id = &quot;appliedLabelId&quot; AND resourceDetails.appliedLabels.fieldValue.id = &quot;fieldValueId&quot; ``` * Filtering on inner [`FieldValue`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported.
156 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.
157 statusFilter: string, Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&amp;statusFilter=statusCode=&quot;200&quot; GET...&amp;statusFilter=statusCode=%22200%22 ```
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163 Returns:
164 An object of the form:
165
166 { # JSON template for a collection of activities.
167 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
168 &quot;items&quot;: [ # Each activity record in the response.
169 { # JSON template for the activity resource.
170 &quot;actor&quot;: { # User doing the action.
171 &quot;applicationInfo&quot;: { # Details of the application that was the actor for the activity.
172 &quot;applicationName&quot;: &quot;A String&quot;, # Name of the application used to perform the action.
173 &quot;impersonation&quot;: True or False, # Whether the application was impersonating a user.
174 &quot;oauthClientId&quot;: &quot;A String&quot;, # OAuth client id of the third party application used to perform the action.
175 },
176 &quot;callerType&quot;: &quot;A String&quot;, # The type of actor.
177 &quot;email&quot;: &quot;A String&quot;, # The primary email address of the actor. May be absent if there is no email address associated with the actor.
178 &quot;key&quot;: &quot;A String&quot;, # 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.
179 &quot;profileId&quot;: &quot;A String&quot;, # 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.
180 },
181 &quot;etag&quot;: &quot;A String&quot;, # ETag of the entry.
182 &quot;events&quot;: [ # Activity events in the report.
183 {
184 &quot;name&quot;: &quot;A String&quot;, # 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&#x27;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`.
185 &quot;parameters&quot;: [ # Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`.
186 {
187 &quot;boolValue&quot;: True or False, # Boolean value of the parameter.
188 &quot;intValue&quot;: &quot;A String&quot;, # Integer value of the parameter.
189 &quot;messageValue&quot;: { # 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}]}]`
190 &quot;parameter&quot;: [ # Parameter values
191 { # JSON template for a parameter used in various reports.
192 &quot;boolValue&quot;: True or False, # Boolean value of the parameter.
193 &quot;intValue&quot;: &quot;A String&quot;, # Integer value of the parameter.
194 &quot;multiBoolValue&quot;: [ # Multiple boolean values of the parameter.
195 True or False,
196 ],
197 &quot;multiIntValue&quot;: [ # Multiple integer values of the parameter.
198 &quot;A String&quot;,
199 ],
200 &quot;multiValue&quot;: [ # Multiple string values of the parameter.
201 &quot;A String&quot;,
202 ],
203 &quot;name&quot;: &quot;A String&quot;, # The name of the parameter.
204 &quot;value&quot;: &quot;A String&quot;, # String value of the parameter.
205 },
206 ],
207 },
208 &quot;multiIntValue&quot;: [ # Integer values of the parameter.
209 &quot;A String&quot;,
210 ],
211 &quot;multiMessageValue&quot;: [ # List of `messageValue` objects.
212 {
213 &quot;parameter&quot;: [ # Parameter values
214 { # JSON template for a parameter used in various reports.
215 &quot;boolValue&quot;: True or False, # Boolean value of the parameter.
216 &quot;intValue&quot;: &quot;A String&quot;, # Integer value of the parameter.
217 &quot;multiBoolValue&quot;: [ # Multiple boolean values of the parameter.
218 True or False,
219 ],
220 &quot;multiIntValue&quot;: [ # Multiple integer values of the parameter.
221 &quot;A String&quot;,
222 ],
223 &quot;multiValue&quot;: [ # Multiple string values of the parameter.
224 &quot;A String&quot;,
225 ],
226 &quot;name&quot;: &quot;A String&quot;, # The name of the parameter.
227 &quot;value&quot;: &quot;A String&quot;, # String value of the parameter.
228 },
229 ],
230 },
231 ],
232 &quot;multiValue&quot;: [ # String values of the parameter.
233 &quot;A String&quot;,
234 ],
235 &quot;name&quot;: &quot;A String&quot;, # The name of the parameter.
236 &quot;value&quot;: &quot;A String&quot;, # String value of the parameter.
237 },
238 ],
239 &quot;resourceIds&quot;: [ # Resource ids associated with the event.
240 &quot;A String&quot;,
241 ],
242 &quot;sensitiveParameters&quot;: [ # Includes sensitive parameter value pairs for various applications.
243 {
244 &quot;boolValue&quot;: True or False, # Boolean value of the parameter.
245 &quot;intValue&quot;: &quot;A String&quot;, # Integer value of the parameter.
246 &quot;messageValue&quot;: { # 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}]}]`
247 &quot;parameter&quot;: [ # Parameter values
248 { # JSON template for a parameter used in various reports.
249 &quot;boolValue&quot;: True or False, # Boolean value of the parameter.
250 &quot;intValue&quot;: &quot;A String&quot;, # Integer value of the parameter.
251 &quot;multiBoolValue&quot;: [ # Multiple boolean values of the parameter.
252 True or False,
253 ],
254 &quot;multiIntValue&quot;: [ # Multiple integer values of the parameter.
255 &quot;A String&quot;,
256 ],
257 &quot;multiValue&quot;: [ # Multiple string values of the parameter.
258 &quot;A String&quot;,
259 ],
260 &quot;name&quot;: &quot;A String&quot;, # The name of the parameter.
261 &quot;value&quot;: &quot;A String&quot;, # String value of the parameter.
262 },
263 ],
264 },
265 &quot;multiIntValue&quot;: [ # Integer values of the parameter.
266 &quot;A String&quot;,
267 ],
268 &quot;multiMessageValue&quot;: [ # List of `messageValue` objects.
269 {
270 &quot;parameter&quot;: [ # Parameter values
271 { # JSON template for a parameter used in various reports.
272 &quot;boolValue&quot;: True or False, # Boolean value of the parameter.
273 &quot;intValue&quot;: &quot;A String&quot;, # Integer value of the parameter.
274 &quot;multiBoolValue&quot;: [ # Multiple boolean values of the parameter.
275 True or False,
276 ],
277 &quot;multiIntValue&quot;: [ # Multiple integer values of the parameter.
278 &quot;A String&quot;,
279 ],
280 &quot;multiValue&quot;: [ # Multiple string values of the parameter.
281 &quot;A String&quot;,
282 ],
283 &quot;name&quot;: &quot;A String&quot;, # The name of the parameter.
284 &quot;value&quot;: &quot;A String&quot;, # String value of the parameter.
285 },
286 ],
287 },
288 ],
289 &quot;multiValue&quot;: [ # String values of the parameter.
290 &quot;A String&quot;,
291 ],
292 &quot;name&quot;: &quot;A String&quot;, # The name of the parameter.
293 &quot;value&quot;: &quot;A String&quot;, # String value of the parameter.
294 },
295 ],
296 &quot;status&quot;: { # Status of the event. Note: Not all events have status. # Status of the event. Note: Not all events have status.
297 &quot;errorCode&quot;: &quot;A String&quot;, # Error code of the event. Note: Field can be empty.
298 &quot;errorMessage&quot;: &quot;A String&quot;, # Error message of the event. Note: Field can be empty.
299 &quot;eventStatus&quot;: &quot;A String&quot;, # Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS - SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED
300 &quot;httpStatusCode&quot;: 42, # Status code of the event. Note: Field can be empty.
301 },
302 &quot;type&quot;: &quot;A String&quot;, # 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&#x27;s `type` categories, see the list of event names for various applications above in `applicationName`.
303 },
304 ],
305 &quot;id&quot;: { # Unique identifier for each activity record.
306 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to which the event belongs. For possible values see the list of applications above in `applicationName`.
307 &quot;customerId&quot;: &quot;A String&quot;, # The unique identifier for a Google Workspace account.
308 &quot;time&quot;: &quot;A String&quot;, # Time of occurrence of the activity. This is in UNIX epoch time in seconds.
309 &quot;uniqueQualifier&quot;: &quot;A String&quot;, # Unique qualifier if multiple events have the same time.
310 },
311 &quot;ipAddress&quot;: &quot;A String&quot;, # 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&#x27;s physical location. For example, the IP address can be the user&#x27;s proxy server&#x27;s address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.
312 &quot;kind&quot;: &quot;admin#reports#activity&quot;, # The type of API resource. For an activity report, the value is `audit#activity`.
313 &quot;networkInfo&quot;: { # Network information of the user doing the action. # Network information of the user doing the action.
314 &quot;ipAsn&quot;: [ # IP Address of the user doing the action.
315 42,
316 ],
317 &quot;regionCode&quot;: &quot;A String&quot;, # ISO 3166-1 alpha-2 region code of the user doing the action.
318 &quot;subdivisionCode&quot;: &quot;A String&quot;, # ISO 3166-2 region code (states and provinces) for countries of the user doing the action.
319 },
320 &quot;ownerDomain&quot;: &quot;A String&quot;, # This is the domain that is affected by the report&#x27;s event. For example domain of Admin console or the Drive application&#x27;s document owner.
321 &quot;resourceDetails&quot;: [ # Details of the resource on which the action was performed.
322 { # Details of the resource on which the action was performed.
323 &quot;appliedLabels&quot;: [ # List of labels applied on the resource
324 { # Details of the label applied on the resource.
325 &quot;fieldValues&quot;: [ # 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.
326 { # Details of the field value set by the user for the particular label.
327 &quot;dateValue&quot;: { # 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.
328 &quot;day&quot;: 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&#x27;t significant.
329 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
330 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
331 },
332 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the field
333 &quot;id&quot;: &quot;A String&quot;, # Identifier of the field
334 &quot;integerValue&quot;: &quot;A String&quot;, # Setting an integer value.
335 &quot;longTextValue&quot;: &quot;A String&quot;, # Setting a long text value.
336 &quot;reason&quot;: { # The reason why the label/field was applied. # The reason why the field was applied to the label.
337 &quot;reasonType&quot;: &quot;A String&quot;, # The type of the reason.
338 },
339 &quot;selectionListValue&quot;: { # Setting a selection list value by selecting multiple values from a dropdown. # Setting a selection list value by selecting multiple values from a dropdown.
340 &quot;values&quot;: [ # List of selections.
341 { # Setting a selection value by selecting a single value from a dropdown.
342 &quot;badged&quot;: True or False, # Whether the selection is badged.
343 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the selection.
344 &quot;id&quot;: &quot;A String&quot;, # Identifier of the selection.
345 },
346 ],
347 },
348 &quot;selectionValue&quot;: { # Setting a selection value by selecting a single value from a dropdown. # Setting a selection value by selecting a single value from a dropdown.
349 &quot;badged&quot;: True or False, # Whether the selection is badged.
350 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the selection.
351 &quot;id&quot;: &quot;A String&quot;, # Identifier of the selection.
352 },
353 &quot;textListValue&quot;: { # Setting a text list value. # Setting a text list value.
354 &quot;values&quot;: [ # List of text values.
355 &quot;A String&quot;,
356 ],
357 },
358 &quot;textValue&quot;: &quot;A String&quot;, # Setting a text value.
359 &quot;type&quot;: &quot;A String&quot;, # Type of the field
360 &quot;unsetValue&quot;: True or False, # If the field is unset, this will be true.
361 &quot;userListValue&quot;: { # Setting a user list value by selecting multiple users. # Setting a user list value by selecting multiple users.
362 &quot;values&quot;: [ # List of users.
363 { # Setting a user value by selecting a single user.
364 &quot;email&quot;: &quot;A String&quot;, # Email of the user.
365 },
366 ],
367 },
368 &quot;userValue&quot;: { # Setting a user value by selecting a single user. # Setting a user value by selecting a single user.
369 &quot;email&quot;: &quot;A String&quot;, # Email of the user.
370 },
371 },
372 ],
373 &quot;id&quot;: &quot;A String&quot;, # Identifier of the label - Only the label id, not the full OnePlatform resource name.
374 &quot;reason&quot;: { # The reason why the label/field was applied. # The reason why the label was applied on the resource.
375 &quot;reasonType&quot;: &quot;A String&quot;, # The type of the reason.
376 },
377 &quot;title&quot;: &quot;A String&quot;, # Title of the label
378 },
379 ],
380 &quot;id&quot;: &quot;A String&quot;, # Identifier of the resource, such as a doc_id for a Drive document, a conference_id for a Meet conference, or a &quot;gaia_id/rfc2822_message_id&quot; for an email.
381 &quot;ownerDetails&quot;: { # Details of the owner of the resource. # Owner details of the resource.
382 &quot;ownerIdentity&quot;: [ # Identity details of the owner(s) of the resource.
383 { # Identity details of the owner of the resource.
384 &quot;customerIdentity&quot;: { # Identity of the Google Workspace customer who owns the resource. # Identity of the Google Workspace customer who owns the resource.
385 &quot;id&quot;: &quot;A String&quot;, # Customer id.
386 },
387 &quot;groupIdentity&quot;: { # Identity of the group who owns the resource. # Identity of the group who owns the resource.
388 &quot;groupEmail&quot;: &quot;A String&quot;, # Group email.
389 &quot;id&quot;: &quot;A String&quot;, # Group gaia id.
390 },
391 &quot;userIdentity&quot;: { # Identity of the user who owns the resource. # Identity of the user who owns the resource.
392 &quot;id&quot;: &quot;A String&quot;, # User gaia id.
393 &quot;userEmail&quot;: &quot;A String&quot;, # User email.
394 },
395 },
396 ],
397 &quot;ownerType&quot;: &quot;A String&quot;, # Type of the owner of the resource.
398 },
399 &quot;relation&quot;: &quot;A String&quot;, # Defines relationship of the resource to the events
400 &quot;title&quot;: &quot;A String&quot;, # 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.
401 &quot;type&quot;: &quot;A String&quot;, # Type of the resource - document, email, chat message
402 },
403 ],
404 },
405 ],
406 &quot;kind&quot;: &quot;admin#reports#activities&quot;, # The type of API resource. For an activity report, the value is `reports#activities`.
407 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token for retrieving the follow-on next page of the report. The `nextPageToken` value is used in the request&#x27;s `pageToken` query string.
408 }</pre>
409 </div>
410
411 <div class="method">
412 <code class="details" id="list_next">list_next()</code>
413 <pre>Retrieves the next page of results.
414
415 Args:
416 previous_request: The request for the previous page. (required)
417 previous_response: The response from the request for the previous page. (required)
418
419 Returns:
420 A request object that you can call &#x27;execute()&#x27; on to request the next
421 page. Returns None if there are no more items in the collection.
422 </pre>
423 </div>
424
425 <div class="method">
426 <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>
427 <pre>Start receiving notifications for account activities. For more information, see Receiving Push Notifications.
428
429 Args:
430 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&#x27;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)
431 applicationName: string, Application name for which the events are to be retrieved. (required)
432 Allowed values
433 access_transparency - The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.
434 admin - The Admin console application&#x27;s activity reports return account information about different types of administrator activity events.
435 calendar - The Google Calendar application&#x27;s activity reports return information about various Calendar activity events.
436 chat - The Chat activity reports return information about various Chat activity events.
437 drive - The Google Drive application&#x27;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.
438 gcp - The Google Cloud Platform application&#x27;s activity reports return information about various GCP activity events.
439 gplus - The Google+ application&#x27;s activity reports return information about various Google+ activity events.
440 groups - The Google Groups application&#x27;s activity reports return information about various Groups activity events.
441 groups_enterprise - The Enterprise Groups activity reports return information about various Enterprise group activity events.
442 jamboard - The Jamboard activity reports return information about various Jamboard activity events.
443 login - The Login application&#x27;s activity reports return account information about different types of Login activity events.
444 meet - The Meet Audit activity report returns information about different types of Meet Audit activity events.
445 mobile - The Device Audit activity report returns information about different types of Device Audit activity events.
446 rules - The Rules activity report returns information about different types of Rules activity events.
447 saml - The SAML activity report returns information about different types of SAML activity events.
448 token - The Token application&#x27;s activity reports return account information about different types of Token activity events.
449 user_accounts - The User Accounts application&#x27;s activity reports return account information about different types of User Accounts activity events.
450 context_aware_access - The Context-aware access activity reports return information about users&#x27; access denied events due to Context-aware access rules.
451 chrome - The Chrome activity reports return information about Chrome browser and Chrome OS events.
452 data_studio - The Data Studio activity reports return information about various types of Data Studio activity events.
453 keep - The Keep application&#x27;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.
454 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).
455 body: object, The request body.
456 The object takes the form of:
457
458 { # A notification channel used to watch for resource changes.
459 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
460 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
461 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
462 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;`api#channel`&quot;.
463 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
464 &quot;a_key&quot;: &quot;A String&quot;,
465 },
466 &quot;payload&quot;: 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.
467 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
468 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
469 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
470 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. The value should be set to `&quot;web_hook&quot;`.
471 }
472
473 actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report&#x27;s summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user&#x27;s physical location. For example, the IP address can be the user&#x27;s proxy server&#x27;s address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
474 customerId: string, The unique ID of the customer to retrieve data for.
475 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&#x27;s request for a report*: When the API created and retrieved the report. - *Report&#x27;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&#x27;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.
476 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&#x27;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`.
477 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&#x27;s parameter doesn&#x27;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 `&lt;&gt;` operator is URL-encoded in the request&#x27;s query string (`%3C%3E`): ``` GET...&amp;eventName=edit&amp;filters=doc_id==12345 GET...&amp;eventName=edit&amp;filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—&#x27;equal to&#x27;. * `&lt;&gt;`—&#x27;not equal to&#x27;. Must be URL-encoded (%3C%3E). * `&lt;`—&#x27;less than&#x27;. Must be URL-encoded (%3C). * `&lt;=`—&#x27;less than or equal to&#x27;. Must be URL-encoded (%3C=). * `&gt;`—&#x27;greater than&#x27;. Must be URL-encoded (%3E). * `&gt;=`—&#x27;greater than or equal to&#x27;. Must be URL-encoded (%3E=). **Note:** The API doesn&#x27;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.
478 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: &quot;id:abc123,id:xyz456&quot; *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)
479 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&#x27;s `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
480 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&#x27;t appear in the filtered results.
481 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.
482 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.
483 x__xgafv: string, V1 error format.
484 Allowed values
485 1 - v1 error format
486 2 - v2 error format
487
488 Returns:
489 An object of the form:
490
491 { # A notification channel used to watch for resource changes.
492 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
493 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
494 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
495 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;`api#channel`&quot;.
496 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
497 &quot;a_key&quot;: &quot;A String&quot;,
498 },
499 &quot;payload&quot;: 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.
500 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
501 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
502 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
503 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. The value should be set to `&quot;web_hook&quot;`.
504 }</pre>
505 </div>
506
507 </body></html>