@maxim_mazurok/gapi.client.admin-reports_v1 0.1.20260316 → 0.2.20260317
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 +155 -21
- 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: 20260317
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -92,6 +92,31 @@ declare namespace gapi.client {
|
|
|
92
92
|
}>;
|
|
93
93
|
/** Resource ids associated with the event. */
|
|
94
94
|
resourceIds?: string[];
|
|
95
|
+
/** Includes sensitive parameter value pairs for various applications. */
|
|
96
|
+
sensitiveParameters?: Array<{
|
|
97
|
+
/** Boolean value of the parameter. */
|
|
98
|
+
boolValue?: boolean;
|
|
99
|
+
/** Integer value of the parameter. */
|
|
100
|
+
intValue?: string;
|
|
101
|
+
/** 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}]}]` */
|
|
102
|
+
messageValue?: {
|
|
103
|
+
/** Parameter values */
|
|
104
|
+
parameter?: NestedParameter[];
|
|
105
|
+
};
|
|
106
|
+
/** Integer values of the parameter. */
|
|
107
|
+
multiIntValue?: string[];
|
|
108
|
+
/** List of `messageValue` objects. */
|
|
109
|
+
multiMessageValue?: Array<{
|
|
110
|
+
/** Parameter values */
|
|
111
|
+
parameter?: NestedParameter[];
|
|
112
|
+
}>;
|
|
113
|
+
/** String values of the parameter. */
|
|
114
|
+
multiValue?: string[];
|
|
115
|
+
/** The name of the parameter. */
|
|
116
|
+
name?: string;
|
|
117
|
+
/** String value of the parameter. */
|
|
118
|
+
value?: string;
|
|
119
|
+
}>;
|
|
95
120
|
/** Status of the event. Note: Not all events have status. */
|
|
96
121
|
status?: ActivityEventsStatus;
|
|
97
122
|
/** 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`. */
|
|
@@ -359,11 +384,11 @@ declare namespace gapi.client {
|
|
|
359
384
|
/** Stop watching resources through this channel. */
|
|
360
385
|
stop(request: {
|
|
361
386
|
/** V1 error format. */
|
|
362
|
-
'$.xgafv'?:
|
|
387
|
+
'$.xgafv'?: '1' | '2';
|
|
363
388
|
/** OAuth access token. */
|
|
364
389
|
access_token?: string;
|
|
365
390
|
/** Data format for response. */
|
|
366
|
-
alt?:
|
|
391
|
+
alt?: 'json' | 'media' | 'proto';
|
|
367
392
|
/** JSONP */
|
|
368
393
|
callback?: string;
|
|
369
394
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -386,11 +411,11 @@ declare namespace gapi.client {
|
|
|
386
411
|
stop(
|
|
387
412
|
request: {
|
|
388
413
|
/** V1 error format. */
|
|
389
|
-
'$.xgafv'?:
|
|
414
|
+
'$.xgafv'?: '1' | '2';
|
|
390
415
|
/** OAuth access token. */
|
|
391
416
|
access_token?: string;
|
|
392
417
|
/** Data format for response. */
|
|
393
|
-
alt?:
|
|
418
|
+
alt?: 'json' | 'media' | 'proto';
|
|
394
419
|
/** JSONP */
|
|
395
420
|
callback?: string;
|
|
396
421
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -479,6 +504,31 @@ declare namespace gapi.client {
|
|
|
479
504
|
}>;
|
|
480
505
|
/** Resource ids associated with the event. */
|
|
481
506
|
resourceIds?: string[];
|
|
507
|
+
/** Includes sensitive parameter value pairs for various applications. */
|
|
508
|
+
sensitiveParameters?: Array<{
|
|
509
|
+
/** Boolean value of the parameter. */
|
|
510
|
+
boolValue?: boolean;
|
|
511
|
+
/** Integer value of the parameter. */
|
|
512
|
+
intValue?: string;
|
|
513
|
+
/** 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}]}]` */
|
|
514
|
+
messageValue?: {
|
|
515
|
+
/** Parameter values */
|
|
516
|
+
parameter?: NestedParameter[];
|
|
517
|
+
};
|
|
518
|
+
/** Integer values of the parameter. */
|
|
519
|
+
multiIntValue?: string[];
|
|
520
|
+
/** List of `messageValue` objects. */
|
|
521
|
+
multiMessageValue?: Array<{
|
|
522
|
+
/** Parameter values */
|
|
523
|
+
parameter?: NestedParameter[];
|
|
524
|
+
}>;
|
|
525
|
+
/** String values of the parameter. */
|
|
526
|
+
multiValue?: string[];
|
|
527
|
+
/** The name of the parameter. */
|
|
528
|
+
name?: string;
|
|
529
|
+
/** String value of the parameter. */
|
|
530
|
+
value?: string;
|
|
531
|
+
}>;
|
|
482
532
|
/** Status of the event. Note: Not all events have status. */
|
|
483
533
|
status?: ActivityEventsStatus;
|
|
484
534
|
/** 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`. */
|
|
@@ -746,17 +796,55 @@ declare namespace gapi.client {
|
|
|
746
796
|
/** 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. */
|
|
747
797
|
list(request?: {
|
|
748
798
|
/** V1 error format. */
|
|
749
|
-
'$.xgafv'?:
|
|
799
|
+
'$.xgafv'?: '1' | '2';
|
|
750
800
|
/** OAuth access token. */
|
|
751
801
|
access_token?: string;
|
|
752
802
|
/** 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. */
|
|
753
803
|
actorIpAddress?: string;
|
|
754
804
|
/** Data format for response. */
|
|
755
|
-
alt?:
|
|
805
|
+
alt?: 'json' | 'media' | 'proto';
|
|
756
806
|
/** Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ``` */
|
|
757
807
|
applicationInfoFilter?: string;
|
|
758
808
|
/** Application name for which the events are to be retrieved. */
|
|
759
|
-
applicationName:
|
|
809
|
+
applicationName:
|
|
810
|
+
| 'access_transparency'
|
|
811
|
+
| 'admin'
|
|
812
|
+
| 'calendar'
|
|
813
|
+
| 'chat'
|
|
814
|
+
| 'drive'
|
|
815
|
+
| 'gcp'
|
|
816
|
+
| 'gmail'
|
|
817
|
+
| 'gplus'
|
|
818
|
+
| 'groups'
|
|
819
|
+
| 'groups_enterprise'
|
|
820
|
+
| 'jamboard'
|
|
821
|
+
| 'login'
|
|
822
|
+
| 'meet'
|
|
823
|
+
| 'mobile'
|
|
824
|
+
| 'rules'
|
|
825
|
+
| 'saml'
|
|
826
|
+
| 'token'
|
|
827
|
+
| 'user_accounts'
|
|
828
|
+
| 'context_aware_access'
|
|
829
|
+
| 'chrome'
|
|
830
|
+
| 'data_studio'
|
|
831
|
+
| 'keep'
|
|
832
|
+
| 'vault'
|
|
833
|
+
| 'gemini_in_workspace_apps'
|
|
834
|
+
| 'classroom'
|
|
835
|
+
| 'assignments'
|
|
836
|
+
| 'cloud_search'
|
|
837
|
+
| 'tasks'
|
|
838
|
+
| 'data_migration'
|
|
839
|
+
| 'meet_hardware'
|
|
840
|
+
| 'directory_sync'
|
|
841
|
+
| 'ldap'
|
|
842
|
+
| 'profile'
|
|
843
|
+
| 'access_evaluation'
|
|
844
|
+
| 'admin_data_action'
|
|
845
|
+
| 'contacts'
|
|
846
|
+
| 'takeout'
|
|
847
|
+
| 'graduation';
|
|
760
848
|
/** JSONP */
|
|
761
849
|
callback?: string;
|
|
762
850
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -771,6 +859,8 @@ declare namespace gapi.client {
|
|
|
771
859
|
filters?: string;
|
|
772
860
|
/** 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) */
|
|
773
861
|
groupIdFilter?: string;
|
|
862
|
+
/** 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. */
|
|
863
|
+
includeSensitiveData?: boolean;
|
|
774
864
|
/** 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. */
|
|
775
865
|
key?: string;
|
|
776
866
|
/** 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. */
|
|
@@ -803,15 +893,37 @@ declare namespace gapi.client {
|
|
|
803
893
|
/** Start receiving notifications for account activities. For more information, see Receiving Push Notifications. */
|
|
804
894
|
watch(request: {
|
|
805
895
|
/** V1 error format. */
|
|
806
|
-
'$.xgafv'?:
|
|
896
|
+
'$.xgafv'?: '1' | '2';
|
|
807
897
|
/** OAuth access token. */
|
|
808
898
|
access_token?: string;
|
|
809
899
|
/** 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. */
|
|
810
900
|
actorIpAddress?: string;
|
|
811
901
|
/** Data format for response. */
|
|
812
|
-
alt?:
|
|
902
|
+
alt?: 'json' | 'media' | 'proto';
|
|
813
903
|
/** Application name for which the events are to be retrieved. */
|
|
814
|
-
applicationName:
|
|
904
|
+
applicationName:
|
|
905
|
+
| 'access_transparency'
|
|
906
|
+
| 'admin'
|
|
907
|
+
| 'calendar'
|
|
908
|
+
| 'chat'
|
|
909
|
+
| 'drive'
|
|
910
|
+
| 'gcp'
|
|
911
|
+
| 'gplus'
|
|
912
|
+
| 'groups'
|
|
913
|
+
| 'groups_enterprise'
|
|
914
|
+
| 'jamboard'
|
|
915
|
+
| 'login'
|
|
916
|
+
| 'meet'
|
|
917
|
+
| 'mobile'
|
|
918
|
+
| 'rules'
|
|
919
|
+
| 'saml'
|
|
920
|
+
| 'token'
|
|
921
|
+
| 'user_accounts'
|
|
922
|
+
| 'context_aware_access'
|
|
923
|
+
| 'chrome'
|
|
924
|
+
| 'data_studio'
|
|
925
|
+
| 'keep'
|
|
926
|
+
| 'classroom';
|
|
815
927
|
/** JSONP */
|
|
816
928
|
callback?: string;
|
|
817
929
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -854,15 +966,37 @@ declare namespace gapi.client {
|
|
|
854
966
|
watch(
|
|
855
967
|
request: {
|
|
856
968
|
/** V1 error format. */
|
|
857
|
-
'$.xgafv'?:
|
|
969
|
+
'$.xgafv'?: '1' | '2';
|
|
858
970
|
/** OAuth access token. */
|
|
859
971
|
access_token?: string;
|
|
860
972
|
/** 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. */
|
|
861
973
|
actorIpAddress?: string;
|
|
862
974
|
/** Data format for response. */
|
|
863
|
-
alt?:
|
|
975
|
+
alt?: 'json' | 'media' | 'proto';
|
|
864
976
|
/** Application name for which the events are to be retrieved. */
|
|
865
|
-
applicationName:
|
|
977
|
+
applicationName:
|
|
978
|
+
| 'access_transparency'
|
|
979
|
+
| 'admin'
|
|
980
|
+
| 'calendar'
|
|
981
|
+
| 'chat'
|
|
982
|
+
| 'drive'
|
|
983
|
+
| 'gcp'
|
|
984
|
+
| 'gplus'
|
|
985
|
+
| 'groups'
|
|
986
|
+
| 'groups_enterprise'
|
|
987
|
+
| 'jamboard'
|
|
988
|
+
| 'login'
|
|
989
|
+
| 'meet'
|
|
990
|
+
| 'mobile'
|
|
991
|
+
| 'rules'
|
|
992
|
+
| 'saml'
|
|
993
|
+
| 'token'
|
|
994
|
+
| 'user_accounts'
|
|
995
|
+
| 'context_aware_access'
|
|
996
|
+
| 'chrome'
|
|
997
|
+
| 'data_studio'
|
|
998
|
+
| 'keep'
|
|
999
|
+
| 'classroom';
|
|
866
1000
|
/** JSONP */
|
|
867
1001
|
callback?: string;
|
|
868
1002
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -907,11 +1041,11 @@ declare namespace gapi.client {
|
|
|
907
1041
|
/** Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides. */
|
|
908
1042
|
get(request?: {
|
|
909
1043
|
/** V1 error format. */
|
|
910
|
-
'$.xgafv'?:
|
|
1044
|
+
'$.xgafv'?: '1' | '2';
|
|
911
1045
|
/** OAuth access token. */
|
|
912
1046
|
access_token?: string;
|
|
913
1047
|
/** Data format for response. */
|
|
914
|
-
alt?:
|
|
1048
|
+
alt?: 'json' | 'media' | 'proto';
|
|
915
1049
|
/** JSONP */
|
|
916
1050
|
callback?: string;
|
|
917
1051
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -942,11 +1076,11 @@ declare namespace gapi.client {
|
|
|
942
1076
|
/** Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides. */
|
|
943
1077
|
get(request?: {
|
|
944
1078
|
/** V1 error format. */
|
|
945
|
-
'$.xgafv'?:
|
|
1079
|
+
'$.xgafv'?: '1' | '2';
|
|
946
1080
|
/** OAuth access token. */
|
|
947
1081
|
access_token?: string;
|
|
948
1082
|
/** Data format for response. */
|
|
949
|
-
alt?:
|
|
1083
|
+
alt?: 'json' | 'media' | 'proto';
|
|
950
1084
|
/** JSONP */
|
|
951
1085
|
callback?: string;
|
|
952
1086
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -956,7 +1090,7 @@ declare namespace gapi.client {
|
|
|
956
1090
|
/** Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides. */
|
|
957
1091
|
entityKey: string;
|
|
958
1092
|
/** Represents the type of entity for the report. */
|
|
959
|
-
entityType:
|
|
1093
|
+
entityType: 'gplus_communities';
|
|
960
1094
|
/** Selector specifying which fields to include in a partial response. */
|
|
961
1095
|
fields?: string;
|
|
962
1096
|
/** The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters. */
|
|
@@ -985,11 +1119,11 @@ declare namespace gapi.client {
|
|
|
985
1119
|
/** Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides. */
|
|
986
1120
|
get(request?: {
|
|
987
1121
|
/** V1 error format. */
|
|
988
|
-
'$.xgafv'?:
|
|
1122
|
+
'$.xgafv'?: '1' | '2';
|
|
989
1123
|
/** OAuth access token. */
|
|
990
1124
|
access_token?: string;
|
|
991
1125
|
/** Data format for response. */
|
|
992
|
-
alt?:
|
|
1126
|
+
alt?: 'json' | 'media' | 'proto';
|
|
993
1127
|
/** JSONP */
|
|
994
1128
|
callback?: string;
|
|
995
1129
|
/** The unique ID of the customer to retrieve data for. */
|