Class: Google::Apis::AdminReportsV1::ReportsService

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

Overview

Admin Reports API

Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.

Examples:

require 'google/apis/admin_reports_v1'

Admin = Google::Apis::AdminReportsV1 # Alias the module
service = Admin::ReportsService.new

See Also:

  • /admin-sdk/reports/

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

Methods included from Core::Logging

#logger

Constructor Details

#initializeReportsService

Returns a new instance of ReportsService.


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

def initialize
  super('https://www.googleapis.com/', 'admin/reports/v1/')
  @batch_path = 'batch/admin/reports_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.


39
40
41
# File 'generated/google/apis/admin_reports_v1/service.rb', line 39

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.


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

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


48
49
50
# File 'generated/google/apis/admin_reports_v1/service.rb', line 48

def user_ip
  @user_ip
end

Instance Method Details

#get_customer_usage_report(date, customer_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminReportsV1::UsageReports

Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides.

Parameters:

  • date (String)

    Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.

  • customer_id (String) (defaults to: nil)

    The unique ID of the customer to retrieve data for.

  • page_token (String) (defaults to: nil)

    Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string.

  • parameters (String) (defaults to: nil)

    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 Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


420
421
422
423
424
425
426
427
428
429
430
431
432
# File 'generated/google/apis/admin_reports_v1/service.rb', line 420

def get_customer_usage_report(date, customer_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'usage/dates/{date}', options)
  command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
  command.response_class = Google::Apis::AdminReportsV1::UsageReports
  command.params['date'] = date unless date.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parameters'] = parameters unless parameters.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

#get_entity_usage_report(entity_type, entity_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminReportsV1::UsageReports

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.

Parameters:

  • entity_type (String)

    Represents the type of entity for the report.

  • entity_key (String)

    Represents the key of the object to filter the data with.

  • date (String)

    Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.

  • customer_id (String) (defaults to: nil)

    The unique ID of the customer to retrieve data for.

  • filters (String) (defaults to: nil)

    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][relational operator][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>0 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.
  • max_results (Fixnum) (defaults to: nil)

    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.

  • page_token (String) (defaults to: nil)

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

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
# File 'generated/google/apis/admin_reports_v1/service.rb', line 511

def get_entity_usage_report(entity_type, entity_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'usage/{entityType}/{entityKey}/dates/{date}', options)
  command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
  command.response_class = Google::Apis::AdminReportsV1::UsageReports
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.params['entityKey'] = entity_key unless entity_key.nil?
  command.params['date'] = date unless date.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parameters'] = parameters unless parameters.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

#get_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminReportsV1::UsageReports

Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides.

Parameters:

  • user_key (String)

    Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.

  • date (String)

    Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.

  • customer_id (String) (defaults to: nil)

    The unique ID of the customer to retrieve data for.

  • filters (String) (defaults to: nil)

    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 Users Usage Report include accounts, docs, and gmail. Filters are in the form [application name]:[parameter name][relational operator][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/users/all/dates/2013-03- 03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010- 10-28T10:26:35.000Z 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=).
  • max_results (Fixnum) (defaults to: nil)

    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. The maxResults query string is optional.

  • org_unit_id (String) (defaults to: nil)

    ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.

  • page_token (String) (defaults to: nil)

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

    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 Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
# File 'generated/google/apis/admin_reports_v1/service.rb', line 611

def get_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'usage/users/{userKey}/dates/{date}', options)
  command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
  command.response_class = Google::Apis::AdminReportsV1::UsageReports
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['date'] = date unless date.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parameters'] = parameters unless parameters.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

#list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminReportsV1::Activities

Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.

Parameters:

  • user_key (String)

    Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.

  • application_name (String)

    Application name for which the events are to be retrieved.

  • actor_ip_address (String) (defaults to: nil)

    The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.

  • customer_id (String) (defaults to: nil)

    The unique ID of the customer to retrieve data for.

  • end_time (String) (defaults to: nil)

    Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts:

    • Date of the API's request for a report: When the API created and retrieved the report.
    • Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.
    • Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.
  • event_name (String) (defaults to: nil)

    The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.

  • filters (String) (defaults to: nil)

    The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% 3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL- encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== 12345,doc_id%3C%3E98765 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=). 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. If no parameters are requested, all parameters are returned.
  • max_results (Fixnum) (defaults to: nil)

    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. The maxResults query string is optional in the request. The default value is 1000.

  • org_unit_id (String) (defaults to: nil)

    ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.

  • page_token (String) (defaults to: nil)

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

  • start_time (String) (defaults to: nil)

    Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'generated/google/apis/admin_reports_v1/service.rb', line 177

def list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'activity/users/{userKey}/applications/{applicationName}', options)
  command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation
  command.response_class = Google::Apis::AdminReportsV1::Activities
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['applicationName'] = application_name unless application_name.nil?
  command.query['actorIpAddress'] = actor_ip_address unless actor_ip_address.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['eventName'] = event_name unless event_name.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startTime'] = start_time unless start_time.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

#stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Stop watching resources through this channel

Parameters:

  • channel_object (Google::Apis::AdminReportsV1::Channel) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


362
363
364
365
366
367
368
369
370
# File 'generated/google/apis/admin_reports_v1/service.rb', line 362

def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '/admin/reports_v1/channels/stop', options)
  command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
  command.request_object = channel_object
  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

#watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminReportsV1::Channel

Start receiving notifications for account activities. For more information, see Receiving Push Notifications.

Parameters:

  • user_key (String)

    Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.

  • application_name (String)

    Application name for which the events are to be retrieved.

  • channel_object (Google::Apis::AdminReportsV1::Channel) (defaults to: nil)
  • actor_ip_address (String) (defaults to: nil)

    The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.

  • customer_id (String) (defaults to: nil)

    The unique ID of the customer to retrieve data for.

  • end_time (String) (defaults to: nil)

    Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts:

    • Date of the API's request for a report: When the API created and retrieved the report.
    • Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.
    • Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.
  • event_name (String) (defaults to: nil)

    The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.

  • filters (String) (defaults to: nil)

    The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% 3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL- encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== 12345,doc_id%3C%3E98765 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=). 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. If no parameters are requested, all parameters are returned.
  • max_results (Fixnum) (defaults to: nil)

    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. The maxResults query string is optional in the request. The default value is 1000.

  • org_unit_id (String) (defaults to: nil)

    ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.

  • page_token (String) (defaults to: nil)

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

  • start_time (String) (defaults to: nil)

    Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'generated/google/apis/admin_reports_v1/service.rb', line 318

def watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'activity/users/{userKey}/applications/{applicationName}/watch', options)
  command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::AdminReportsV1::Channel::Representation
  command.response_class = Google::Apis::AdminReportsV1::Channel
  command.params['userKey'] = user_key unless user_key.nil?
  command.params['applicationName'] = application_name unless application_name.nil?
  command.query['actorIpAddress'] = actor_ip_address unless actor_ip_address.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['eventName'] = event_name unless event_name.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orgUnitID'] = org_unit_id unless org_unit_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startTime'] = start_time unless start_time.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