google_api_admin v0.4.0 GoogleApi.Admin.Reports_v1.Api.EntityUsageReports View Source
API calls for all endpoints tagged EntityUsageReports
.
Link to this section Summary
Functions
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
Retrieves a report which is a collection of properties / statistics for a set of objects.
Parameters
- connection (GoogleApi.Admin.Reports_v1.Connection): Connection to server
- entity_type (String.t): Type of object. Should be one of - gplus_communities.
- entity_key (String.t): Represents the key of object for which the data should be filtered.
- date (String.t): Represents the date in yyyy-mm-dd format for which the data is to be fetched.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :customerId (String.t): Represents the customer for which the data is to be fetched.
- :filters (String.t): Represents the set of filters including parameter operator value.
- :maxResults (integer()): Maximum number of results to return. Maximum allowed is 1000
- :pageToken (String.t): Token to specify next page.
- :parameters (String.t): Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
Returns
{:ok, %GoogleApi.Admin.Reports_v1.Model.UsageReports{}} on success {:error, info} on failure