Class: Google::Apis::AppsactivityV1::AppsactivityService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/appsactivity_v1/service.rb

Overview

Google Apps Activity API

Provides a historical view of activity.

Examples:

require 'google/apis/appsactivity_v1'

Appsactivity = Google::Apis::AppsactivityV1 # Alias the module
service = Appsactivity::AppsactivityService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeAppsactivityService

Returns a new instance of AppsactivityService.


51
52
53
# File 'generated/google/apis/appsactivity_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'appsactivity/v1/')
end

Instance Attribute Details

#keyString

Returns 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.

Returns:

  • (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.


38
39
40
# File 'generated/google/apis/appsactivity_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns 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.

Returns:

  • (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.


44
45
46
# File 'generated/google/apis/appsactivity_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.


49
50
51
# File 'generated/google/apis/appsactivity_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#list_activities(drive_ancestor_id: nil, drive_file_id: nil, grouping_strategy: nil, page_size: nil, page_token: nil, source: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppsactivityV1::ListActivitiesResponse

Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.

Parameters:

  • drive_ancestor_id (String) (defaults to: nil)

    Identifies the Drive folder containing the items for which to return activities.

  • drive_file_id (String) (defaults to: nil)

    Identifies the Drive item to return activities for.

  • grouping_strategy (String) (defaults to: nil)

    Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of events to return on a page. The response includes a continuation token if there are more events.

  • page_token (String) (defaults to: nil)

    A token to retrieve a specific page of results.

  • source (String) (defaults to: nil)

    The Google service from which to return activities. Possible values of source are:

    • drive.google.com
  • user_id (String) (defaults to: nil)

    Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'generated/google/apis/appsactivity_v1/service.rb', line 101

def list_activities(drive_ancestor_id: nil, drive_file_id: nil, grouping_strategy: nil, page_size: nil, page_token: nil, source: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'activities', options)
  command.response_representation = Google::Apis::AppsactivityV1::ListActivitiesResponse::Representation
  command.response_class = Google::Apis::AppsactivityV1::ListActivitiesResponse
  command.query['drive.ancestorId'] = drive_ancestor_id unless drive_ancestor_id.nil?
  command.query['drive.fileId'] = drive_file_id unless drive_file_id.nil?
  command.query['groupingStrategy'] = grouping_strategy unless grouping_strategy.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['source'] = source unless source.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end