com.google.api.services.reports

Class Reports.UserUsageReport

java.lang.Object

com.google.api.services.reports.Reports.UserUsageReport

Enclosing class:

Reports

public class Reports.UserUsageReport
extends Object

The "userUsageReport" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Reports.UserUsageReport.Get

Constructor Summary

Constructors

Constructor and Description
UserUsageReport()

Method Summary

Modifier and Type	Method and Description
Reports.UserUsageReport.Get	get(String userKey, String date) Retrieves a report which is a collection of properties and statistics for a set of users with the account.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserUsageReport

public UserUsageReport()

Method Detail

get

public Reports.UserUsageReport.Get get(String userKey,
                                       String date)
                                throws IOException

Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides. Create a request for the method "userUsageReport.get". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userKey - 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 Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`.

date - Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.

Returns:

the request

Throws:

IOException