@maxim_mazurok/gapi.client.admin-reports_v1 0.0.20250626 → 0.0.20250714
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +25 -5
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://admin.googleapis.com/$discovery/rest?version=reports_v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250714
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -110,11 +110,21 @@ declare namespace gapi.client {
|
|
|
110
110
|
ipAddress?: string;
|
|
111
111
|
/** The type of API resource. For an activity report, the value is `audit#activity`. */
|
|
112
112
|
kind?: string;
|
|
113
|
+
/** Network information of the user doing the action. */
|
|
114
|
+
networkInfo?: ActivityNetworkInfo;
|
|
113
115
|
/** 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. */
|
|
114
116
|
ownerDomain?: string;
|
|
115
117
|
/** Details of the resource on which the action was performed. */
|
|
116
118
|
resourceDetails?: ResourceDetails[];
|
|
117
119
|
}
|
|
120
|
+
interface ActivityNetworkInfo {
|
|
121
|
+
/** IP Address of the user doing the action. */
|
|
122
|
+
ipAsn?: number[];
|
|
123
|
+
/** ISO 3166-1 alpha-2 region code of the user doing the action. */
|
|
124
|
+
regionCode?: string;
|
|
125
|
+
/** ISO 3166-2 region code (states and provinces) for countries of the user doing the action. */
|
|
126
|
+
subdivisionCode?: string;
|
|
127
|
+
}
|
|
118
128
|
interface AppliedLabel {
|
|
119
129
|
/** 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. */
|
|
120
130
|
fieldValues?: FieldValue[];
|
|
@@ -261,7 +271,7 @@ declare namespace gapi.client {
|
|
|
261
271
|
etag?: string;
|
|
262
272
|
/** The type of API resource. For a usage report, the value is `admin#reports#usageReport`. */
|
|
263
273
|
kind?: string;
|
|
264
|
-
/** Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin
|
|
274
|
+
/** Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities). */
|
|
265
275
|
parameters?: Array<{
|
|
266
276
|
/** Output only. Boolean value of the parameter. */
|
|
267
277
|
boolValue?: boolean;
|
|
@@ -443,11 +453,21 @@ declare namespace gapi.client {
|
|
|
443
453
|
ipAddress?: string;
|
|
444
454
|
/** The type of API resource. For an activity report, the value is `audit#activity`. */
|
|
445
455
|
kind?: string;
|
|
456
|
+
/** Network information of the user doing the action. */
|
|
457
|
+
networkInfo?: ActivityNetworkInfo;
|
|
446
458
|
/** 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. */
|
|
447
459
|
ownerDomain?: string;
|
|
448
460
|
/** Details of the resource on which the action was performed. */
|
|
449
461
|
resourceDetails?: ResourceDetails[];
|
|
450
462
|
}
|
|
463
|
+
interface ActivityNetworkInfo {
|
|
464
|
+
/** IP Address of the user doing the action. */
|
|
465
|
+
ipAsn?: number[];
|
|
466
|
+
/** ISO 3166-1 alpha-2 region code of the user doing the action. */
|
|
467
|
+
regionCode?: string;
|
|
468
|
+
/** ISO 3166-2 region code (states and provinces) for countries of the user doing the action. */
|
|
469
|
+
subdivisionCode?: string;
|
|
470
|
+
}
|
|
451
471
|
interface AppliedLabel {
|
|
452
472
|
/** 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. */
|
|
453
473
|
fieldValues?: FieldValue[];
|
|
@@ -594,7 +614,7 @@ declare namespace gapi.client {
|
|
|
594
614
|
etag?: string;
|
|
595
615
|
/** The type of API resource. For a usage report, the value is `admin#reports#usageReport`. */
|
|
596
616
|
kind?: string;
|
|
597
|
-
/** Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin
|
|
617
|
+
/** Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities). */
|
|
598
618
|
parameters?: Array<{
|
|
599
619
|
/** Output only. Boolean value of the parameter. */
|
|
600
620
|
boolValue?: boolean;
|
|
@@ -708,7 +728,7 @@ declare namespace gapi.client {
|
|
|
708
728
|
fields?: string;
|
|
709
729
|
/** 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. */
|
|
710
730
|
filters?: string;
|
|
711
|
-
/** 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) */
|
|
731
|
+
/** `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) */
|
|
712
732
|
groupIdFilter?: string;
|
|
713
733
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
714
734
|
key?: string;
|
|
@@ -759,7 +779,7 @@ declare namespace gapi.client {
|
|
|
759
779
|
fields?: string;
|
|
760
780
|
/** 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. */
|
|
761
781
|
filters?: string;
|
|
762
|
-
/** 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) */
|
|
782
|
+
/** `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) */
|
|
763
783
|
groupIdFilter?: string;
|
|
764
784
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
765
785
|
key?: string;
|