google-api-client 0.51.0 → 0.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/release-please.yml +23 -45
- data/CHANGELOG.md +100 -0
- data/README.md +2 -2
- data/generated/google/apis/admin_datatransfer_v1.rb +2 -2
- data/generated/google/apis/admin_datatransfer_v1/classes.rb +6 -16
- data/generated/google/apis/admin_datatransfer_v1/service.rb +3 -3
- data/generated/google/apis/admin_directory_v1.rb +2 -2
- data/generated/google/apis/admin_directory_v1/classes.rb +453 -321
- data/generated/google/apis/admin_directory_v1/representations.rb +15 -15
- data/generated/google/apis/admin_directory_v1/service.rb +323 -183
- data/generated/google/apis/admin_reports_v1.rb +2 -2
- data/generated/google/apis/admin_reports_v1/classes.rb +48 -43
- data/generated/google/apis/admin_reports_v1/service.rb +198 -179
- data/generated/google/apis/alertcenter_v1beta1.rb +1 -1
- data/generated/google/apis/analytics_v3/service.rb +1 -1
- data/generated/google/apis/analyticsadmin_v1alpha.rb +1 -1
- data/generated/google/apis/analyticsadmin_v1alpha/classes.rb +2 -2
- data/generated/google/apis/analyticsadmin_v1alpha/service.rb +5 -12
- data/generated/google/apis/analyticsdata_v1alpha.rb +1 -1
- data/generated/google/apis/analyticsdata_v1alpha/classes.rb +11 -11
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/apigateway_v1beta.rb +1 -1
- data/generated/google/apis/apigateway_v1beta/classes.rb +3 -9
- data/generated/google/apis/apigateway_v1beta/representations.rb +0 -1
- data/generated/google/apis/apigee_v1.rb +1 -1
- data/generated/google/apis/apigee_v1/classes.rb +71 -0
- data/generated/google/apis/apigee_v1/representations.rb +42 -0
- data/generated/google/apis/apigee_v1/service.rb +206 -0
- data/generated/google/apis/appengine_v1.rb +1 -1
- data/generated/google/apis/appengine_v1/classes.rb +7 -0
- data/generated/google/apis/appengine_v1/representations.rb +1 -0
- data/generated/google/apis/artifactregistry_v1beta1.rb +1 -1
- data/generated/google/apis/artifactregistry_v1beta1/classes.rb +2 -2
- data/generated/google/apis/artifactregistry_v1beta1/service.rb +4 -1
- data/generated/google/apis/artifactregistry_v1beta2.rb +1 -1
- data/generated/google/apis/artifactregistry_v1beta2/classes.rb +2 -2
- data/generated/google/apis/artifactregistry_v1beta2/service.rb +4 -1
- data/generated/google/apis/cloudasset_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha2.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1/classes.rb +6 -0
- data/generated/google/apis/cloudfunctions_v1/representations.rb +1 -0
- data/generated/google/apis/cloudidentity_v1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1/classes.rb +240 -0
- data/generated/google/apis/cloudidentity_v1/representations.rb +125 -0
- data/generated/google/apis/cloudidentity_v1/service.rb +202 -2
- data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1beta1/service.rb +8 -2
- data/generated/google/apis/cloudkms_v1.rb +1 -1
- data/generated/google/apis/cloudkms_v1/classes.rb +0 -6
- data/generated/google/apis/cloudkms_v1/representations.rb +0 -1
- data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +19 -0
- data/generated/google/apis/cloudscheduler_v1beta1/representations.rb +2 -0
- data/generated/google/apis/cloudscheduler_v1beta1/service.rb +12 -2
- data/generated/google/apis/cloudtasks_v2beta2.rb +1 -1
- data/generated/google/apis/cloudtasks_v2beta2/classes.rb +59 -0
- data/generated/google/apis/cloudtasks_v2beta2/representations.rb +19 -0
- data/generated/google/apis/cloudtasks_v2beta3.rb +1 -1
- data/generated/google/apis/cloudtasks_v2beta3/classes.rb +102 -0
- data/generated/google/apis/cloudtasks_v2beta3/representations.rb +35 -0
- data/generated/google/apis/cloudtasks_v2beta3/service.rb +16 -2
- data/generated/google/apis/composer_v1beta1.rb +1 -1
- data/generated/google/apis/composer_v1beta1/classes.rb +64 -0
- data/generated/google/apis/composer_v1beta1/representations.rb +18 -0
- data/generated/google/apis/compute_alpha.rb +1 -1
- data/generated/google/apis/compute_alpha/classes.rb +1071 -341
- data/generated/google/apis/compute_alpha/representations.rb +248 -19
- data/generated/google/apis/compute_alpha/service.rb +291 -15
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +926 -283
- data/generated/google/apis/compute_beta/representations.rb +221 -18
- data/generated/google/apis/compute_beta/service.rb +24 -15
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +419 -158
- data/generated/google/apis/compute_v1/representations.rb +55 -0
- data/generated/google/apis/compute_v1/service.rb +9 -7
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +48 -9
- data/generated/google/apis/container_v1/representations.rb +17 -0
- data/generated/google/apis/container_v1/service.rb +4 -2
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +24 -13
- data/generated/google/apis/container_v1beta1/representations.rb +2 -0
- data/generated/google/apis/container_v1beta1/service.rb +6 -2
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +16 -7
- data/generated/google/apis/content_v2_1/representations.rb +1 -0
- data/generated/google/apis/datamigration_v1beta1.rb +1 -1
- data/generated/google/apis/datamigration_v1beta1/classes.rb +0 -6
- data/generated/google/apis/datamigration_v1beta1/representations.rb +0 -1
- data/generated/google/apis/deploymentmanager_alpha.rb +6 -5
- data/generated/google/apis/deploymentmanager_alpha/classes.rb +276 -644
- data/generated/google/apis/deploymentmanager_alpha/representations.rb +10 -143
- data/generated/google/apis/deploymentmanager_alpha/service.rb +247 -398
- data/generated/google/apis/deploymentmanager_v2.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2/service.rb +5 -25
- data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta/service.rb +8 -40
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2/classes.rb +692 -0
- data/generated/google/apis/dialogflow_v2/representations.rb +326 -0
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +692 -0
- data/generated/google/apis/dialogflow_v2beta1/representations.rb +326 -0
- data/generated/google/apis/{bigqueryreservation_v1alpha2.rb → dialogflow_v3.rb} +13 -12
- data/generated/google/apis/dialogflow_v3/classes.rb +8943 -0
- data/generated/google/apis/dialogflow_v3/representations.rb +3773 -0
- data/generated/google/apis/dialogflow_v3/service.rb +3006 -0
- data/generated/google/apis/dialogflow_v3beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v3beta1/classes.rb +784 -0
- data/generated/google/apis/dialogflow_v3beta1/representations.rb +360 -0
- data/generated/google/apis/dialogflow_v3beta1/service.rb +173 -0
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/dlp_v2/service.rb +294 -1
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v1/classes.rb +65 -0
- data/generated/google/apis/dns_v1/representations.rb +32 -0
- data/generated/google/apis/documentai_v1beta2.rb +1 -1
- data/generated/google/apis/documentai_v1beta2/classes.rb +220 -102
- data/generated/google/apis/documentai_v1beta2/representations.rb +105 -9
- data/generated/google/apis/documentai_v1beta3.rb +1 -1
- data/generated/google/apis/documentai_v1beta3/classes.rb +241 -117
- data/generated/google/apis/documentai_v1beta3/representations.rb +105 -9
- data/generated/google/apis/documentai_v1beta3/service.rb +81 -2
- data/generated/google/apis/eventarc_v1beta1.rb +1 -1
- data/generated/google/apis/eventarc_v1beta1/classes.rb +8 -9
- data/generated/google/apis/eventarc_v1beta1/service.rb +25 -5
- data/generated/google/apis/file_v1.rb +1 -1
- data/generated/google/apis/file_v1/classes.rb +61 -0
- data/generated/google/apis/file_v1/representations.rb +19 -0
- data/generated/google/apis/genomics_v2alpha1.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1/classes.rb +11 -7
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/classes.rb +0 -6
- data/generated/google/apis/healthcare_v1/representations.rb +0 -1
- data/generated/google/apis/healthcare_v1/service.rb +13 -12
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +45 -19
- data/generated/google/apis/healthcare_v1beta1/representations.rb +3 -1
- data/generated/google/apis/healthcare_v1beta1/service.rb +37 -37
- data/generated/google/apis/iap_v1.rb +1 -1
- data/generated/google/apis/iap_v1/classes.rb +0 -6
- data/generated/google/apis/iap_v1/representations.rb +0 -1
- data/generated/google/apis/iap_v1beta1.rb +1 -1
- data/generated/google/apis/iap_v1beta1/classes.rb +0 -6
- data/generated/google/apis/iap_v1beta1/representations.rb +0 -1
- data/generated/google/apis/metastore_v1beta.rb +35 -0
- data/generated/google/apis/metastore_v1beta/classes.rb +1151 -0
- data/generated/google/apis/metastore_v1beta/representations.rb +479 -0
- data/generated/google/apis/metastore_v1beta/service.rb +800 -0
- data/generated/google/apis/ml_v1.rb +1 -1
- data/generated/google/apis/ml_v1/classes.rb +51 -18
- data/generated/google/apis/ml_v1/representations.rb +16 -0
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +8 -4
- data/generated/google/apis/privateca_v1beta1.rb +1 -1
- data/generated/google/apis/privateca_v1beta1/classes.rb +2 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +37 -0
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +18 -0
- data/generated/google/apis/recommender_v1beta1.rb +1 -1
- data/generated/google/apis/recommender_v1beta1/service.rb +317 -0
- data/generated/google/apis/redis_v1.rb +1 -1
- data/generated/google/apis/redis_v1/classes.rb +2 -2
- data/generated/google/apis/redis_v1beta1.rb +1 -1
- data/generated/google/apis/redis_v1beta1/classes.rb +2 -2
- data/generated/google/apis/safebrowsing_v4.rb +1 -1
- data/generated/google/apis/safebrowsing_v4/classes.rb +277 -277
- data/generated/google/apis/safebrowsing_v4/representations.rb +128 -128
- data/generated/google/apis/safebrowsing_v4/service.rb +44 -44
- data/generated/google/apis/searchconsole_v1.rb +1 -1
- data/generated/google/apis/searchconsole_v1/classes.rb +7 -0
- data/generated/google/apis/searchconsole_v1/representations.rb +1 -0
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +11 -10
- data/generated/google/apis/servicecontrol_v1.rb +3 -3
- data/generated/google/apis/servicecontrol_v1/service.rb +2 -2
- data/generated/google/apis/servicecontrol_v2.rb +3 -3
- data/generated/google/apis/servicecontrol_v2/service.rb +2 -2
- data/generated/google/apis/servicedirectory_v1.rb +35 -0
- data/generated/google/apis/servicedirectory_v1/classes.rb +721 -0
- data/generated/google/apis/servicedirectory_v1/representations.rb +304 -0
- data/generated/google/apis/servicedirectory_v1/service.rb +957 -0
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +1 -1
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +11 -10
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +11 -10
- data/generated/google/apis/slides_v1.rb +1 -1
- data/generated/google/apis/slides_v1/classes.rb +9 -3
- data/generated/google/apis/speech_v1p1beta1.rb +1 -1
- data/generated/google/apis/speech_v1p1beta1/classes.rb +0 -22
- data/generated/google/apis/speech_v1p1beta1/representations.rb +0 -2
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/testing_v1/classes.rb +1 -1
- data/generated/google/apis/trafficdirector_v2.rb +2 -2
- data/generated/google/apis/trafficdirector_v2/service.rb +1 -1
- data/generated/google/apis/transcoder_v1beta1.rb +1 -1
- data/generated/google/apis/transcoder_v1beta1/classes.rb +12 -2
- data/generated/google/apis/transcoder_v1beta1/representations.rb +1 -0
- data/generated/google/apis/translate_v3.rb +1 -1
- data/generated/google/apis/translate_v3/classes.rb +1 -1
- data/generated/google/apis/translate_v3beta1.rb +1 -1
- data/generated/google/apis/translate_v3beta1/classes.rb +1 -1
- data/generated/google/apis/workflows_v1beta.rb +1 -1
- data/generated/google/apis/workflows_v1beta/classes.rb +4 -4
- data/lib/google/apis/version.rb +1 -1
- metadata +15 -7
- data/generated/google/apis/bigqueryreservation_v1alpha2/classes.rb +0 -426
- data/generated/google/apis/bigqueryreservation_v1alpha2/representations.rb +0 -195
- data/generated/google/apis/bigqueryreservation_v1alpha2/service.rb +0 -622
@@ -18,7 +18,7 @@ require 'google/apis/admin_reports_v1/representations.rb'
|
|
18
18
|
|
19
19
|
module Google
|
20
20
|
module Apis
|
21
|
-
# Admin SDK
|
21
|
+
# Admin SDK API
|
22
22
|
#
|
23
23
|
# Admin SDK lets administrators of enterprise domains to view and manage
|
24
24
|
# resources like user, groups etc. It also provides audit and usage reports of
|
@@ -27,7 +27,7 @@ module Google
|
|
27
27
|
# @see http://developers.google.com/admin-sdk/
|
28
28
|
module AdminReportsV1
|
29
29
|
VERSION = 'ReportsV1'
|
30
|
-
REVISION = '
|
30
|
+
REVISION = '20201208'
|
31
31
|
|
32
32
|
# View audit reports for your G Suite domain
|
33
33
|
AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly'
|
@@ -36,14 +36,14 @@ module Google
|
|
36
36
|
# @return [Array<Google::Apis::AdminReportsV1::Activity>]
|
37
37
|
attr_accessor :items
|
38
38
|
|
39
|
-
# The type of API resource. For an activity report, the value is reports#
|
40
|
-
# activities
|
39
|
+
# The type of API resource. For an activity report, the value is `reports#
|
40
|
+
# activities`.
|
41
41
|
# Corresponds to the JSON property `kind`
|
42
42
|
# @return [String]
|
43
43
|
attr_accessor :kind
|
44
44
|
|
45
|
-
# Token for retrieving the follow-on next page of the report. The nextPageToken
|
46
|
-
# value is used in the request's pageToken query string.
|
45
|
+
# Token for retrieving the follow-on next page of the report. The `nextPageToken`
|
46
|
+
# value is used in the request's `pageToken` query string.
|
47
47
|
# Corresponds to the JSON property `nextPageToken`
|
48
48
|
# @return [String]
|
49
49
|
attr_accessor :next_page_token
|
@@ -94,7 +94,8 @@ module Google
|
|
94
94
|
# @return [String]
|
95
95
|
attr_accessor :ip_address
|
96
96
|
|
97
|
-
# The type of API resource. For an activity report, the value is audit#activity
|
97
|
+
# The type of API resource. For an activity report, the value is `audit#activity`
|
98
|
+
# .
|
98
99
|
# Corresponds to the JSON property `kind`
|
99
100
|
# @return [String]
|
100
101
|
attr_accessor :kind
|
@@ -135,8 +136,8 @@ module Google
|
|
135
136
|
# @return [String]
|
136
137
|
attr_accessor :email
|
137
138
|
|
138
|
-
# Only present when callerType is KEY
|
139
|
-
# for OAuth 2LO API requests or an identifier for robot accounts.
|
139
|
+
# Only present when `callerType` is `KEY`. Can be the `consumer_key` of the
|
140
|
+
# requestor for OAuth 2LO API requests or an identifier for robot accounts.
|
140
141
|
# Corresponds to the JSON property `key`
|
141
142
|
# @return [String]
|
142
143
|
attr_accessor :key
|
@@ -165,29 +166,30 @@ module Google
|
|
165
166
|
include Google::Apis::Core::Hashable
|
166
167
|
|
167
168
|
# Name of the event. This is the specific name of the activity reported by the
|
168
|
-
# API. And each eventName is related to a specific G Suite service or feature
|
169
|
-
# which the API organizes into types of events. For eventName request
|
170
|
-
# in general: - If no eventName is given, the report returns all
|
171
|
-
# instances of an eventName
|
172
|
-
# returns all activities which contain that eventName
|
173
|
-
# returned activities will have other eventName properties
|
174
|
-
# one requested. For more information about eventName
|
175
|
-
# of event names for various applications above in
|
169
|
+
# API. And each `eventName` is related to a specific G Suite service or feature
|
170
|
+
# which the API organizes into types of events. For `eventName` request
|
171
|
+
# parameters in general: - If no `eventName` is given, the report returns all
|
172
|
+
# possible instances of an `eventName`. - When you request an `eventName`, the
|
173
|
+
# API's response returns all activities which contain that `eventName`. It is
|
174
|
+
# possible that the returned activities will have other `eventName` properties
|
175
|
+
# in addition to the one requested. For more information about `eventName`
|
176
|
+
# properties, see the list of event names for various applications above in `
|
177
|
+
# applicationName`.
|
176
178
|
# Corresponds to the JSON property `name`
|
177
179
|
# @return [String]
|
178
180
|
attr_accessor :name
|
179
181
|
|
180
|
-
# Parameter value pairs for various applications. For more information about
|
181
|
-
# eventName parameters, see the list of event names for various applications
|
182
|
-
# above in applicationName
|
182
|
+
# Parameter value pairs for various applications. For more information about `
|
183
|
+
# eventName` parameters, see the list of event names for various applications
|
184
|
+
# above in `applicationName`.
|
183
185
|
# Corresponds to the JSON property `parameters`
|
184
186
|
# @return [Array<Google::Apis::AdminReportsV1::Activity::Event::Parameter>]
|
185
187
|
attr_accessor :parameters
|
186
188
|
|
187
189
|
# Type of event. The G Suite service or feature that an administrator changes is
|
188
|
-
# identified in the type property which identifies an event using the
|
189
|
-
# property. For a full list of the API's type categories, see the
|
190
|
-
# names for various applications above in applicationName
|
190
|
+
# identified in the `type` property which identifies an event using the `
|
191
|
+
# eventName` property. For a full list of the API's `type` categories, see the
|
192
|
+
# list of event names for various applications above in `applicationName`.
|
191
193
|
# Corresponds to the JSON property `type`
|
192
194
|
# @return [String]
|
193
195
|
attr_accessor :type
|
@@ -220,8 +222,8 @@ module Google
|
|
220
222
|
|
221
223
|
# Nested parameter value pairs associated with this parameter. Complex value
|
222
224
|
# type for a parameter are returned as a list of parameter values. For example,
|
223
|
-
# the address parameter may have a value as [`parameter: [`name: city, value:
|
224
|
-
# abc`]`]
|
225
|
+
# the address parameter may have a value as `[`parameter: [`name: city, value:
|
226
|
+
# abc`]`]`
|
225
227
|
# Corresponds to the JSON property `messageValue`
|
226
228
|
# @return [Google::Apis::AdminReportsV1::Activity::Event::Parameter::MessageValue]
|
227
229
|
attr_accessor :message_value
|
@@ -231,7 +233,7 @@ module Google
|
|
231
233
|
# @return [Array<Fixnum>]
|
232
234
|
attr_accessor :multi_int_value
|
233
235
|
|
234
|
-
# List of messageValue objects.
|
236
|
+
# List of `messageValue` objects.
|
235
237
|
# Corresponds to the JSON property `multiMessageValue`
|
236
238
|
# @return [Array<Google::Apis::AdminReportsV1::Activity::Event::Parameter::MultiMessageValue>]
|
237
239
|
attr_accessor :multi_message_value
|
@@ -269,8 +271,8 @@ module Google
|
|
269
271
|
|
270
272
|
# Nested parameter value pairs associated with this parameter. Complex value
|
271
273
|
# type for a parameter are returned as a list of parameter values. For example,
|
272
|
-
# the address parameter may have a value as [`parameter: [`name: city, value:
|
273
|
-
# abc`]`]
|
274
|
+
# the address parameter may have a value as `[`parameter: [`name: city, value:
|
275
|
+
# abc`]`]`
|
274
276
|
class MessageValue
|
275
277
|
include Google::Apis::Core::Hashable
|
276
278
|
|
@@ -315,7 +317,7 @@ module Google
|
|
315
317
|
include Google::Apis::Core::Hashable
|
316
318
|
|
317
319
|
# Application name to which the event belongs. For possible values see the list
|
318
|
-
# of applications above in applicationName
|
320
|
+
# of applications above in `applicationName`.
|
319
321
|
# Corresponds to the JSON property `applicationName`
|
320
322
|
# @return [String]
|
321
323
|
attr_accessor :application_name
|
@@ -370,7 +372,7 @@ module Google
|
|
370
372
|
attr_accessor :id
|
371
373
|
|
372
374
|
# Identifies this as a notification channel used to watch for changes to a
|
373
|
-
# resource, which is "api#channel".
|
375
|
+
# resource, which is "`api#channel`".
|
374
376
|
# Corresponds to the JSON property `kind`
|
375
377
|
# @return [String]
|
376
378
|
attr_accessor :kind
|
@@ -403,7 +405,8 @@ module Google
|
|
403
405
|
# @return [String]
|
404
406
|
attr_accessor :token
|
405
407
|
|
406
|
-
# The type of delivery mechanism used for this channel.
|
408
|
+
# The type of delivery mechanism used for this channel. The value should be set
|
409
|
+
# to `"web_hook"`.
|
407
410
|
# Corresponds to the JSON property `type`
|
408
411
|
# @return [String]
|
409
412
|
attr_accessor :type
|
@@ -502,15 +505,15 @@ module Google
|
|
502
505
|
# @return [String]
|
503
506
|
attr_accessor :etag
|
504
507
|
|
505
|
-
# The type of API resource. For a usage report, the value is admin#reports#
|
506
|
-
# usageReport
|
508
|
+
# The type of API resource. For a usage report, the value is `admin#reports#
|
509
|
+
# usageReport`.
|
507
510
|
# Corresponds to the JSON property `kind`
|
508
511
|
# @return [String]
|
509
512
|
attr_accessor :kind
|
510
513
|
|
511
|
-
# Output only. Parameter value pairs for various applications. For the
|
512
|
-
#
|
513
|
-
# reference.
|
514
|
+
# Output only. Parameter value pairs for various applications. For the Entity
|
515
|
+
# Usage Report parameters and values, see [the Entity Usage parameters reference]
|
516
|
+
# (/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
|
514
517
|
# Corresponds to the JSON property `parameters`
|
515
518
|
# @return [Array<Google::Apis::AdminReportsV1::UsageReport::Parameter>]
|
516
519
|
attr_accessor :parameters
|
@@ -548,7 +551,7 @@ module Google
|
|
548
551
|
# @return [String]
|
549
552
|
attr_accessor :profile_id
|
550
553
|
|
551
|
-
# Output only. The type of item. The value is
|
554
|
+
# Output only. The type of item. The value is `user`.
|
552
555
|
# Corresponds to the JSON property `type`
|
553
556
|
# @return [String]
|
554
557
|
attr_accessor :type
|
@@ -598,7 +601,8 @@ module Google
|
|
598
601
|
# @return [Array<Hash<String,Object>>]
|
599
602
|
attr_accessor :msg_value
|
600
603
|
|
601
|
-
#
|
604
|
+
# The name of the parameter. For the User Usage Report parameter names, see the
|
605
|
+
# User Usage parameters reference.
|
602
606
|
# Corresponds to the JSON property `name`
|
603
607
|
# @return [String]
|
604
608
|
attr_accessor :name
|
@@ -633,15 +637,16 @@ module Google
|
|
633
637
|
# @return [String]
|
634
638
|
attr_accessor :etag
|
635
639
|
|
636
|
-
# The type of API resource. For a usage report, the value is admin#reports#
|
637
|
-
# usageReports
|
640
|
+
# The type of API resource. For a usage report, the value is `admin#reports#
|
641
|
+
# usageReports`.
|
638
642
|
# Corresponds to the JSON property `kind`
|
639
643
|
# @return [String]
|
640
644
|
attr_accessor :kind
|
641
645
|
|
642
|
-
# Token to specify next page. A report with multiple pages has a nextPageToken
|
646
|
+
# Token to specify next page. A report with multiple pages has a `nextPageToken`
|
643
647
|
# property in the response. For your follow-on requests getting all of the
|
644
|
-
# report's pages, enter the nextPageToken value in the pageToken query
|
648
|
+
# report's pages, enter the `nextPageToken` value in the `pageToken` query
|
649
|
+
# string.
|
645
650
|
# Corresponds to the JSON property `nextPageToken`
|
646
651
|
# @return [String]
|
647
652
|
attr_accessor :next_page_token
|
@@ -673,7 +678,7 @@ module Google
|
|
673
678
|
class Warning
|
674
679
|
include Google::Apis::Core::Hashable
|
675
680
|
|
676
|
-
# Machine readable code or warning type. The warning code value is 200
|
681
|
+
# Machine readable code or warning type. The warning code value is `200`.
|
677
682
|
# Corresponds to the JSON property `code`
|
678
683
|
# @return [String]
|
679
684
|
attr_accessor :code
|
@@ -684,9 +689,9 @@ module Google
|
|
684
689
|
attr_accessor :data
|
685
690
|
|
686
691
|
# The human readable messages for a warning are: - Data is not available warning
|
687
|
-
# - Sorry, data for date yyyy-mm-dd for application "application name" is not
|
692
|
+
# - Sorry, data for date yyyy-mm-dd for application "`application name`" is not
|
688
693
|
# available. - Partial data is available warning - Data for date yyyy-mm-dd for
|
689
|
-
# application "application name" is not available right now, please try again
|
694
|
+
# application "`application name`" is not available right now, please try again
|
690
695
|
# after a few hours.
|
691
696
|
# Corresponds to the JSON property `message`
|
692
697
|
# @return [String]
|
@@ -20,7 +20,7 @@ require 'google/apis/errors'
|
|
20
20
|
module Google
|
21
21
|
module Apis
|
22
22
|
module AdminReportsV1
|
23
|
-
# Admin SDK
|
23
|
+
# Admin SDK API
|
24
24
|
#
|
25
25
|
# Admin SDK lets administrators of enterprise domains to view and manage
|
26
26
|
# resources like user, groups etc. It also provides audit and usage reports of
|
@@ -45,8 +45,8 @@ module Google
|
|
45
45
|
attr_accessor :quota_user
|
46
46
|
|
47
47
|
def initialize
|
48
|
-
super('https://
|
49
|
-
@batch_path = 'batch
|
48
|
+
super('https://admin.googleapis.com/', '')
|
49
|
+
@batch_path = 'batch'
|
50
50
|
end
|
51
51
|
|
52
52
|
# Retrieves a list of activities for a specific customer's account and
|
@@ -56,7 +56,7 @@ module Google
|
|
56
56
|
# parameters, see the activity parameters reference guides.
|
57
57
|
# @param [String] user_key
|
58
58
|
# Represents the profile ID or the user email for which the data should be
|
59
|
-
# filtered. Can be all for all information, or userKey for a user's unique G
|
59
|
+
# filtered. Can be `all` for all information, or `userKey` for a user's unique G
|
60
60
|
# Suite profile ID or their primary email address.
|
61
61
|
# @param [String] application_name
|
62
62
|
# Application name for which the events are to be retrieved.
|
@@ -75,75 +75,79 @@ module Google
|
|
75
75
|
# approximate time of the API request. An API report has three basic time
|
76
76
|
# concepts: - *Date of the API's request for a report*: When the API created and
|
77
77
|
# retrieved the report. - *Report's start time*: The beginning of the timespan
|
78
|
-
# shown in the report. The startTime must be before the endTime (if
|
79
|
-
# and the current time when the request is made, or the API returns
|
80
|
-
# Report's end time*: The end of the timespan shown in the report.
|
81
|
-
# the timespan of events summarized in a report can start in April
|
82
|
-
# May. The report itself can be requested in August. If the endTime
|
83
|
-
# specified, the report returns all activities from the startTime until
|
84
|
-
# current time or the most recent 180 days if the startTime is more than
|
85
|
-
# days in the past.
|
78
|
+
# shown in the report. The `startTime` must be before the `endTime` (if
|
79
|
+
# specified) and the current time when the request is made, or the API returns
|
80
|
+
# an error. - *Report's end time*: The end of the timespan shown in the report.
|
81
|
+
# For example, the timespan of events summarized in a report can start in April
|
82
|
+
# and end in May. The report itself can be requested in August. If the `endTime`
|
83
|
+
# is not specified, the report returns all activities from the `startTime` until
|
84
|
+
# the current time or the most recent 180 days if the `startTime` is more than
|
85
|
+
# 180 days in the past.
|
86
86
|
# @param [String] event_name
|
87
|
-
# The name of the event being queried by the API. Each eventName is related to
|
88
|
-
# specific G Suite service or feature which the API organizes into types of
|
87
|
+
# The name of the event being queried by the API. Each `eventName` is related to
|
88
|
+
# a specific G Suite service or feature which the API organizes into types of
|
89
89
|
# events. An example is the Google Calendar events in the Admin console
|
90
|
-
# application's reports. The Calendar Settings type structure has all of the
|
91
|
-
# Calendar eventName activities reported by the API. When an administrator
|
90
|
+
# application's reports. The Calendar Settings `type` structure has all of the
|
91
|
+
# Calendar `eventName` activities reported by the API. When an administrator
|
92
92
|
# changes a Calendar setting, the API reports this activity in the Calendar
|
93
|
-
# Settings type and eventName parameters. For more information about
|
94
|
-
# query strings and parameters, see the list of event names for
|
95
|
-
# applications above in applicationName
|
93
|
+
# Settings `type` and `eventName` parameters. For more information about `
|
94
|
+
# eventName` query strings and parameters, see the list of event names for
|
95
|
+
# various applications above in `applicationName`.
|
96
96
|
# @param [String] filters
|
97
|
-
# The filters query string is a comma-separated list. The list is composed of
|
97
|
+
# The `filters` query string is a comma-separated list. The list is composed of
|
98
98
|
# event parameters that are manipulated by relational operators. Event
|
99
|
-
# parameters are in the form parameter1 name[parameter1 value],parameter2 name[
|
100
|
-
# parameter2 value]
|
101
|
-
# eventName
|
102
|
-
# does not belong to the eventName
|
103
|
-
# parameters, see the list of event names for various applications above in
|
104
|
-
# applicationName
|
99
|
+
# parameters are in the form `parameter1 name[parameter1 value],parameter2 name[
|
100
|
+
# parameter2 value],...` These event parameters are associated with a specific `
|
101
|
+
# eventName`. An empty report is returned if the filtered request's parameter
|
102
|
+
# does not belong to the `eventName`. For more information about `eventName`
|
103
|
+
# parameters, see the list of event names for various applications above in `
|
104
|
+
# applicationName`. In the following Admin Activity example, the <> operator is
|
105
105
|
# URL-encoded in the request's query string (%3C%3E): GET...&eventName=
|
106
106
|
# CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the
|
107
|
-
# following Drive example, the list can be a view or edit event's doc_id
|
107
|
+
# following Drive example, the list can be a view or edit event's `doc_id`
|
108
108
|
# parameter with a value that is manipulated by an 'equal to' (==) or 'not equal
|
109
109
|
# to' (<>) relational operator. In the first example, the report returns each
|
110
|
-
# edited document's doc_id
|
111
|
-
# viewed document's doc_id that equals the value 12345 and does not return any
|
112
|
-
# viewed document's which have a doc_id value of 98765. The <> operator is URL-
|
110
|
+
# edited document's `doc_id`. In the second example, the report returns each
|
111
|
+
# viewed document's `doc_id` that equals the value 12345 and does not return any
|
112
|
+
# viewed document's which have a `doc_id` value of 98765. The <> operator is URL-
|
113
113
|
# encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=
|
114
114
|
# doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The
|
115
|
-
# relational operators include: -
|
116
|
-
# URL-encoded (%3C%3E). -
|
117
|
-
# than or equal to'. It is URL-encoded (%3C=). -
|
118
|
-
# encoded (%3E). -
|
119
|
-
# Note:* The API doesn't accept multiple values of a parameter. If a
|
120
|
-
# parameter is supplied more than once in the API request, the API
|
121
|
-
# the last value of that request parameter. In addition, if an
|
122
|
-
# parameter is supplied in the API request, the API ignores that
|
123
|
-
# parameter and returns the response corresponding to the remaining
|
124
|
-
# request parameters. If no parameters are requested, all parameters are
|
115
|
+
# relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It
|
116
|
+
# is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` -
|
117
|
+
# 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It
|
118
|
+
# is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%
|
119
|
+
# 3E=). *Note:* The API doesn't accept multiple values of a parameter. If a
|
120
|
+
# particular parameter is supplied more than once in the API request, the API
|
121
|
+
# only accepts the last value of that request parameter. In addition, if an
|
122
|
+
# invalid request parameter is supplied in the API request, the API ignores that
|
123
|
+
# request parameter and returns the response corresponding to the remaining
|
124
|
+
# valid request parameters. If no parameters are requested, all parameters are
|
125
125
|
# returned.
|
126
|
+
# @param [String] group_id_filter
|
127
|
+
# Comma separated group ids (obfuscated) on which user activities are filtered,
|
128
|
+
# i.e, the response will contain activities for only those users that are a part
|
129
|
+
# of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456"
|
126
130
|
# @param [Fixnum] max_results
|
127
131
|
# Determines how many activity records are shown on each response page. For
|
128
|
-
# example, if the request sets maxResults=1 and the report has two activities,
|
129
|
-
# the report has two pages. The response's nextPageToken property has the
|
130
|
-
# to the second page. The maxResults query string is optional in the
|
131
|
-
# The default value is 1000.
|
132
|
+
# example, if the request sets `maxResults=1` and the report has two activities,
|
133
|
+
# the report has two pages. The response's `nextPageToken` property has the
|
134
|
+
# token to the second page. The `maxResults` query string is optional in the
|
135
|
+
# request. The default value is 1000.
|
132
136
|
# @param [String] org_unit_id
|
133
137
|
# ID of the organizational unit to report on. Activity records will be shown
|
134
138
|
# only for users who belong to the specified organizational unit. Data before
|
135
139
|
# Dec 17, 2018 doesn't appear in the filtered results.
|
136
140
|
# @param [String] page_token
|
137
|
-
# The token to specify next page. A report with multiple pages has a
|
138
|
-
# nextPageToken property in the response. In your follow-on request getting the
|
139
|
-
# next page of the report, enter the nextPageToken value in the pageToken
|
140
|
-
# string.
|
141
|
+
# The token to specify next page. A report with multiple pages has a `
|
142
|
+
# nextPageToken` property in the response. In your follow-on request getting the
|
143
|
+
# next page of the report, enter the `nextPageToken` value in the `pageToken`
|
144
|
+
# query string.
|
141
145
|
# @param [String] start_time
|
142
146
|
# Sets the beginning of the range of time shown in the report. The date is in
|
143
147
|
# the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns
|
144
|
-
# all activities from startTime until endTime
|
145
|
-
# endTime (if specified) and the current time when the request is
|
146
|
-
# API returns an error.
|
148
|
+
# all activities from `startTime` until `endTime`. The `startTime` must be
|
149
|
+
# before the `endTime` (if specified) and the current time when the request is
|
150
|
+
# made, or the API returns an error.
|
147
151
|
# @param [String] fields
|
148
152
|
# Selector specifying which fields to include in a partial response.
|
149
153
|
# @param [String] quota_user
|
@@ -161,7 +165,7 @@ module Google
|
|
161
165
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
162
166
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
163
167
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
164
|
-
def list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
168
|
+
def list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, group_id_filter: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
165
169
|
command = make_simple_command(:get, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}', options)
|
166
170
|
command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation
|
167
171
|
command.response_class = Google::Apis::AdminReportsV1::Activities
|
@@ -172,6 +176,7 @@ module Google
|
|
172
176
|
command.query['endTime'] = end_time unless end_time.nil?
|
173
177
|
command.query['eventName'] = event_name unless event_name.nil?
|
174
178
|
command.query['filters'] = filters unless filters.nil?
|
179
|
+
command.query['groupIdFilter'] = group_id_filter unless group_id_filter.nil?
|
175
180
|
command.query['maxResults'] = max_results unless max_results.nil?
|
176
181
|
command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
|
177
182
|
command.query['pageToken'] = page_token unless page_token.nil?
|
@@ -185,7 +190,7 @@ module Google
|
|
185
190
|
# see Receiving Push Notifications.
|
186
191
|
# @param [String] user_key
|
187
192
|
# Represents the profile ID or the user email for which the data should be
|
188
|
-
# filtered. Can be all for all information, or userKey for a user's unique G
|
193
|
+
# filtered. Can be `all` for all information, or `userKey` for a user's unique G
|
189
194
|
# Suite profile ID or their primary email address.
|
190
195
|
# @param [String] application_name
|
191
196
|
# Application name for which the events are to be retrieved.
|
@@ -205,75 +210,79 @@ module Google
|
|
205
210
|
# approximate time of the API request. An API report has three basic time
|
206
211
|
# concepts: - *Date of the API's request for a report*: When the API created and
|
207
212
|
# retrieved the report. - *Report's start time*: The beginning of the timespan
|
208
|
-
# shown in the report. The startTime must be before the endTime (if
|
209
|
-
# and the current time when the request is made, or the API returns
|
210
|
-
# Report's end time*: The end of the timespan shown in the report.
|
211
|
-
# the timespan of events summarized in a report can start in April
|
212
|
-
# May. The report itself can be requested in August. If the endTime
|
213
|
-
# specified, the report returns all activities from the startTime until
|
214
|
-
# current time or the most recent 180 days if the startTime is more than
|
215
|
-
# days in the past.
|
213
|
+
# shown in the report. The `startTime` must be before the `endTime` (if
|
214
|
+
# specified) and the current time when the request is made, or the API returns
|
215
|
+
# an error. - *Report's end time*: The end of the timespan shown in the report.
|
216
|
+
# For example, the timespan of events summarized in a report can start in April
|
217
|
+
# and end in May. The report itself can be requested in August. If the `endTime`
|
218
|
+
# is not specified, the report returns all activities from the `startTime` until
|
219
|
+
# the current time or the most recent 180 days if the `startTime` is more than
|
220
|
+
# 180 days in the past.
|
216
221
|
# @param [String] event_name
|
217
|
-
# The name of the event being queried by the API. Each eventName is related to
|
218
|
-
# specific G Suite service or feature which the API organizes into types of
|
222
|
+
# The name of the event being queried by the API. Each `eventName` is related to
|
223
|
+
# a specific G Suite service or feature which the API organizes into types of
|
219
224
|
# events. An example is the Google Calendar events in the Admin console
|
220
|
-
# application's reports. The Calendar Settings type structure has all of the
|
221
|
-
# Calendar eventName activities reported by the API. When an administrator
|
225
|
+
# application's reports. The Calendar Settings `type` structure has all of the
|
226
|
+
# Calendar `eventName` activities reported by the API. When an administrator
|
222
227
|
# changes a Calendar setting, the API reports this activity in the Calendar
|
223
|
-
# Settings type and eventName parameters. For more information about
|
224
|
-
# query strings and parameters, see the list of event names for
|
225
|
-
# applications above in applicationName
|
228
|
+
# Settings `type` and `eventName` parameters. For more information about `
|
229
|
+
# eventName` query strings and parameters, see the list of event names for
|
230
|
+
# various applications above in `applicationName`.
|
226
231
|
# @param [String] filters
|
227
|
-
# The filters query string is a comma-separated list. The list is composed of
|
232
|
+
# The `filters` query string is a comma-separated list. The list is composed of
|
228
233
|
# event parameters that are manipulated by relational operators. Event
|
229
|
-
# parameters are in the form parameter1 name[parameter1 value],parameter2 name[
|
230
|
-
# parameter2 value]
|
231
|
-
# eventName
|
232
|
-
# does not belong to the eventName
|
233
|
-
# parameters, see the list of event names for various applications above in
|
234
|
-
# applicationName
|
234
|
+
# parameters are in the form `parameter1 name[parameter1 value],parameter2 name[
|
235
|
+
# parameter2 value],...` These event parameters are associated with a specific `
|
236
|
+
# eventName`. An empty report is returned if the filtered request's parameter
|
237
|
+
# does not belong to the `eventName`. For more information about `eventName`
|
238
|
+
# parameters, see the list of event names for various applications above in `
|
239
|
+
# applicationName`. In the following Admin Activity example, the <> operator is
|
235
240
|
# URL-encoded in the request's query string (%3C%3E): GET...&eventName=
|
236
241
|
# CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the
|
237
|
-
# following Drive example, the list can be a view or edit event's doc_id
|
242
|
+
# following Drive example, the list can be a view or edit event's `doc_id`
|
238
243
|
# parameter with a value that is manipulated by an 'equal to' (==) or 'not equal
|
239
244
|
# to' (<>) relational operator. In the first example, the report returns each
|
240
|
-
# edited document's doc_id
|
241
|
-
# viewed document's doc_id that equals the value 12345 and does not return any
|
242
|
-
# viewed document's which have a doc_id value of 98765. The <> operator is URL-
|
245
|
+
# edited document's `doc_id`. In the second example, the report returns each
|
246
|
+
# viewed document's `doc_id` that equals the value 12345 and does not return any
|
247
|
+
# viewed document's which have a `doc_id` value of 98765. The <> operator is URL-
|
243
248
|
# encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=
|
244
249
|
# doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The
|
245
|
-
# relational operators include: -
|
246
|
-
# URL-encoded (%3C%3E). -
|
247
|
-
# than or equal to'. It is URL-encoded (%3C=). -
|
248
|
-
# encoded (%3E). -
|
249
|
-
# Note:* The API doesn't accept multiple values of a parameter. If a
|
250
|
-
# parameter is supplied more than once in the API request, the API
|
251
|
-
# the last value of that request parameter. In addition, if an
|
252
|
-
# parameter is supplied in the API request, the API ignores that
|
253
|
-
# parameter and returns the response corresponding to the remaining
|
254
|
-
# request parameters. If no parameters are requested, all parameters are
|
250
|
+
# relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It
|
251
|
+
# is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` -
|
252
|
+
# 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It
|
253
|
+
# is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%
|
254
|
+
# 3E=). *Note:* The API doesn't accept multiple values of a parameter. If a
|
255
|
+
# particular parameter is supplied more than once in the API request, the API
|
256
|
+
# only accepts the last value of that request parameter. In addition, if an
|
257
|
+
# invalid request parameter is supplied in the API request, the API ignores that
|
258
|
+
# request parameter and returns the response corresponding to the remaining
|
259
|
+
# valid request parameters. If no parameters are requested, all parameters are
|
255
260
|
# returned.
|
261
|
+
# @param [String] group_id_filter
|
262
|
+
# Comma separated group ids (obfuscated) on which user activities are filtered,
|
263
|
+
# i.e, the response will contain activities for only those users that are a part
|
264
|
+
# of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456"
|
256
265
|
# @param [Fixnum] max_results
|
257
266
|
# Determines how many activity records are shown on each response page. For
|
258
|
-
# example, if the request sets maxResults=1 and the report has two activities,
|
259
|
-
# the report has two pages. The response's nextPageToken property has the
|
260
|
-
# to the second page. The maxResults query string is optional in the
|
261
|
-
# The default value is 1000.
|
267
|
+
# example, if the request sets `maxResults=1` and the report has two activities,
|
268
|
+
# the report has two pages. The response's `nextPageToken` property has the
|
269
|
+
# token to the second page. The `maxResults` query string is optional in the
|
270
|
+
# request. The default value is 1000.
|
262
271
|
# @param [String] org_unit_id
|
263
272
|
# ID of the organizational unit to report on. Activity records will be shown
|
264
273
|
# only for users who belong to the specified organizational unit. Data before
|
265
274
|
# Dec 17, 2018 doesn't appear in the filtered results.
|
266
275
|
# @param [String] page_token
|
267
|
-
# The token to specify next page. A report with multiple pages has a
|
268
|
-
# nextPageToken property in the response. In your follow-on request getting the
|
269
|
-
# next page of the report, enter the nextPageToken value in the pageToken
|
270
|
-
# string.
|
276
|
+
# The token to specify next page. A report with multiple pages has a `
|
277
|
+
# nextPageToken` property in the response. In your follow-on request getting the
|
278
|
+
# next page of the report, enter the `nextPageToken` value in the `pageToken`
|
279
|
+
# query string.
|
271
280
|
# @param [String] start_time
|
272
281
|
# Sets the beginning of the range of time shown in the report. The date is in
|
273
282
|
# the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns
|
274
|
-
# all activities from startTime until endTime
|
275
|
-
# endTime (if specified) and the current time when the request is
|
276
|
-
# API returns an error.
|
283
|
+
# all activities from `startTime` until `endTime`. The `startTime` must be
|
284
|
+
# before the `endTime` (if specified) and the current time when the request is
|
285
|
+
# made, or the API returns an error.
|
277
286
|
# @param [String] fields
|
278
287
|
# Selector specifying which fields to include in a partial response.
|
279
288
|
# @param [String] quota_user
|
@@ -291,7 +300,7 @@ module Google
|
|
291
300
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
292
301
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
293
302
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
294
|
-
def watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
303
|
+
def watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, group_id_filter: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
295
304
|
command = make_simple_command(:post, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch', options)
|
296
305
|
command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
|
297
306
|
command.request_object = channel_object
|
@@ -304,6 +313,7 @@ module Google
|
|
304
313
|
command.query['endTime'] = end_time unless end_time.nil?
|
305
314
|
command.query['eventName'] = event_name unless event_name.nil?
|
306
315
|
command.query['filters'] = filters unless filters.nil?
|
316
|
+
command.query['groupIdFilter'] = group_id_filter unless group_id_filter.nil?
|
307
317
|
command.query['maxResults'] = max_results unless max_results.nil?
|
308
318
|
command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
|
309
319
|
command.query['pageToken'] = page_token unless page_token.nil?
|
@@ -351,23 +361,25 @@ module Google
|
|
351
361
|
# @param [String] customer_id
|
352
362
|
# The unique ID of the customer to retrieve data for.
|
353
363
|
# @param [String] page_token
|
354
|
-
# Token to specify next page. A report with multiple pages has a nextPageToken
|
364
|
+
# Token to specify next page. A report with multiple pages has a `nextPageToken`
|
355
365
|
# property in the response. For your follow-on requests getting all of the
|
356
|
-
# report's pages, enter the nextPageToken value in the pageToken query
|
366
|
+
# report's pages, enter the `nextPageToken` value in the `pageToken` query
|
367
|
+
# string.
|
357
368
|
# @param [String] parameters
|
358
|
-
# The parameters query string is a comma-separated list of event parameters
|
359
|
-
# refine a report's results. The parameter is associated with a specific
|
360
|
-
# application. The application values for the Customers usage report include
|
361
|
-
# accounts
|
362
|
-
#
|
363
|
-
# CSV form of app_name1:param_name1, app_name2:
|
364
|
-
# doesn't accept multiple values of a parameter.
|
365
|
-
# supplied more than once in the API request, the
|
366
|
-
# value of that request parameter. In addition, if an
|
367
|
-
# is supplied in the API request, the API ignores that
|
368
|
-
# returns the response corresponding to the remaining
|
369
|
-
# An example of an invalid request parameter is one
|
370
|
-
# application. If no parameters are requested, all
|
369
|
+
# The `parameters` query string is a comma-separated list of event parameters
|
370
|
+
# that refine a report's results. The parameter is associated with a specific
|
371
|
+
# application. The application values for the Customers usage report include `
|
372
|
+
# accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`
|
373
|
+
# , `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters`
|
374
|
+
# query string is in the CSV form of `app_name1:param_name1, app_name2:
|
375
|
+
# param_name2`. *Note:* The API doesn't accept multiple values of a parameter.
|
376
|
+
# If a particular parameter is supplied more than once in the API request, the
|
377
|
+
# API only accepts the last value of that request parameter. In addition, if an
|
378
|
+
# invalid request parameter is supplied in the API request, the API ignores that
|
379
|
+
# request parameter and returns the response corresponding to the remaining
|
380
|
+
# valid request parameters. An example of an invalid request parameter is one
|
381
|
+
# that does not belong to the application. If no parameters are requested, all
|
382
|
+
# parameters are returned.
|
371
383
|
# @param [String] fields
|
372
384
|
# Selector specifying which fields to include in a partial response.
|
373
385
|
# @param [String] quota_user
|
@@ -412,42 +424,43 @@ module Google
|
|
412
424
|
# @param [String] customer_id
|
413
425
|
# The unique ID of the customer to retrieve data for.
|
414
426
|
# @param [String] filters
|
415
|
-
# The filters query string is a comma-separated list of an application's event
|
427
|
+
# The `filters` query string is a comma-separated list of an application's event
|
416
428
|
# parameters where the parameter's value is manipulated by a relational operator.
|
417
|
-
# The filters query string includes the name of the application whose usage
|
418
|
-
# returned in the report. The application values for the Entities usage
|
419
|
-
# include accounts
|
420
|
-
# parameter name[parameter value]
|
421
|
-
# operator is URL-encoded in the request's query string (%3C%
|
422
|
-
# www.googleapis.com/admin/reports/v1/usage/gplus_communities/
|
423
|
-
# 01 ?parameters=gplus:community_name,gplus:num_total_members &
|
424
|
-
# num_total_members
|
425
|
-
# 'not equal to'. It is URL-encoded (%3C%3E). -
|
426
|
-
# encoded (%3C). -
|
427
|
-
# 'greater than'. It is URL-encoded (%3E). -
|
428
|
-
# is URL-encoded (%3E=). Filters can only be
|
429
|
+
# The `filters` query string includes the name of the application whose usage
|
430
|
+
# is returned in the report. The application values for the Entities usage
|
431
|
+
# report include `accounts`, `docs`, and `gmail`. Filters are in the form `[
|
432
|
+
# application name]:parameter name[parameter value],...`. In this example, the `<
|
433
|
+
# >` 'not equal to' operator is URL-encoded in the request's query string (%3C%
|
434
|
+
# 3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/
|
435
|
+
# all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &
|
436
|
+
# filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==`
|
437
|
+
# - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - '
|
438
|
+
# less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is
|
439
|
+
# URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - '
|
440
|
+
# greater than or equal to'. It is URL-encoded (%3E=). Filters can only be
|
441
|
+
# applied to numeric parameters.
|
429
442
|
# @param [Fixnum] max_results
|
430
443
|
# Determines how many activity records are shown on each response page. For
|
431
|
-
# example, if the request sets maxResults=1 and the report has two activities,
|
432
|
-
# the report has two pages. The response's nextPageToken property has the
|
433
|
-
# to the second page.
|
444
|
+
# example, if the request sets `maxResults=1` and the report has two activities,
|
445
|
+
# the report has two pages. The response's `nextPageToken` property has the
|
446
|
+
# token to the second page.
|
434
447
|
# @param [String] page_token
|
435
|
-
# Token to specify next page. A report with multiple pages has a nextPageToken
|
448
|
+
# Token to specify next page. A report with multiple pages has a `nextPageToken`
|
436
449
|
# property in the response. In your follow-on request getting the next page of
|
437
|
-
# the report, enter the nextPageToken value in the pageToken query string.
|
450
|
+
# the report, enter the `nextPageToken` value in the `pageToken` query string.
|
438
451
|
# @param [String] parameters
|
439
|
-
# The parameters query string is a comma-separated list of event parameters
|
440
|
-
# refine a report's results. The parameter is associated with a specific
|
441
|
-
# application. The application values for the Entities usage report are only
|
442
|
-
# gplus
|
443
|
-
# [app_name2:param_name2]
|
444
|
-
# a parameter. If a particular parameter is supplied more
|
445
|
-
# request, the API only accepts the last value of that
|
446
|
-
# addition, if an invalid request parameter is supplied in
|
447
|
-
# API ignores that request parameter and returns the
|
448
|
-
# the remaining valid request parameters. An example
|
449
|
-
# parameter is one that does not belong to the application.
|
450
|
-
# requested, all parameters are returned.
|
452
|
+
# The `parameters` query string is a comma-separated list of event parameters
|
453
|
+
# that refine a report's results. The parameter is associated with a specific
|
454
|
+
# application. The application values for the Entities usage report are only `
|
455
|
+
# gplus`. A `parameter` query string is in the CSV form of `[app_name1:
|
456
|
+
# param_name1], [app_name2:param_name2]...`. *Note:* The API doesn't accept
|
457
|
+
# multiple values of a parameter. If a particular parameter is supplied more
|
458
|
+
# than once in the API request, the API only accepts the last value of that
|
459
|
+
# request parameter. In addition, if an invalid request parameter is supplied in
|
460
|
+
# the API request, the API ignores that request parameter and returns the
|
461
|
+
# response corresponding to the remaining valid request parameters. An example
|
462
|
+
# of an invalid request parameter is one that does not belong to the application.
|
463
|
+
# If no parameters are requested, all parameters are returned.
|
451
464
|
# @param [String] fields
|
452
465
|
# Selector specifying which fields to include in a partial response.
|
453
466
|
# @param [String] quota_user
|
@@ -488,7 +501,7 @@ module Google
|
|
488
501
|
# Usage parameters reference guides.
|
489
502
|
# @param [String] user_key
|
490
503
|
# Represents the profile ID or the user email for which the data should be
|
491
|
-
# filtered. Can be all for all information, or userKey for a user's unique G
|
504
|
+
# filtered. Can be `all` for all information, or `userKey` for a user's unique G
|
492
505
|
# Suite profile ID or their primary email address.
|
493
506
|
# @param [String] date
|
494
507
|
# Represents the date the usage occurred. The timestamp is in the ISO 8601
|
@@ -496,47 +509,52 @@ module Google
|
|
496
509
|
# @param [String] customer_id
|
497
510
|
# The unique ID of the customer to retrieve data for.
|
498
511
|
# @param [String] filters
|
499
|
-
# The filters query string is a comma-separated list of an application's event
|
512
|
+
# The `filters` query string is a comma-separated list of an application's event
|
500
513
|
# parameters where the parameter's value is manipulated by a relational operator.
|
501
|
-
# The filters query string includes the name of the application whose usage
|
502
|
-
# returned in the report. The application values for the Users Usage Report
|
503
|
-
# include accounts
|
504
|
-
# parameter name[parameter value]
|
505
|
-
# operator is URL-encoded in the request's query string (%3C%3E): GET
|
506
|
-
# www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?
|
507
|
-
# parameters=accounts:last_login_time &filters=accounts:last_login_time
|
508
|
-
# 28T10:26:35.000Z The relational operators include: -
|
509
|
-
# not equal to'. It is URL-encoded (%3C%3E). -
|
510
|
-
# encoded (%3C). -
|
511
|
-
# 'greater than'. It is URL-encoded (%3E). -
|
512
|
-
# is URL-encoded (%3E=).
|
514
|
+
# The `filters` query string includes the name of the application whose usage
|
515
|
+
# is returned in the report. The application values for the Users Usage Report
|
516
|
+
# include `accounts`, `docs`, and `gmail`. Filters are in the form `[application
|
517
|
+
# name]:parameter name[parameter value],...`. In this example, the `<>` 'not
|
518
|
+
# equal to' operator is URL-encoded in the request's query string (%3C%3E): GET
|
519
|
+
# https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?
|
520
|
+
# parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%
|
521
|
+
# 3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal
|
522
|
+
# to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'.
|
523
|
+
# It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%
|
524
|
+
# 3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than
|
525
|
+
# or equal to'. It is URL-encoded (%3E=).
|
526
|
+
# @param [String] group_id_filter
|
527
|
+
# Comma separated group ids (obfuscated) on which user activities are filtered,
|
528
|
+
# i.e, the response will contain activities for only those users that are a part
|
529
|
+
# of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456"
|
513
530
|
# @param [Fixnum] max_results
|
514
531
|
# Determines how many activity records are shown on each response page. For
|
515
|
-
# example, if the request sets maxResults=1 and the report has two activities,
|
516
|
-
# the report has two pages. The response's nextPageToken property has the
|
517
|
-
# to the second page. The maxResults query string is optional.
|
532
|
+
# example, if the request sets `maxResults=1` and the report has two activities,
|
533
|
+
# the report has two pages. The response's `nextPageToken` property has the
|
534
|
+
# token to the second page. The `maxResults` query string is optional.
|
518
535
|
# @param [String] org_unit_id
|
519
536
|
# ID of the organizational unit to report on. User activity will be shown only
|
520
537
|
# for users who belong to the specified organizational unit. Data before Dec 17,
|
521
538
|
# 2018 doesn't appear in the filtered results.
|
522
539
|
# @param [String] page_token
|
523
|
-
# Token to specify next page. A report with multiple pages has a nextPageToken
|
540
|
+
# Token to specify next page. A report with multiple pages has a `nextPageToken`
|
524
541
|
# property in the response. In your follow-on request getting the next page of
|
525
|
-
# the report, enter the nextPageToken value in the pageToken query string.
|
542
|
+
# the report, enter the `nextPageToken` value in the `pageToken` query string.
|
526
543
|
# @param [String] parameters
|
527
|
-
# The parameters query string is a comma-separated list of event parameters
|
528
|
-
# refine a report's results. The parameter is associated with a specific
|
529
|
-
# application. The application values for the Customers
|
530
|
-
# accounts
|
531
|
-
#
|
532
|
-
# CSV form of app_name1:param_name1, app_name2:
|
533
|
-
# doesn't accept multiple values of a parameter.
|
534
|
-
# supplied more than once in the API request, the
|
535
|
-
# value of that request parameter. In addition, if an
|
536
|
-
# is supplied in the API request, the API ignores that
|
537
|
-
# returns the response corresponding to the remaining
|
538
|
-
# An example of an invalid request parameter is one
|
539
|
-
# application. If no parameters are requested, all
|
544
|
+
# The `parameters` query string is a comma-separated list of event parameters
|
545
|
+
# that refine a report's results. The parameter is associated with a specific
|
546
|
+
# application. The application values for the Customers Usage report include `
|
547
|
+
# accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`
|
548
|
+
# , `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters`
|
549
|
+
# query string is in the CSV form of `app_name1:param_name1, app_name2:
|
550
|
+
# param_name2`. *Note:* The API doesn't accept multiple values of a parameter.
|
551
|
+
# If a particular parameter is supplied more than once in the API request, the
|
552
|
+
# API only accepts the last value of that request parameter. In addition, if an
|
553
|
+
# invalid request parameter is supplied in the API request, the API ignores that
|
554
|
+
# request parameter and returns the response corresponding to the remaining
|
555
|
+
# valid request parameters. An example of an invalid request parameter is one
|
556
|
+
# that does not belong to the application. If no parameters are requested, all
|
557
|
+
# parameters are returned.
|
540
558
|
# @param [String] fields
|
541
559
|
# Selector specifying which fields to include in a partial response.
|
542
560
|
# @param [String] quota_user
|
@@ -554,7 +572,7 @@ module Google
|
|
554
572
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
555
573
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
556
574
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
557
|
-
def get_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, options: nil, &block)
|
575
|
+
def get_user_usage_report(user_key, date, customer_id: nil, filters: nil, group_id_filter: nil, max_results: nil, org_unit_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, options: nil, &block)
|
558
576
|
command = make_simple_command(:get, 'admin/reports/v1/usage/users/{userKey}/dates/{date}', options)
|
559
577
|
command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
|
560
578
|
command.response_class = Google::Apis::AdminReportsV1::UsageReports
|
@@ -562,6 +580,7 @@ module Google
|
|
562
580
|
command.params['date'] = date unless date.nil?
|
563
581
|
command.query['customerId'] = customer_id unless customer_id.nil?
|
564
582
|
command.query['filters'] = filters unless filters.nil?
|
583
|
+
command.query['groupIdFilter'] = group_id_filter unless group_id_filter.nil?
|
565
584
|
command.query['maxResults'] = max_results unless max_results.nil?
|
566
585
|
command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
|
567
586
|
command.query['pageToken'] = page_token unless page_token.nil?
|