Class UserUsageReportResource.GetRequest
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.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Admin.Reports.reports_v1
Assembly: Google.Apis.Admin.Reports.reports_v1.dll
Syntax
public class GetRequest : ReportsBaseServiceRequest<UsageReports>, IClientServiceRequest<UsageReports>, IClientServiceRequestConstructors
GetRequest(IClientService, String, String)
Constructs a new Get request.
Declaration
public GetRequest(IClientService service, string userKey, string date)Parameters
| Type | Name | Description |
|---|---|---|
| Google.Apis.Services.IClientService | service | |
| System.String | userKey | |
| System.String | date |
Properties
CustomerId
The unique ID of the customer to retrieve data for.
Declaration
[RequestParameter("customerId", RequestParameterType.Query)]
public virtual string CustomerId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Date
Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.
Declaration
[RequestParameter("date", RequestParameterType.Path)]
public virtual string Date { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Filters
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 &lt;&gt; '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'. - &lt;&gt; - 'not equal to'. It is URL-encoded (%3C%3E). -
&lt; - 'less than'. It is URL-encoded (%3C). - &lt;= - 'less than or equal to'. It is
URL-encoded (%3C=). - &gt; - 'greater than'. It is URL-encoded (%3E). - &gt;= - 'greater
than or equal to'. It is URL-encoded (%3E=).
Declaration
[RequestParameter("filters", RequestParameterType.Query)]
public virtual string Filters { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
GroupIdFilter
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"
Declaration
[RequestParameter("groupIdFilter", RequestParameterType.Query)]
public virtual string GroupIdFilter { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
MaxResults
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.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
OrgUnitID
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.
Declaration
[RequestParameter("orgUnitID", RequestParameterType.Query)]
public virtual string OrgUnitID { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PageToken
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.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }Property Value
| Type | Description |
|---|---|
| System.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.
Declaration
[RequestParameter("parameters", RequestParameterType.Query)]
public virtual string Parameters { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
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.
Declaration
[RequestParameter("userKey", RequestParameterType.Path)]
public virtual string UserKey { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
InitParameters()
Initializes Get parameter list.
Declaration
protected override void InitParameters()