get method

Future<UsageReports> get(
  1. String entityType,
  2. String entityKey,
  3. String date, {
  4. String? customerId,
  5. String? filters,
  6. int? maxResults,
  7. String? pageToken,
  8. String? parameters,
  9. String? $fields,
})

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.

Request parameters:

entityType - Represents the type of entity for the report. Value must have pattern (gplus_communities). Possible string values are:

  • "gplus_communities" : Returns a report on Google+ communities.

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.

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. Value must have pattern (\d){4}-(\d){2}-(\d){2}.

customerId - The unique ID of the customer to retrieve data for. Value must have pattern C.+|my_customer.

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 <> '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 &filters=gplus:num_total_members%3C%3E0 The relational operators include:

  • == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E).
  • < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters. Value must have pattern (((gplus)):\[a-z0-9_\]+\[\<,\<=,==,\>=,\>,!=\]\[^,\]+,)*(((gplus)):\[a-z0-9_\]+\[\<,\<=,==,\>=,\>,!=\]\[^,\]+).

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. Value must be between "1" and "1000".

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.

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. Value must have pattern (((gplus)):\[^,\]+,)*(((gplus)):\[^,\]+).

$fields - Selector specifying which fields to include in a partial response.

Completes with a UsageReports.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<UsageReports> get(
  core.String entityType,
  core.String entityKey,
  core.String date, {
  core.String? customerId,
  core.String? filters,
  core.int? maxResults,
  core.String? pageToken,
  core.String? parameters,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (customerId != null) 'customerId': [customerId],
    if (filters != null) 'filters': [filters],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (parameters != null) 'parameters': [parameters],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'admin/reports/v1/usage/' +
      commons.escapeVariable('$entityType') +
      '/' +
      commons.escapeVariable('$entityKey') +
      '/dates/' +
      commons.escapeVariable('$date');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return UsageReports.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}