@maxim_mazurok/gapi.client.admin-reports_v1 0.1.20260316 → 0.2.20260316
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 +102 -20
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -359,11 +359,11 @@ declare namespace gapi.client {
|
|
|
359
359
|
/** Stop watching resources through this channel. */
|
|
360
360
|
stop(request: {
|
|
361
361
|
/** V1 error format. */
|
|
362
|
-
'$.xgafv'?:
|
|
362
|
+
'$.xgafv'?: '1' | '2';
|
|
363
363
|
/** OAuth access token. */
|
|
364
364
|
access_token?: string;
|
|
365
365
|
/** Data format for response. */
|
|
366
|
-
alt?:
|
|
366
|
+
alt?: 'json' | 'media' | 'proto';
|
|
367
367
|
/** JSONP */
|
|
368
368
|
callback?: string;
|
|
369
369
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -386,11 +386,11 @@ declare namespace gapi.client {
|
|
|
386
386
|
stop(
|
|
387
387
|
request: {
|
|
388
388
|
/** V1 error format. */
|
|
389
|
-
'$.xgafv'?:
|
|
389
|
+
'$.xgafv'?: '1' | '2';
|
|
390
390
|
/** OAuth access token. */
|
|
391
391
|
access_token?: string;
|
|
392
392
|
/** Data format for response. */
|
|
393
|
-
alt?:
|
|
393
|
+
alt?: 'json' | 'media' | 'proto';
|
|
394
394
|
/** JSONP */
|
|
395
395
|
callback?: string;
|
|
396
396
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -746,17 +746,55 @@ declare namespace gapi.client {
|
|
|
746
746
|
/** 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
747
|
list(request?: {
|
|
748
748
|
/** V1 error format. */
|
|
749
|
-
'$.xgafv'?:
|
|
749
|
+
'$.xgafv'?: '1' | '2';
|
|
750
750
|
/** OAuth access token. */
|
|
751
751
|
access_token?: string;
|
|
752
752
|
/** 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
753
|
actorIpAddress?: string;
|
|
754
754
|
/** Data format for response. */
|
|
755
|
-
alt?:
|
|
755
|
+
alt?: 'json' | 'media' | 'proto';
|
|
756
756
|
/** Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ``` */
|
|
757
757
|
applicationInfoFilter?: string;
|
|
758
758
|
/** Application name for which the events are to be retrieved. */
|
|
759
|
-
applicationName:
|
|
759
|
+
applicationName:
|
|
760
|
+
| 'access_transparency'
|
|
761
|
+
| 'admin'
|
|
762
|
+
| 'calendar'
|
|
763
|
+
| 'chat'
|
|
764
|
+
| 'drive'
|
|
765
|
+
| 'gcp'
|
|
766
|
+
| 'gmail'
|
|
767
|
+
| 'gplus'
|
|
768
|
+
| 'groups'
|
|
769
|
+
| 'groups_enterprise'
|
|
770
|
+
| 'jamboard'
|
|
771
|
+
| 'login'
|
|
772
|
+
| 'meet'
|
|
773
|
+
| 'mobile'
|
|
774
|
+
| 'rules'
|
|
775
|
+
| 'saml'
|
|
776
|
+
| 'token'
|
|
777
|
+
| 'user_accounts'
|
|
778
|
+
| 'context_aware_access'
|
|
779
|
+
| 'chrome'
|
|
780
|
+
| 'data_studio'
|
|
781
|
+
| 'keep'
|
|
782
|
+
| 'vault'
|
|
783
|
+
| 'gemini_in_workspace_apps'
|
|
784
|
+
| 'classroom'
|
|
785
|
+
| 'assignments'
|
|
786
|
+
| 'cloud_search'
|
|
787
|
+
| 'tasks'
|
|
788
|
+
| 'data_migration'
|
|
789
|
+
| 'meet_hardware'
|
|
790
|
+
| 'directory_sync'
|
|
791
|
+
| 'ldap'
|
|
792
|
+
| 'profile'
|
|
793
|
+
| 'access_evaluation'
|
|
794
|
+
| 'admin_data_action'
|
|
795
|
+
| 'contacts'
|
|
796
|
+
| 'takeout'
|
|
797
|
+
| 'graduation';
|
|
760
798
|
/** JSONP */
|
|
761
799
|
callback?: string;
|
|
762
800
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -803,15 +841,37 @@ declare namespace gapi.client {
|
|
|
803
841
|
/** Start receiving notifications for account activities. For more information, see Receiving Push Notifications. */
|
|
804
842
|
watch(request: {
|
|
805
843
|
/** V1 error format. */
|
|
806
|
-
'$.xgafv'?:
|
|
844
|
+
'$.xgafv'?: '1' | '2';
|
|
807
845
|
/** OAuth access token. */
|
|
808
846
|
access_token?: string;
|
|
809
847
|
/** 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
848
|
actorIpAddress?: string;
|
|
811
849
|
/** Data format for response. */
|
|
812
|
-
alt?:
|
|
850
|
+
alt?: 'json' | 'media' | 'proto';
|
|
813
851
|
/** Application name for which the events are to be retrieved. */
|
|
814
|
-
applicationName:
|
|
852
|
+
applicationName:
|
|
853
|
+
| 'access_transparency'
|
|
854
|
+
| 'admin'
|
|
855
|
+
| 'calendar'
|
|
856
|
+
| 'chat'
|
|
857
|
+
| 'drive'
|
|
858
|
+
| 'gcp'
|
|
859
|
+
| 'gplus'
|
|
860
|
+
| 'groups'
|
|
861
|
+
| 'groups_enterprise'
|
|
862
|
+
| 'jamboard'
|
|
863
|
+
| 'login'
|
|
864
|
+
| 'meet'
|
|
865
|
+
| 'mobile'
|
|
866
|
+
| 'rules'
|
|
867
|
+
| 'saml'
|
|
868
|
+
| 'token'
|
|
869
|
+
| 'user_accounts'
|
|
870
|
+
| 'context_aware_access'
|
|
871
|
+
| 'chrome'
|
|
872
|
+
| 'data_studio'
|
|
873
|
+
| 'keep'
|
|
874
|
+
| 'classroom';
|
|
815
875
|
/** JSONP */
|
|
816
876
|
callback?: string;
|
|
817
877
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -854,15 +914,37 @@ declare namespace gapi.client {
|
|
|
854
914
|
watch(
|
|
855
915
|
request: {
|
|
856
916
|
/** V1 error format. */
|
|
857
|
-
'$.xgafv'?:
|
|
917
|
+
'$.xgafv'?: '1' | '2';
|
|
858
918
|
/** OAuth access token. */
|
|
859
919
|
access_token?: string;
|
|
860
920
|
/** 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
921
|
actorIpAddress?: string;
|
|
862
922
|
/** Data format for response. */
|
|
863
|
-
alt?:
|
|
923
|
+
alt?: 'json' | 'media' | 'proto';
|
|
864
924
|
/** Application name for which the events are to be retrieved. */
|
|
865
|
-
applicationName:
|
|
925
|
+
applicationName:
|
|
926
|
+
| 'access_transparency'
|
|
927
|
+
| 'admin'
|
|
928
|
+
| 'calendar'
|
|
929
|
+
| 'chat'
|
|
930
|
+
| 'drive'
|
|
931
|
+
| 'gcp'
|
|
932
|
+
| 'gplus'
|
|
933
|
+
| 'groups'
|
|
934
|
+
| 'groups_enterprise'
|
|
935
|
+
| 'jamboard'
|
|
936
|
+
| 'login'
|
|
937
|
+
| 'meet'
|
|
938
|
+
| 'mobile'
|
|
939
|
+
| 'rules'
|
|
940
|
+
| 'saml'
|
|
941
|
+
| 'token'
|
|
942
|
+
| 'user_accounts'
|
|
943
|
+
| 'context_aware_access'
|
|
944
|
+
| 'chrome'
|
|
945
|
+
| 'data_studio'
|
|
946
|
+
| 'keep'
|
|
947
|
+
| 'classroom';
|
|
866
948
|
/** JSONP */
|
|
867
949
|
callback?: string;
|
|
868
950
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -907,11 +989,11 @@ declare namespace gapi.client {
|
|
|
907
989
|
/** 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
990
|
get(request?: {
|
|
909
991
|
/** V1 error format. */
|
|
910
|
-
'$.xgafv'?:
|
|
992
|
+
'$.xgafv'?: '1' | '2';
|
|
911
993
|
/** OAuth access token. */
|
|
912
994
|
access_token?: string;
|
|
913
995
|
/** Data format for response. */
|
|
914
|
-
alt?:
|
|
996
|
+
alt?: 'json' | 'media' | 'proto';
|
|
915
997
|
/** JSONP */
|
|
916
998
|
callback?: string;
|
|
917
999
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -942,11 +1024,11 @@ declare namespace gapi.client {
|
|
|
942
1024
|
/** 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
1025
|
get(request?: {
|
|
944
1026
|
/** V1 error format. */
|
|
945
|
-
'$.xgafv'?:
|
|
1027
|
+
'$.xgafv'?: '1' | '2';
|
|
946
1028
|
/** OAuth access token. */
|
|
947
1029
|
access_token?: string;
|
|
948
1030
|
/** Data format for response. */
|
|
949
|
-
alt?:
|
|
1031
|
+
alt?: 'json' | 'media' | 'proto';
|
|
950
1032
|
/** JSONP */
|
|
951
1033
|
callback?: string;
|
|
952
1034
|
/** The unique ID of the customer to retrieve data for. */
|
|
@@ -956,7 +1038,7 @@ declare namespace gapi.client {
|
|
|
956
1038
|
/** 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
1039
|
entityKey: string;
|
|
958
1040
|
/** Represents the type of entity for the report. */
|
|
959
|
-
entityType:
|
|
1041
|
+
entityType: 'gplus_communities';
|
|
960
1042
|
/** Selector specifying which fields to include in a partial response. */
|
|
961
1043
|
fields?: string;
|
|
962
1044
|
/** 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 +1067,11 @@ declare namespace gapi.client {
|
|
|
985
1067
|
/** 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
1068
|
get(request?: {
|
|
987
1069
|
/** V1 error format. */
|
|
988
|
-
'$.xgafv'?:
|
|
1070
|
+
'$.xgafv'?: '1' | '2';
|
|
989
1071
|
/** OAuth access token. */
|
|
990
1072
|
access_token?: string;
|
|
991
1073
|
/** Data format for response. */
|
|
992
|
-
alt?:
|
|
1074
|
+
alt?: 'json' | 'media' | 'proto';
|
|
993
1075
|
/** JSONP */
|
|
994
1076
|
callback?: string;
|
|
995
1077
|
/** The unique ID of the customer to retrieve data for. */
|