Specs

reports_customer_usage_reports_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Reports_v1.Model.UsageReports.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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.

Parameters

• connection (type: GoogleApi.Admin.Reports_v1.Connection.t) - Connection to server

• date (type: String.t) - 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.

• optional_params (type: keyword()) - Optional parameters

  • :alt (type: String.t) - Data format for the response.

  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.

  • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.

  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.

  • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.

  • :customerId (type: String.t) - The unique ID of the customer to retrieve data for.

  • :pageToken (type: String.t) - 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.

  • :parameters (type: String.t) - 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.

• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Admin.Reports_v1.Model.UsageReports{}} on success
• {:error, info} on failure