Class: Google::Apis::AnalyticsreportingV4::AnalyticsReportingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/analyticsreporting_v4/service.rb

Overview

Analytics Reporting API

Accesses Analytics report data.

Examples:

require 'google/apis/analyticsreporting_v4'

Analyticsreporting = Google::Apis::AnalyticsreportingV4 # Alias the module
service = Analyticsreporting::AnalyticsReportingService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AnalyticsReportingService

Returns a new instance of AnalyticsReportingService.



45
46
47
48
 
# File 'generated/google/apis/analyticsreporting_v4/service.rb', line 45

def initialize
  super('https://analyticsreporting.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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/analyticsreporting_v4/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

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.

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.



43
44
45
 
# File 'generated/google/apis/analyticsreporting_v4/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_get_reports(get_reports_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsreportingV4::GetReportsResponse

Returns the Analytics data.

Parameters:

  • get_reports_request_object (Google::Apis::AnalyticsreportingV4::GetReportsRequest) (defaults to: nil)
  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



69
70
71
72
73
74
75
76
77
78
 
# File 'generated/google/apis/analyticsreporting_v4/service.rb', line 69

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

#search_user_activity(search_user_activity_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsreportingV4::SearchUserActivityResponse

Returns User Activity data.

Parameters:

  • search_user_activity_request_object (Google::Apis::AnalyticsreportingV4::SearchUserActivityRequest) (defaults to: nil)
  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



99
100
101
102
103
104
105
106
107
108
 
# File 'generated/google/apis/analyticsreporting_v4/service.rb', line 99

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