google_api_admin

v0.6.0

google_api_admin v0.6.0 GoogleApi.Admin.Reports_v1.Api.EntityUsageReports View Source

API calls for all endpoints tagged EntityUsageReports.

Link to this section Summary

Functions

reports_entity_usage_reports_get(connection, entity_type, entity_key, date, optional_params \\ [], opts \\ [])

Retrieves a report which is a collection of properties / statistics for a set of objects.

Link to this section Functions

Link to this function

reports_entity_usage_reports_get(connection, entity_type, entity_key, date, optional_params \\ [], opts \\ [])

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

Retrieves a report which is a collection of properties / statistics for a set of objects.

Parameters

  • connection (type: GoogleApi.Admin.Reports_v1.Connection.t) - Connection to server
  • entity_type (type: String.t) - Type of object. Should be one of - gplus_communities.
  • entity_key (type: String.t) - Represents the key of object for which the data should be filtered.
  • date (type: String.t) - Represents the date in yyyy-mm-dd format for which the data is to be fetched.

  • 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) - Represents the customer for which the data is to be fetched.
    • :filters (type: String.t) - Represents the set of filters including parameter operator value.
    • :maxResults (type: integer()) - Maximum number of results to return. Maximum allowed is 1000
    • :pageToken (type: String.t) - Token to specify next page.
    • :parameters (type: String.t) - Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
  • opts (type: keyword()) - Call options

Returns

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