Show / Hide Table of Contents

Class EntityUsageReportsResource.GetRequest

Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<UsageReports>
ReportsBaseServiceRequest<UsageReports>
EntityUsageReportsResource.GetRequest
Implements
Google.Apis.Requests.IClientServiceRequest<UsageReports>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
ReportsBaseServiceRequest<UsageReports>.Xgafv
ReportsBaseServiceRequest<UsageReports>.AccessToken
ReportsBaseServiceRequest<UsageReports>.Alt
ReportsBaseServiceRequest<UsageReports>.Callback
ReportsBaseServiceRequest<UsageReports>.Fields
ReportsBaseServiceRequest<UsageReports>.Key
ReportsBaseServiceRequest<UsageReports>.OauthToken
ReportsBaseServiceRequest<UsageReports>.PrettyPrint
ReportsBaseServiceRequest<UsageReports>.QuotaUser
ReportsBaseServiceRequest<UsageReports>.UploadType
ReportsBaseServiceRequest<UsageReports>.UploadProtocol
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Admin.Reports.reports_v1
Assembly: Google.Apis.Admin.Reports.reports_v1.dll
Syntax
public class GetRequest : ReportsBaseServiceRequest<UsageReports>, IClientServiceRequest<UsageReports>, IClientServiceRequest

Constructors

GetRequest(IClientService, EntityUsageReportsResource.GetRequest.EntityTypeEnum, String, String)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, EntityUsageReportsResource.GetRequest.EntityTypeEnum entityType, string entityKey, string date)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
EntityUsageReportsResource.GetRequest.EntityTypeEnum entityType
System.String entityKey
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

EntityKey

Represents the key of the object to filter the data with. It is a string which can take the value all to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the entityKey for a particular entityType, see the Entities Usage parameters reference guides.

Declaration
[RequestParameter("entityKey", RequestParameterType.Path)]
public virtual string EntityKey { get; }
Property Value
Type Description
System.String

EntityType

Represents the type of entity for the report.

Declaration
[RequestParameter("entityType", RequestParameterType.Path)]
public virtual EntityUsageReportsResource.GetRequest.EntityTypeEnum EntityType { get; }
Property Value
Type Description
EntityUsageReportsResource.GetRequest.EntityTypeEnum

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 Entities usage report include accounts, docs, and gmail. Filters are in the form [application name]:parameter name[parameter value],.... In this example, the &amp;lt;&amp;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/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &amp;filters=gplus:num_total_members%3C%3E0 The relational operators include: - == - 'equal to'. - &amp;lt;&amp;gt; - 'not equal to'. It is URL-encoded (%3C%3E). - &amp;lt; - 'less than'. It is URL-encoded (%3C). - &amp;lt;= - 'less than or equal to'. It is URL-encoded (%3C=). - &amp;gt; - 'greater than'. It is URL-encoded (%3E). - &amp;gt;= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.

Declaration
[RequestParameter("filters", RequestParameterType.Query)]
public virtual string Filters { 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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.HttpMethod

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.

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.MethodName

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 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.

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.RestPath

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Admin.Reports.reports_v1.ReportsBaseServiceRequest<Google.Apis.Admin.Reports.reports_v1.Data.UsageReports>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest
In This Article
Back to top