Show / Hide Table of Contents

Class CustomerUsageReportsResource.GetRequest

Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<UsageReports>
ReportsBaseServiceRequest<UsageReports>
CustomerUsageReportsResource.GetRequest
Implements
IClientServiceRequest<UsageReports>
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
ClientServiceRequest<UsageReports>.Execute()
ClientServiceRequest<UsageReports>.ExecuteAsStream()
ClientServiceRequest<UsageReports>.ExecuteAsync()
ClientServiceRequest<UsageReports>.ExecuteAsync(CancellationToken)
ClientServiceRequest<UsageReports>.ExecuteAsStreamAsync()
ClientServiceRequest<UsageReports>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<UsageReports>.CreateRequest(bool?)
ClientServiceRequest<UsageReports>.GenerateRequestUri()
ClientServiceRequest<UsageReports>.GetBody()
ClientServiceRequest<UsageReports>.GetDefaultETagAction(string)
ClientServiceRequest<UsageReports>.ETagAction
ClientServiceRequest<UsageReports>.ModifyRequest
ClientServiceRequest<UsageReports>.ValidateParameters
ClientServiceRequest<UsageReports>.ApiVersion
ClientServiceRequest<UsageReports>.RequestParameters
ClientServiceRequest<UsageReports>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Admin.Reports.reports_v1
Assembly: Google.Apis.Admin.Reports.reports_v1.dll
Syntax
public class CustomerUsageReportsResource.GetRequest : ReportsBaseServiceRequest<UsageReports>, IClientServiceRequest<UsageReports>, IClientServiceRequest

Constructors

GetRequest(IClientService, string)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string date)
Parameters
Type Name Description
IClientService service
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
string

Date

Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the ISO 8601 format, yyyy-mm-dd.

Declaration
[RequestParameter("date", RequestParameterType.Path)]
public virtual string Date { get; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<UsageReports>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<UsageReports>.MethodName

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
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, chat, 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
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<UsageReports>.RestPath

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
ReportsBaseServiceRequest<UsageReports>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX