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

API calls for all endpoints tagged Activities.

Link to this section Summary

Functions

reports_activities_list(connection, user_key, application_name, optional_params \\ [], opts \\ [])

Retrieves a list of activities for a specific customer and application.

reports_activities_watch(connection, user_key, application_name, optional_params \\ [], opts \\ [])

Push changes to activities

Link to this section Functions

reports_activities_list(connection, user_key, application_name, optional_params \\ [], opts \\ [])

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

Retrieves a list of activities for a specific customer and application.

Parameters

connection (type: GoogleApi.Admin.Reports_v1.Connection.t) - Connection to server
user_key (type: String.t) - Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.
application_name (type: String.t) - Application name for which the events are to be retrieved.
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.
- :actorIpAddress (type: String.t) - IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
- :customerId (type: String.t) - Represents the customer for which the data is to be fetched.
- :endTime (type: String.t) - Return events which occurred at or before this time.
- :eventName (type: String.t) - Name of the event being queried.
- :filters (type: String.t) - Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
- :maxResults (type: integer()) - Number of activity records to be shown in each page.
- :orgUnitID (type: String.t) - the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)
- :pageToken (type: String.t) - Token to specify next page.
- :startTime (type: String.t) - Return events which occurred at or after this time.
opts (type: keyword()) - Call options

Returns

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

reports_activities_watch(connection, user_key, application_name, optional_params \\ [], opts \\ [])

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

Push changes to activities

Parameters

connection (type: GoogleApi.Admin.Reports_v1.Connection.t) - Connection to server
user_key (type: String.t) - Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.
application_name (type: String.t) - Application name for which the events are to be retrieved.
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.
- :actorIpAddress (type: String.t) - IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
- :customerId (type: String.t) - Represents the customer for which the data is to be fetched.
- :endTime (type: String.t) - Return events which occurred at or before this time.
- :eventName (type: String.t) - Name of the event being queried.
- :filters (type: String.t) - Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
- :maxResults (type: integer()) - Number of activity records to be shown in each page.
- :orgUnitID (type: String.t) - the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)
- :pageToken (type: String.t) - Token to specify next page.
- :startTime (type: String.t) - Return events which occurred at or after this time.
- :resource (type: GoogleApi.Admin.Reports_v1.Model.Channel.t) -
opts (type: keyword()) - Call options

Returns

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