OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.admin.reports_v1; | 3 library googleapis.admin.reports_v1; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
11 | 11 |
12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show | 12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show |
13 ApiRequestError, DetailedApiRequestError; | 13 ApiRequestError, DetailedApiRequestError; |
14 | 14 |
15 const core.String USER_AGENT = 'dart-api-client admin/reports_v1'; | 15 const core.String USER_AGENT = 'dart-api-client admin/reports_v1'; |
16 | 16 |
17 /** | 17 /** |
18 * Fetches reports for the administrators of Google Apps customers about the | 18 * Fetches reports for the administrators of G Suite customers about the usage, |
19 * usage, collaboration, security, and risk for their users. | 19 * collaboration, security, and risk for their users. |
20 */ | 20 */ |
21 class AdminApi { | 21 class AdminApi { |
22 /** View audit reports for your G Suite domain */ | 22 /** View audit reports for your G Suite domain */ |
23 static const AdminReportsAuditReadonlyScope = "https://www.googleapis.com/auth
/admin.reports.audit.readonly"; | 23 static const AdminReportsAuditReadonlyScope = "https://www.googleapis.com/auth
/admin.reports.audit.readonly"; |
24 | 24 |
25 /** View usage reports for your G Suite domain */ | 25 /** View usage reports for your G Suite domain */ |
26 static const AdminReportsUsageReadonlyScope = "https://www.googleapis.com/auth
/admin.reports.usage.readonly"; | 26 static const AdminReportsUsageReadonlyScope = "https://www.googleapis.com/auth
/admin.reports.usage.readonly"; |
27 | 27 |
28 | 28 |
29 final commons.ApiRequester _requester; | 29 final commons.ApiRequester _requester; |
(...skipping 19 matching lines...) Expand all Loading... |
49 * | 49 * |
50 * Request parameters: | 50 * Request parameters: |
51 * | 51 * |
52 * [userKey] - Represents the profile id or the user email for which the data | 52 * [userKey] - Represents the profile id or the user email for which the data |
53 * should be filtered. When 'all' is specified as the userKey, it returns | 53 * should be filtered. When 'all' is specified as the userKey, it returns |
54 * usageReports for all users. | 54 * usageReports for all users. |
55 * | 55 * |
56 * [applicationName] - Application name for which the events are to be | 56 * [applicationName] - Application name for which the events are to be |
57 * retrieved. | 57 * retrieved. |
58 * Value must have pattern | 58 * Value must have pattern |
59 * "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)". | 59 * "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)
". |
60 * | 60 * |
61 * [actorIpAddress] - IP Address of host where the event was performed. | 61 * [actorIpAddress] - IP Address of host where the event was performed. |
62 * Supports both IPv4 and IPv6 addresses. | 62 * Supports both IPv4 and IPv6 addresses. |
63 * | 63 * |
64 * [customerId] - Represents the customer for which the data is to be fetched. | 64 * [customerId] - Represents the customer for which the data is to be fetched. |
65 * Value must have pattern "C.+". | 65 * Value must have pattern "C.+". |
66 * | 66 * |
67 * [endTime] - Return events which occured at or before this time. | 67 * [endTime] - Return events which occurred at or before this time. |
68 * Value must have pattern | 68 * Value must have pattern |
69 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". | 69 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". |
70 * | 70 * |
71 * [eventName] - Name of the event being queried. | 71 * [eventName] - Name of the event being queried. |
72 * | 72 * |
73 * [filters] - Event parameters in the form [parameter1 | 73 * [filters] - Event parameters in the form [parameter1 |
74 * name][operator][parameter1 value],[parameter2 name][operator][parameter2 | 74 * name][operator][parameter1 value],[parameter2 name][operator][parameter2 |
75 * value],... | 75 * value],... |
76 * Value must have pattern "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)". | 76 * Value must have pattern "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)". |
77 * | 77 * |
78 * [maxResults] - Number of activity records to be shown in each page. | 78 * [maxResults] - Number of activity records to be shown in each page. |
79 * Value must be between "1" and "1000". | 79 * Value must be between "1" and "1000". |
80 * | 80 * |
81 * [pageToken] - Token to specify next page. | 81 * [pageToken] - Token to specify next page. |
82 * | 82 * |
83 * [startTime] - Return events which occured at or after this time. | 83 * [startTime] - Return events which occurred at or after this time. |
84 * Value must have pattern | 84 * Value must have pattern |
85 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". | 85 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". |
86 * | 86 * |
87 * Completes with a [Activities]. | 87 * Completes with a [Activities]. |
88 * | 88 * |
89 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 89 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
90 * error. | 90 * error. |
91 * | 91 * |
92 * If the used [http.Client] completes with an error when making a REST call, | 92 * If the used [http.Client] completes with an error when making a REST call, |
93 * this method will complete with the same error. | 93 * this method will complete with the same error. |
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
150 * | 150 * |
151 * Request parameters: | 151 * Request parameters: |
152 * | 152 * |
153 * [userKey] - Represents the profile id or the user email for which the data | 153 * [userKey] - Represents the profile id or the user email for which the data |
154 * should be filtered. When 'all' is specified as the userKey, it returns | 154 * should be filtered. When 'all' is specified as the userKey, it returns |
155 * usageReports for all users. | 155 * usageReports for all users. |
156 * | 156 * |
157 * [applicationName] - Application name for which the events are to be | 157 * [applicationName] - Application name for which the events are to be |
158 * retrieved. | 158 * retrieved. |
159 * Value must have pattern | 159 * Value must have pattern |
160 * "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)". | 160 * "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)
". |
161 * | 161 * |
162 * [actorIpAddress] - IP Address of host where the event was performed. | 162 * [actorIpAddress] - IP Address of host where the event was performed. |
163 * Supports both IPv4 and IPv6 addresses. | 163 * Supports both IPv4 and IPv6 addresses. |
164 * | 164 * |
165 * [customerId] - Represents the customer for which the data is to be fetched. | 165 * [customerId] - Represents the customer for which the data is to be fetched. |
166 * Value must have pattern "C.+". | 166 * Value must have pattern "C.+". |
167 * | 167 * |
168 * [endTime] - Return events which occured at or before this time. | 168 * [endTime] - Return events which occurred at or before this time. |
169 * Value must have pattern | 169 * Value must have pattern |
170 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". | 170 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". |
171 * | 171 * |
172 * [eventName] - Name of the event being queried. | 172 * [eventName] - Name of the event being queried. |
173 * | 173 * |
174 * [filters] - Event parameters in the form [parameter1 | 174 * [filters] - Event parameters in the form [parameter1 |
175 * name][operator][parameter1 value],[parameter2 name][operator][parameter2 | 175 * name][operator][parameter1 value],[parameter2 name][operator][parameter2 |
176 * value],... | 176 * value],... |
177 * Value must have pattern "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)". | 177 * Value must have pattern "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)". |
178 * | 178 * |
179 * [maxResults] - Number of activity records to be shown in each page. | 179 * [maxResults] - Number of activity records to be shown in each page. |
180 * Value must be between "1" and "1000". | 180 * Value must be between "1" and "1000". |
181 * | 181 * |
182 * [pageToken] - Token to specify next page. | 182 * [pageToken] - Token to specify next page. |
183 * | 183 * |
184 * [startTime] - Return events which occured at or after this time. | 184 * [startTime] - Return events which occurred at or after this time. |
185 * Value must have pattern | 185 * Value must have pattern |
186 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". | 186 * "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\
d):(\d\d))". |
187 * | 187 * |
188 * Completes with a [Channel]. | 188 * Completes with a [Channel]. |
189 * | 189 * |
190 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 190 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
191 * error. | 191 * error. |
192 * | 192 * |
193 * If the used [http.Client] completes with an error when making a REST call, | 193 * If the used [http.Client] completes with an error when making a REST call, |
194 * this method will complete with the same error. | 194 * this method will complete with the same error. |
(...skipping 120 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
315 * Value must have pattern "(\d){4}-(\d){2}-(\d){2}". | 315 * Value must have pattern "(\d){4}-(\d){2}-(\d){2}". |
316 * | 316 * |
317 * [customerId] - Represents the customer for which the data is to be fetched. | 317 * [customerId] - Represents the customer for which the data is to be fetched. |
318 * Value must have pattern "C.+". | 318 * Value must have pattern "C.+". |
319 * | 319 * |
320 * [pageToken] - Token to specify next page. | 320 * [pageToken] - Token to specify next page. |
321 * | 321 * |
322 * [parameters] - Represents the application name, parameter name pairs to | 322 * [parameters] - Represents the application name, parameter name pairs to |
323 * fetch in csv as app_name1:param_name1, app_name2:param_name2. | 323 * fetch in csv as app_name1:param_name1, app_name2:param_name2. |
324 * Value must have pattern | 324 * Value must have pattern |
325 * "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_mana
gement)):[^,]+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(
device_management)):[^,]+)". | 325 * "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_mana
gement)|(drive)):[^,]+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(
sites)|(device_management)|(drive)):[^,]+)". |
326 * | 326 * |
327 * Completes with a [UsageReports]. | 327 * Completes with a [UsageReports]. |
328 * | 328 * |
329 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 329 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
330 * error. | 330 * error. |
331 * | 331 * |
332 * If the used [http.Client] completes with an error when making a REST call, | 332 * If the used [http.Client] completes with an error when making a REST call, |
333 * this method will complete with the same error. | 333 * this method will complete with the same error. |
334 */ | 334 */ |
335 async.Future<UsageReports> get(core.String date, {core.String customerId, core
.String pageToken, core.String parameters}) { | 335 async.Future<UsageReports> get(core.String date, {core.String customerId, core
.String pageToken, core.String parameters}) { |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
386 * [date] - Represents the date in yyyy-mm-dd format for which the data is to | 386 * [date] - Represents the date in yyyy-mm-dd format for which the data is to |
387 * be fetched. | 387 * be fetched. |
388 * Value must have pattern "(\d){4}-(\d){2}-(\d){2}". | 388 * Value must have pattern "(\d){4}-(\d){2}-(\d){2}". |
389 * | 389 * |
390 * [customerId] - Represents the customer for which the data is to be fetched. | 390 * [customerId] - Represents the customer for which the data is to be fetched. |
391 * Value must have pattern "C.+". | 391 * Value must have pattern "C.+". |
392 * | 392 * |
393 * [filters] - Represents the set of filters including parameter operator | 393 * [filters] - Represents the set of filters including parameter operator |
394 * value. | 394 * value. |
395 * Value must have pattern | 395 * Value must have pattern |
396 * "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_mana
gement)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(cros)|(gmail)|(calenda
r)|(docs)|(gplus)|(sites)|(device_management)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)
". | 396 * "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_mana
gement)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(cros)|(gmail)|
(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,=
=,>=,>,!=][^,]+)". |
397 * | 397 * |
398 * [maxResults] - Maximum number of results to return. Maximum allowed is 1000 | 398 * [maxResults] - Maximum number of results to return. Maximum allowed is 1000 |
399 * | 399 * |
400 * [pageToken] - Token to specify next page. | 400 * [pageToken] - Token to specify next page. |
401 * | 401 * |
402 * [parameters] - Represents the application name, parameter name pairs to | 402 * [parameters] - Represents the application name, parameter name pairs to |
403 * fetch in csv as app_name1:param_name1, app_name2:param_name2. | 403 * fetch in csv as app_name1:param_name1, app_name2:param_name2. |
404 * Value must have pattern | 404 * Value must have pattern |
405 * "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_mana
gement)):[^,]+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(
device_management)):[^,]+)". | 405 * "(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_mana
gement)|(drive)):[^,]+,)*(((accounts)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(
sites)|(device_management)|(drive)):[^,]+)". |
406 * | 406 * |
407 * Completes with a [UsageReports]. | 407 * Completes with a [UsageReports]. |
408 * | 408 * |
409 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 409 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
410 * error. | 410 * error. |
411 * | 411 * |
412 * If the used [http.Client] completes with an error when making a REST call, | 412 * If the used [http.Client] completes with an error when making a REST call, |
413 * this method will complete with the same error. | 413 * this method will complete with the same error. |
414 */ | 414 */ |
415 async.Future<UsageReports> get(core.String userKey, core.String date, {core.St
ring customerId, core.String filters, core.int maxResults, core.String pageToken
, core.String parameters}) { | 415 async.Future<UsageReports> get(core.String userKey, core.String date, {core.St
ring customerId, core.String filters, core.int maxResults, core.String pageToken
, core.String parameters}) { |
(...skipping 738 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1154 } | 1154 } |
1155 if (usageReports != null) { | 1155 if (usageReports != null) { |
1156 _json["usageReports"] = usageReports.map((value) => (value).toJson()).toLi
st(); | 1156 _json["usageReports"] = usageReports.map((value) => (value).toJson()).toLi
st(); |
1157 } | 1157 } |
1158 if (warnings != null) { | 1158 if (warnings != null) { |
1159 _json["warnings"] = warnings.map((value) => (value).toJson()).toList(); | 1159 _json["warnings"] = warnings.map((value) => (value).toJson()).toList(); |
1160 } | 1160 } |
1161 return _json; | 1161 return _json; |
1162 } | 1162 } |
1163 } | 1163 } |
OLD | NEW |