class Google::Apis::AnalyticsreportingV4::AnalyticsReportingService
Analytics Reporting API
Accesses Analytics report data.
@example
require 'google/apis/analyticsreporting_v4' Analyticsreporting = Google::Apis::AnalyticsreportingV4 # Alias the module service = Analyticsreporting::AnalyticsReportingService.new
@see developers.google.com/analytics/devguides/reporting/core/v4/
Attributes
@return [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.
@return [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.
Public Class Methods
# File lib/google/apis/analyticsreporting_v4/service.rb, line 45 def initialize super('https://analyticsreporting.googleapis.com/', '', client_name: 'google-apis-analyticsreporting_v4', client_version: Google::Apis::AnalyticsreportingV4::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Returns the Analytics data. @param [Google::Apis::AnalyticsreportingV4::GetReportsRequest] get_reports_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AnalyticsreportingV4::GetReportsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AnalyticsreportingV4::GetReportsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/analyticsreporting_v4/service.rb, line 71 def batch_get_reports(get_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/reports:batchGet', options) command.request_representation = Google::Apis::AnalyticsreportingV4::GetReportsRequest::Representation command.request_object = get_reports_request_object command.response_representation = Google::Apis::AnalyticsreportingV4::GetReportsResponse::Representation command.response_class = Google::Apis::AnalyticsreportingV4::GetReportsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Returns User
Activity
data. @param [Google::Apis::AnalyticsreportingV4::SearchUserActivityRequest] search_user_activity_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AnalyticsreportingV4::SearchUserActivityResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AnalyticsreportingV4::SearchUserActivityResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/analyticsreporting_v4/service.rb, line 101 def search_user_activity(search_user_activity_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/userActivity:search', options) command.request_representation = Google::Apis::AnalyticsreportingV4::SearchUserActivityRequest::Representation command.request_object = search_user_activity_request_object command.response_representation = Google::Apis::AnalyticsreportingV4::SearchUserActivityResponse::Representation command.response_class = Google::Apis::AnalyticsreportingV4::SearchUserActivityResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File lib/google/apis/analyticsreporting_v4/service.rb, line 114 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end