chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: Automated regeneration of admin reports_v1 client (#1676) 

This PR was generated using Autosynth. 🌈


<details><summary>Log from Synthtool</summary>

```
2020-12-09 01:31:20,384 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-admin-reports_v1
nothing to commit, working tree clean
2020-12-09 01:31:20,467 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth admin reports_v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth admin reports_v1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.8
Installing tzinfo 1.2.8
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.51.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.20.1
Installing parallel 1.20.1
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.3
Installing powerpack 0.1.3
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:

HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.

If you are upgrading your Rails application from an older version of Rails:

Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.

If you are starting a NEW Rails application, you can ignore this notice.

For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0

Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=admin.reports_v1 --names-out=/workspace/api_names_out.yaml
Loading admin, version reports_v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/admin.reports_v1.json
    conflict  google/apis/admin_reports_v1.rb
<dmin_reports_v1.rb? (enter "h" for help) [Ynaqdhm] a
       force  google/apis/admin_reports_v1.rb
    conflict  google/apis/admin_reports_v1/service.rb
       force  google/apis/admin_reports_v1/service.rb
    conflict  google/apis/admin_reports_v1/classes.rb
       force  google/apis/admin_reports_v1/classes.rb
   identical  google/apis/admin_reports_v1/representations.rb
    conflict  /workspace/api_names_out.yaml
       force  /workspace/api_names_out.yaml
2020-12-09 01:31:45,478 synthtool [DEBUG] > Wrote metadata to generated/google/apis/admin_reports_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/admin_reports_v1/synth.metadata.

```
</details>

Full log will be available here:
https://source.cloud.google.com/results/invocations/13e6b812-a54d-4bbb-9ab8-105f680377a2/targets

- [ ] To automatically regenerate this PR, check this box.
This commit is contained in:
Yoshi Automation Bot 2020-12-09 01:56:05 -08:00 committed by GitHub
parent 7f49fd0426
commit 99bb4ca87b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 262 additions and 224 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api_names_out.yaml
View File

@ -4296,6 +4296,7 @@
"/admin:reports_v1/reports.activities.list/endTime": end_time
"/admin:reports_v1/reports.activities.list/eventName": event_name
"/admin:reports_v1/reports.activities.list/filters": filters
"/admin:reports_v1/reports.activities.list/groupIdFilter": group_id_filter
"/admin:reports_v1/reports.activities.list/maxResults": max_results
"/admin:reports_v1/reports.activities.list/orgUnitID": org_unit_id
"/admin:reports_v1/reports.activities.list/pageToken": page_token
@ -4308,6 +4309,7 @@
"/admin:reports_v1/reports.activities.watch/endTime": end_time
"/admin:reports_v1/reports.activities.watch/eventName": event_name
"/admin:reports_v1/reports.activities.watch/filters": filters
"/admin:reports_v1/reports.activities.watch/groupIdFilter": group_id_filter
"/admin:reports_v1/reports.activities.watch/maxResults": max_results
"/admin:reports_v1/reports.activities.watch/orgUnitID": org_unit_id
"/admin:reports_v1/reports.activities.watch/pageToken": page_token
@ -4331,6 +4333,7 @@
"/admin:reports_v1/reports.userUsageReport.get/customerId": customer_id
"/admin:reports_v1/reports.userUsageReport.get/date": date
"/admin:reports_v1/reports.userUsageReport.get/filters": filters
"/admin:reports_v1/reports.userUsageReport.get/groupIdFilter": group_id_filter
"/admin:reports_v1/reports.userUsageReport.get/maxResults": max_results
"/admin:reports_v1/reports.userUsageReport.get/orgUnitID": org_unit_id
"/admin:reports_v1/reports.userUsageReport.get/pageToken": page_token

4
generated/google/apis/admin_reports_v1.rb
View File

@ -18,7 +18,7 @@ require 'google/apis/admin_reports_v1/representations.rb'
module Google
module Apis
# Admin SDK
# Admin SDK API
#
# Admin SDK lets administrators of enterprise domains to view and manage
# resources like user, groups etc. It also provides audit and usage reports of
@ -27,7 +27,7 @@ module Google
# @see http://developers.google.com/admin-sdk/
module AdminReportsV1
VERSION = 'ReportsV1'
REVISION = '20201013'
REVISION = '20201208'
# View audit reports for your G Suite domain
AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly'

91
generated/google/apis/admin_reports_v1/classes.rb
View File

@ -36,14 +36,14 @@ module Google
# @return [Array<Google::Apis::AdminReportsV1::Activity>]
attr_accessor :items
# The type of API resource. For an activity report, the value is reports#
# activities.
# The type of API resource. For an activity report, the value is `reports#
# activities`.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Token for retrieving the follow-on next page of the report. The nextPageToken
# value is used in the request's pageToken query string.
# Token for retrieving the follow-on next page of the report. The `nextPageToken`
# value is used in the request's `pageToken` query string.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -94,7 +94,8 @@ module Google
# @return [String]
attr_accessor :ip_address
# The type of API resource. For an activity report, the value is audit#activity.
# The type of API resource. For an activity report, the value is `audit#activity`
# .
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -135,8 +136,8 @@ module Google
# @return [String]
attr_accessor :email
# Only present when callerType is KEY. Can be the consumer_key of the requestor
# for OAuth 2LO API requests or an identifier for robot accounts.
# Only present when `callerType` is `KEY`. Can be the `consumer_key` of the
# requestor for OAuth 2LO API requests or an identifier for robot accounts.
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
@ -165,29 +166,30 @@ module Google
include Google::Apis::Core::Hashable
# Name of the event. This is the specific name of the activity reported by the
# API. And each eventName is related to a specific G Suite service or feature
# which the API organizes into types of events. For eventName request parameters
# in general: - If no eventName is given, the report returns all possible
# instances of an eventName. - When you request an eventName, the API's response
# returns all activities which contain that eventName. It is possible that the
# returned activities will have other eventName properties in addition to the
# one requested. For more information about eventName properties, see the list
# of event names for various applications above in applicationName.
# API. And each `eventName` is related to a specific G Suite service or feature
# which the API organizes into types of events. For `eventName` request
# parameters in general: - If no `eventName` is given, the report returns all
# possible instances of an `eventName`. - When you request an `eventName`, the
# API's response returns all activities which contain that `eventName`. It is
# possible that the returned activities will have other `eventName` properties
# in addition to the one requested. For more information about `eventName`
# properties, see the list of event names for various applications above in `
# applicationName`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Parameter value pairs for various applications. For more information about
# eventName parameters, see the list of event names for various applications
# above in applicationName.
# Parameter value pairs for various applications. For more information about `
# eventName` parameters, see the list of event names for various applications
# above in `applicationName`.
# Corresponds to the JSON property `parameters`
# @return [Array<Google::Apis::AdminReportsV1::Activity::Event::Parameter>]
attr_accessor :parameters
# Type of event. The G Suite 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.
# 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`.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
@ -220,8 +222,8 @@ module Google
# 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`]`]
# the address parameter may have a value as `[`parameter: [`name: city, value:
# abc`]`]`
# Corresponds to the JSON property `messageValue`
# @return [Google::Apis::AdminReportsV1::Activity::Event::Parameter::MessageValue]
attr_accessor :message_value
@ -231,7 +233,7 @@ module Google
# @return [Array<Fixnum>]
attr_accessor :multi_int_value
# List of messageValue objects.
# List of `messageValue` objects.
# Corresponds to the JSON property `multiMessageValue`
# @return [Array<Google::Apis::AdminReportsV1::Activity::Event::Parameter::MultiMessageValue>]
attr_accessor :multi_message_value
@ -269,8 +271,8 @@ module Google
# 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`]`]
# the address parameter may have a value as `[`parameter: [`name: city, value:
# abc`]`]`
class MessageValue
include Google::Apis::Core::Hashable
@ -315,7 +317,7 @@ module Google
include Google::Apis::Core::Hashable
# Application name to which the event belongs. For possible values see the list
# of applications above in applicationName.
# of applications above in `applicationName`.
# Corresponds to the JSON property `applicationName`
# @return [String]
attr_accessor :application_name
@ -370,7 +372,7 @@ module Google
attr_accessor :id
# Identifies this as a notification channel used to watch for changes to a
# resource, which is "api#channel".
# resource, which is "`api#channel`".
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -403,7 +405,8 @@ module Google
# @return [String]
attr_accessor :token
# The type of delivery mechanism used for this channel.
# The type of delivery mechanism used for this channel. The value should be set
# to `"web_hook"`.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
@ -502,15 +505,15 @@ module Google
# @return [String]
attr_accessor :etag
# The type of API resource. For a usage report, the value is admin#reports#
# usageReport.
# The type of API resource. For a usage report, the value is `admin#reports#
# usageReport`.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Output only. Parameter value pairs for various applications. For the Customers
# usage report parameters and values, see the customer usage parameters
# reference.
# Output only. Parameter value pairs for various applications. For the Entity
# Usage Report parameters and values, see [the Entity Usage parameters reference]
# (/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
# Corresponds to the JSON property `parameters`
# @return [Array<Google::Apis::AdminReportsV1::UsageReport::Parameter>]
attr_accessor :parameters
@ -548,7 +551,7 @@ module Google
# @return [String]
attr_accessor :profile_id
# Output only. The type of item. The value is customer.
# Output only. The type of item. The value is `user`.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
@ -598,7 +601,8 @@ module Google
# @return [Array<Hash<String,Object>>]
attr_accessor :msg_value
# Name of the parameter.
# The name of the parameter. For the User Usage Report parameter names, see the
# User Usage parameters reference.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -633,15 +637,16 @@ module Google
# @return [String]
attr_accessor :etag
# The type of API resource. For a usage report, the value is admin#reports#
# usageReports.
# The type of API resource. For a usage report, the value is `admin#reports#
# usageReports`.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Token to specify next page. A report with multiple pages has a nextPageToken
# Token to specify next page. A report with multiple pages has a `nextPageToken`
# property in the response. For your follow-on requests getting all of the
# report's pages, enter the nextPageToken value in the pageToken query string.
# report's pages, enter the `nextPageToken` value in the `pageToken` query
# string.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -673,7 +678,7 @@ module Google
class Warning
include Google::Apis::Core::Hashable
# Machine readable code or warning type. The warning code value is 200.
# Machine readable code or warning type. The warning code value is `200`.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
@ -684,9 +689,9 @@ module Google
attr_accessor :data
# The human readable messages for a warning are: - Data is not available warning
# - Sorry, data for date yyyy-mm-dd for application "application name" is not
# - Sorry, data for date yyyy-mm-dd for application "`application name`" is not
# available. - Partial data is available warning - Data for date yyyy-mm-dd for
# application "application name" is not available right now, please try again
# application "`application name`" is not available right now, please try again
# after a few hours.
# Corresponds to the JSON property `message`
# @return [String]

377
generated/google/apis/admin_reports_v1/service.rb
View File

@ -20,7 +20,7 @@ require 'google/apis/errors'
module Google
module Apis
module AdminReportsV1
# Admin SDK
# Admin SDK API
#
# Admin SDK lets administrators of enterprise domains to view and manage
# resources like user, groups etc. It also provides audit and usage reports of
@ -45,8 +45,8 @@ module Google
attr_accessor :quota_user
def initialize
super('https://www.googleapis.com/', '')
@batch_path = 'batch/admin/reports_v1'
super('https://admin.googleapis.com/', '')
@batch_path = 'batch'
end
# Retrieves a list of activities for a specific customer's account and
@ -56,7 +56,7 @@ module Google
# parameters, see the activity parameters reference guides.
# @param [String] user_key
# Represents the profile ID or the user email for which the data should be
# filtered. Can be all for all information, or userKey for a user's unique G
# filtered. Can be `all` for all information, or `userKey` for a user's unique G
# Suite profile ID or their primary email address.
# @param [String] application_name
# Application name for which the events are to be retrieved.
@ -75,75 +75,79 @@ module Google
# approximate time of the API request. An API report has three basic time
# concepts: - *Date of the API's request for a report*: When the API created and
# retrieved the report. - *Report's start time*: The beginning of the timespan
# shown in the report. The startTime must be before the endTime (if specified)
# and the current time when the request is made, or the API returns an error. - *
# Report's end time*: The end of the timespan shown in the report. For example,
# the timespan of events summarized in a report can start in April and end in
# May. The report itself can be requested in August. If the endTime is not
# specified, the report returns all activities from the startTime until the
# current time or the most recent 180 days if the startTime is more than 180
# days in the past.
# shown in the report. The `startTime` must be before the `endTime` (if
# specified) and the current time when the request is made, or the API returns
# an error. - *Report's end time*: The end of the timespan shown in the report.
# For example, the timespan of events summarized in a report can start in April
# and end in May. The report itself can be requested in August. If the `endTime`
# is not specified, the report returns all activities from the `startTime` until
# the current time or the most recent 180 days if the `startTime` is more than
# 180 days in the past.
# @param [String] event_name
# The name of the event being queried by the API. Each eventName is related to a
# specific G Suite service or feature which the API organizes into types of
# The name of the event being queried by the API. Each `eventName` is related to
# a specific G Suite service or feature which the API organizes into types of
# events. An example is the Google Calendar events in the Admin console
# application's reports. The Calendar Settings type structure has all of the
# Calendar eventName activities reported by the API. When an administrator
# application's reports. The Calendar Settings `type` structure has all of the
# Calendar `eventName` activities reported by the API. When an administrator
# changes a Calendar setting, the API reports this activity in the Calendar
# Settings type and eventName parameters. For more information about eventName
# query strings and parameters, see the list of event names for various
# applications above in applicationName.
# Settings `type` and `eventName` parameters. For more information about `
# eventName` query strings and parameters, see the list of event names for
# various applications above in `applicationName`.
# @param [String] filters
# The filters query string is a comma-separated list. The list is composed of
# The `filters` query string is a comma-separated list. The list is composed of
# event parameters that are manipulated by relational operators. Event
# parameters are in the form parameter1 name[parameter1 value],parameter2 name[
# parameter2 value],... These event parameters are associated with a specific
# eventName. An empty report is returned if the filtered request's parameter
# does not belong to the eventName. For more information about eventName
# parameters, see the list of event names for various applications above in
# applicationName. In the following Admin Activity example, the <> operator is
# parameters are in the form `parameter1 name[parameter1 value],parameter2 name[
# parameter2 value],...` These event parameters are associated with a specific `
# eventName`. An empty report is returned if the filtered request's parameter
# does not belong to the `eventName`. For more information about `eventName`
# parameters, see the list of event names for various applications above in `
# applicationName`. In the following Admin Activity example, the <> operator is
# URL-encoded in the request's query string (%3C%3E): GET...&eventName=
# CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the
# following Drive example, the list can be a view or edit event's doc_id
# following Drive example, the list can be a view or edit event's `doc_id`
# parameter with a value that is manipulated by an 'equal to' (==) or 'not equal
# to' (<>) relational operator. In the first example, the report returns each
# edited document's doc_id. In the second example, the report returns each
# viewed document's doc_id that equals the value 12345 and does not return any
# viewed document's which have a doc_id value of 98765. The <> operator is URL-
# edited document's `doc_id`. In the second example, the report returns each
# viewed document's `doc_id` that equals the value 12345 and does not return any
# viewed document's which have a `doc_id` value of 98765. The <> operator is URL-
# encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=
# doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 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=). *
# Note:* The API doesn't accept multiple values of a parameter. If a particular
# parameter is supplied more than once in the API request, the API only accepts
# the last value of that request parameter. In addition, if an invalid request
# parameter is supplied in the API request, the API ignores that request
# parameter and returns the response corresponding to the remaining valid
# request parameters. If no parameters are requested, all parameters are
# 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=). *Note:* The API doesn't accept multiple values of a parameter. If a
# particular parameter is supplied more than once in the API request, the API
# only accepts the last value of that request parameter. In addition, if an
# invalid request parameter is supplied in the API request, the API ignores that
# request parameter and returns the response corresponding to the remaining
# valid request parameters. If no parameters are requested, all parameters are
# returned.
# @param [String] group_id_filter
# 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"
# @param [Fixnum] max_results
# 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.
# 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.
# @param [String] org_unit_id
# ID of the organizational unit to report on. Activity records will be shown
# only for users who belong to the specified organizational unit. Data before
# Dec 17, 2018 doesn't appear in the filtered results.
# @param [String] page_token
# The token to specify next page. A report with multiple pages has a
# nextPageToken property in the response. In your follow-on request getting the
# next page of the report, enter the nextPageToken value in the pageToken query
# string.
# The token to specify next page. A report with multiple pages has a `
# nextPageToken` property in the response. In your follow-on request getting the
# next page of the report, enter the `nextPageToken` value in the `pageToken`
# query string.
# @param [String] start_time
# Sets the beginning of the range of time shown in the report. The date is in
# the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns
# all activities from startTime until endTime. The startTime must be before the
# endTime (if specified) and the current time when the request is made, or the
# API returns an error.
# all activities from `startTime` until `endTime`. The `startTime` must be
# before the `endTime` (if specified) and the current time when the request is
# made, or the API returns an error.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -161,7 +165,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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)
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)
command = make_simple_command(:get, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}', options)
command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation
command.response_class = Google::Apis::AdminReportsV1::Activities
@ -172,6 +176,7 @@ module Google
command.query['endTime'] = end_time unless end_time.nil?
command.query['eventName'] = event_name unless event_name.nil?
command.query['filters'] = filters unless filters.nil?
command.query['groupIdFilter'] = group_id_filter unless group_id_filter.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
command.query['pageToken'] = page_token unless page_token.nil?
@ -185,7 +190,7 @@ module Google
# see Receiving Push Notifications.
# @param [String] user_key
# Represents the profile ID or the user email for which the data should be
# filtered. Can be all for all information, or userKey for a user's unique G
# filtered. Can be `all` for all information, or `userKey` for a user's unique G
# Suite profile ID or their primary email address.
# @param [String] application_name
# Application name for which the events are to be retrieved.
@ -205,75 +210,79 @@ module Google
# approximate time of the API request. An API report has three basic time
# concepts: - *Date of the API's request for a report*: When the API created and
# retrieved the report. - *Report's start time*: The beginning of the timespan
# shown in the report. The startTime must be before the endTime (if specified)
# and the current time when the request is made, or the API returns an error. - *
# Report's end time*: The end of the timespan shown in the report. For example,
# the timespan of events summarized in a report can start in April and end in
# May. The report itself can be requested in August. If the endTime is not
# specified, the report returns all activities from the startTime until the
# current time or the most recent 180 days if the startTime is more than 180
# days in the past.
# shown in the report. The `startTime` must be before the `endTime` (if
# specified) and the current time when the request is made, or the API returns
# an error. - *Report's end time*: The end of the timespan shown in the report.
# For example, the timespan of events summarized in a report can start in April
# and end in May. The report itself can be requested in August. If the `endTime`
# is not specified, the report returns all activities from the `startTime` until
# the current time or the most recent 180 days if the `startTime` is more than
# 180 days in the past.
# @param [String] event_name
# The name of the event being queried by the API. Each eventName is related to a
# specific G Suite service or feature which the API organizes into types of
# The name of the event being queried by the API. Each `eventName` is related to
# a specific G Suite service or feature which the API organizes into types of
# events. An example is the Google Calendar events in the Admin console
# application's reports. The Calendar Settings type structure has all of the
# Calendar eventName activities reported by the API. When an administrator
# application's reports. The Calendar Settings `type` structure has all of the
# Calendar `eventName` activities reported by the API. When an administrator
# changes a Calendar setting, the API reports this activity in the Calendar
# Settings type and eventName parameters. For more information about eventName
# query strings and parameters, see the list of event names for various
# applications above in applicationName.
# Settings `type` and `eventName` parameters. For more information about `
# eventName` query strings and parameters, see the list of event names for
# various applications above in `applicationName`.
# @param [String] filters
# The filters query string is a comma-separated list. The list is composed of
# The `filters` query string is a comma-separated list. The list is composed of
# event parameters that are manipulated by relational operators. Event
# parameters are in the form parameter1 name[parameter1 value],parameter2 name[
# parameter2 value],... These event parameters are associated with a specific
# eventName. An empty report is returned if the filtered request's parameter
# does not belong to the eventName. For more information about eventName
# parameters, see the list of event names for various applications above in
# applicationName. In the following Admin Activity example, the <> operator is
# parameters are in the form `parameter1 name[parameter1 value],parameter2 name[
# parameter2 value],...` These event parameters are associated with a specific `
# eventName`. An empty report is returned if the filtered request's parameter
# does not belong to the `eventName`. For more information about `eventName`
# parameters, see the list of event names for various applications above in `
# applicationName`. In the following Admin Activity example, the <> operator is
# URL-encoded in the request's query string (%3C%3E): GET...&eventName=
# CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the
# following Drive example, the list can be a view or edit event's doc_id
# following Drive example, the list can be a view or edit event's `doc_id`
# parameter with a value that is manipulated by an 'equal to' (==) or 'not equal
# to' (<>) relational operator. In the first example, the report returns each
# edited document's doc_id. In the second example, the report returns each
# viewed document's doc_id that equals the value 12345 and does not return any
# viewed document's which have a doc_id value of 98765. The <> operator is URL-
# edited document's `doc_id`. In the second example, the report returns each
# viewed document's `doc_id` that equals the value 12345 and does not return any
# viewed document's which have a `doc_id` value of 98765. The <> operator is URL-
# encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=
# doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 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=). *
# Note:* The API doesn't accept multiple values of a parameter. If a particular
# parameter is supplied more than once in the API request, the API only accepts
# the last value of that request parameter. In addition, if an invalid request
# parameter is supplied in the API request, the API ignores that request
# parameter and returns the response corresponding to the remaining valid
# request parameters. If no parameters are requested, all parameters are
# 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=). *Note:* The API doesn't accept multiple values of a parameter. If a
# particular parameter is supplied more than once in the API request, the API
# only accepts the last value of that request parameter. In addition, if an
# invalid request parameter is supplied in the API request, the API ignores that
# request parameter and returns the response corresponding to the remaining
# valid request parameters. If no parameters are requested, all parameters are
# returned.
# @param [String] group_id_filter
# 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"
# @param [Fixnum] max_results
# 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.
# 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.
# @param [String] org_unit_id
# ID of the organizational unit to report on. Activity records will be shown
# only for users who belong to the specified organizational unit. Data before
# Dec 17, 2018 doesn't appear in the filtered results.
# @param [String] page_token
# The token to specify next page. A report with multiple pages has a
# nextPageToken property in the response. In your follow-on request getting the
# next page of the report, enter the nextPageToken value in the pageToken query
# string.
# The token to specify next page. A report with multiple pages has a `
# nextPageToken` property in the response. In your follow-on request getting the
# next page of the report, enter the `nextPageToken` value in the `pageToken`
# query string.
# @param [String] start_time
# Sets the beginning of the range of time shown in the report. The date is in
# the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns
# all activities from startTime until endTime. The startTime must be before the
# endTime (if specified) and the current time when the request is made, or the
# API returns an error.
# all activities from `startTime` until `endTime`. The `startTime` must be
# before the `endTime` (if specified) and the current time when the request is
# made, or the API returns an error.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -291,7 +300,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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)
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)
command = make_simple_command(:post, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch', options)
command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
command.request_object = channel_object
@ -304,6 +313,7 @@ module Google
command.query['endTime'] = end_time unless end_time.nil?
command.query['eventName'] = event_name unless event_name.nil?
command.query['filters'] = filters unless filters.nil?
command.query['groupIdFilter'] = group_id_filter unless group_id_filter.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
command.query['pageToken'] = page_token unless page_token.nil?
@ -351,23 +361,25 @@ module Google
# @param [String] customer_id
# The unique ID of the customer to retrieve data for.
# @param [String] page_token
# Token to specify next page. A report with multiple pages has a nextPageToken
# Token to specify next page. A report with multiple pages has a `nextPageToken`
# property in the response. For your follow-on requests getting all of the
# report's pages, enter the nextPageToken value in the pageToken query string.
# report's pages, enter the `nextPageToken` value in the `pageToken` query
# string.
# @param [String] parameters
# The parameters query string is a comma-separated list of event parameters that
# refine a report's results. The parameter is associated with a specific
# application. The application values for the Customers usage report include
# accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail,
# gplus, device_management, meet, and sites. A parameters query string is in the
# CSV form of app_name1:param_name1, app_name2:param_name2. *Note:* The API
# doesn't accept multiple values of a parameter. If a particular parameter is
# supplied more than once in the API request, the API only accepts the last
# value of that request parameter. In addition, if an invalid request parameter
# is supplied in the API request, the API ignores that request parameter and
# returns the response corresponding to the remaining valid request parameters.
# An example of an invalid request parameter is one that does not belong to the
# application. If no parameters are requested, all parameters are returned.
# The `parameters` query string is a comma-separated list of event parameters
# that refine a report's results. The parameter is associated with a specific
# application. The application values for the Customers usage report include `
# accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`
# , `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters`
# query string is in the CSV form of `app_name1:param_name1, app_name2:
# param_name2`. *Note:* The API doesn't accept multiple values of a parameter.
# If a particular parameter is supplied more than once in the API request, the
# API only accepts the last value of that request parameter. In addition, if an
# invalid request parameter is supplied in the API request, the API ignores that
# request parameter and returns the response corresponding to the remaining
# valid request parameters. An example of an invalid request parameter is one
# that does not belong to the application. If no parameters are requested, all
# parameters are returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -412,42 +424,43 @@ module Google
# @param [String] customer_id
# The unique ID of the customer to retrieve data for.
# @param [String] filters
# The filters query string is a comma-separated list of an application's event
# 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>0 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.
# 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.
# @param [Fixnum] max_results
# 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.
# 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.
# @param [String] page_token
# Token to specify next page. A report with multiple pages has a nextPageToken
# Token to specify next page. A report with multiple pages has a `nextPageToken`
# property in the response. In your follow-on request getting the next page of
# the report, enter the nextPageToken value in the pageToken query string.
# the report, enter the `nextPageToken` value in the `pageToken` query string.
# @param [String] parameters
# The parameters query string is a comma-separated list of event parameters that
# refine a report's results. The parameter is associated with a specific
# application. The application values for the Entities usage report are only
# gplus. A parameter query string is in the CSV form of [app_name1:param_name1],
# [app_name2:param_name2].... *Note:* The API doesn't accept multiple values of
# a parameter. If a particular parameter is supplied more than once in the API
# request, the API only accepts the last value of that request parameter. In
# addition, if an invalid request parameter is supplied in the API request, the
# API ignores that request parameter and returns the response corresponding to
# the remaining valid request parameters. An example of an invalid request
# parameter is one that does not belong to the application. If no parameters are
# requested, all parameters are returned.
# The `parameters` query string is a comma-separated list of event parameters
# that refine a report's results. The parameter is associated with a specific
# application. The application values for the Entities usage report are only `
# gplus`. A `parameter` query string is in the CSV form of `[app_name1:
# param_name1], [app_name2:param_name2]...`. *Note:* The API doesn't accept
# multiple values of a parameter. If a particular parameter is supplied more
# than once in the API request, the API only accepts the last value of that
# request parameter. In addition, if an invalid request parameter is supplied in
# the API request, the API ignores that request parameter and returns the
# response corresponding to the remaining valid request parameters. An example
# of an invalid request parameter is one that does not belong to the application.
# If no parameters are requested, all parameters are returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -488,7 +501,7 @@ module Google
# Usage parameters reference guides.
# @param [String] user_key
# Represents the profile ID or the user email for which the data should be
# filtered. Can be all for all information, or userKey for a user's unique G
# filtered. Can be `all` for all information, or `userKey` for a user's unique G
# Suite profile ID or their primary email address.
# @param [String] date
# Represents the date the usage occurred. The timestamp is in the ISO 8601
@ -496,47 +509,52 @@ module Google
# @param [String] customer_id
# The unique ID of the customer to retrieve data for.
# @param [String] filters
# The filters query string is a comma-separated list of an application's event
# 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 Users 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/users/all/dates/2013-03-03 ?
# parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10-
# 28T10:26:35.000Z 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=).
# The `filters` query string includes the name of the application whose usage
# is returned in the report. The application values for the Users 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/users/all/dates/2013-03-03 ?
# parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%
# 3E2010-10-28T10:26:35.000Z 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=).
# @param [String] group_id_filter
# 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"
# @param [Fixnum] max_results
# 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.
# 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.
# @param [String] org_unit_id
# ID of the organizational unit to report on. User activity will be shown only
# for users who belong to the specified organizational unit. Data before Dec 17,
# 2018 doesn't appear in the filtered results.
# @param [String] page_token
# Token to specify next page. A report with multiple pages has a nextPageToken
# Token to specify next page. A report with multiple pages has a `nextPageToken`
# property in the response. In your follow-on request getting the next page of
# the report, enter the nextPageToken value in the pageToken query string.
# the report, enter the `nextPageToken` value in the `pageToken` query string.
# @param [String] parameters
# The parameters query string is a comma-separated list of event parameters that
# refine a report's results. The parameter is associated with a specific
# application. The application values for the Customers usage report include
# accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail,
# gplus, device_management, meet, and sites. A parameters query string is in the
# CSV form of app_name1:param_name1, app_name2:param_name2. *Note:* The API
# doesn't accept multiple values of a parameter. If a particular parameter is
# supplied more than once in the API request, the API only accepts the last
# value of that request parameter. In addition, if an invalid request parameter
# is supplied in the API request, the API ignores that request parameter and
# returns the response corresponding to the remaining valid request parameters.
# An example of an invalid request parameter is one that does not belong to the
# application. If no parameters are requested, all parameters are returned.
# The `parameters` query string is a comma-separated list of event parameters
# that refine a report's results. The parameter is associated with a specific
# application. The application values for the Customers Usage report include `
# accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`
# , `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters`
# query string is in the CSV form of `app_name1:param_name1, app_name2:
# param_name2`. *Note:* The API doesn't accept multiple values of a parameter.
# If a particular parameter is supplied more than once in the API request, the
# API only accepts the last value of that request parameter. In addition, if an
# invalid request parameter is supplied in the API request, the API ignores that
# request parameter and returns the response corresponding to the remaining
# valid request parameters. An example of an invalid request parameter is one
# that does not belong to the application. If no parameters are requested, all
# parameters are returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -554,7 +572,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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)
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)
command = make_simple_command(:get, 'admin/reports/v1/usage/users/{userKey}/dates/{date}', options)
command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
command.response_class = Google::Apis::AdminReportsV1::UsageReports
@ -562,6 +580,7 @@ module Google
command.params['date'] = date unless date.nil?
command.query['customerId'] = customer_id unless customer_id.nil?
command.query['filters'] = filters unless filters.nil?
command.query['groupIdFilter'] = group_id_filter unless group_id_filter.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
command.query['pageToken'] = page_token unless page_token.nil?

11
generated/google/apis/admin_reports_v1/synth.metadata Normal file
View File

@ -0,0 +1,11 @@
{
"sources": [
{
"git": {
"name": ".",
"remote": "https://github.com/googleapis/google-api-ruby-client.git",
"sha": "4a08e0b2fde874551723ca843986ed92d354daf1"
}
}
]
}