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

API calls for all endpoints tagged Activities.

Link to this section Summary

Link to this section Functions

Link to this function

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

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

Parameters

  • connection (GoogleApi.Admin.Reports_v1.Connection): Connection to server
  • user_key (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 (String.t): Application name for which the events are to be retrieved.
  • 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.
    • :actorIpAddress (String.t): IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
    • :customerId (String.t): Represents the customer for which the data is to be fetched.
    • :endTime (String.t): Return events which occurred at or before this time.
    • :eventName (String.t): Name of the event being queried.
    • :filters (String.t): Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
    • :maxResults (integer()): Number of activity records to be shown in each page.
    • :orgUnitID (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 (String.t): Token to specify next page.
    • :startTime (String.t): Return events which occurred at or after this time.

Returns

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

Link to this function

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

Push changes to activities

Parameters

  • connection (GoogleApi.Admin.Reports_v1.Connection): Connection to server
  • user_key (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 (String.t): Application name for which the events are to be retrieved.
  • 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.
    • :actorIpAddress (String.t): IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
    • :customerId (String.t): Represents the customer for which the data is to be fetched.
    • :endTime (String.t): Return events which occurred at or before this time.
    • :eventName (String.t): Name of the event being queried.
    • :filters (String.t): Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
    • :maxResults (integer()): Number of activity records to be shown in each page.
    • :orgUnitID (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 (String.t): Token to specify next page.
    • :startTime (String.t): Return events which occurred at or after this time.
    • :resource (Channel):

Returns

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