google_api_admin v0.0.1 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, opts \\ []) View Source
reports_activities_list(Tesla.Env.client, String.t, String.t, 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 (GoogleApi.Admin.Reports_v1.Connection): Connection to server
  • user_key (String): 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): Application name for which the events are to be retrieved.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :actor_ip_address (String): IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
    • :customer_id (String): Represents the customer for which the data is to be fetched.
    • :end_time (String): Return events which occurred at or before this time.
    • :event_name (String): Name of the event being queried.
    • :filters (String): Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],…
    • :max_results (Integer): Number of activity records to be shown in each page.
    • :page_token (String): Token to specify next page.
    • :start_time (String): 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, opts \\ []) View Source
reports_activities_watch(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Admin.Reports_v1.Model.Channel.t} |
  {:error, Tesla.Env.t}

Push changes to activities

Parameters

  • connection (GoogleApi.Admin.Reports_v1.Connection): Connection to server
  • user_key (String): 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): Application name for which the events are to be retrieved.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :actor_ip_address (String): IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
    • :customer_id (String): Represents the customer for which the data is to be fetched.
    • :end_time (String): Return events which occurred at or before this time.
    • :event_name (String): Name of the event being queried.
    • :filters (String): Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],…
    • :max_results (Integer): Number of activity records to be shown in each page.
    • :page_token (String): Token to specify next page.
    • :start_time (String): 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