Class: Google::Apis::AnalyticsdataV1beta::AnalyticsDataService

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

Overview

Google Analytics Data API

Accesses report data in Google Analytics.

Examples:

require 'google/apis/analyticsdata_v1beta'

Analyticsdata = Google::Apis::AnalyticsdataV1beta # Alias the module
service = Analyticsdata::AnalyticsDataService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AnalyticsDataService

Returns a new instance of AnalyticsDataService.



45
46
47
48
49
50
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 45

def initialize
  super('https://analyticsdata.googleapis.com/', '',
        client_name: 'google-apis-analyticsdata_v1beta',
        client_version: Google::Apis::AnalyticsdataV1beta::GEM_VERSION)
  @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 'lib/google/apis/analyticsdata_v1beta/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 'lib/google/apis/analyticsdata_v1beta/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_property_run_pivot_reports(property, batch_run_pivot_reports_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsdataV1beta::BatchRunPivotReportsResponse

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.

Parameters:

  • property (String) —

    A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234

  • batch_run_pivot_reports_request_object (Google::Apis::AnalyticsdataV1beta::BatchRunPivotReportsRequest) (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



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 79

def batch_property_run_pivot_reports(property, batch_run_pivot_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+property}:batchRunPivotReports', options)
  command.request_representation = Google::Apis::AnalyticsdataV1beta::BatchRunPivotReportsRequest::Representation
  command.request_object = batch_run_pivot_reports_request_object
  command.response_representation = Google::Apis::AnalyticsdataV1beta::BatchRunPivotReportsResponse::Representation
  command.response_class = Google::Apis::AnalyticsdataV1beta::BatchRunPivotReportsResponse
  command.params['property'] = property unless property.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_property_run_reports(property, batch_run_reports_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsdataV1beta::BatchRunReportsResponse

Returns multiple reports in a batch. All reports must be for the same GA4 Property.

Parameters:

  • property (String) —

    A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234

  • batch_run_reports_request_object (Google::Apis::AnalyticsdataV1beta::BatchRunReportsRequest) (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



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 118

def batch_property_run_reports(property, batch_run_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+property}:batchRunReports', options)
  command.request_representation = Google::Apis::AnalyticsdataV1beta::BatchRunReportsRequest::Representation
  command.request_object = batch_run_reports_request_object
  command.response_representation = Google::Apis::AnalyticsdataV1beta::BatchRunReportsResponse::Representation
  command.response_class = Google::Apis::AnalyticsdataV1beta::BatchRunReportsResponse
  command.params['property'] = property unless property.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_property_compatibility(property, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

Parameters:

  • property (String) —

    A Google Analytics GA4 property identifier whose events are tracked. To learn more, see where to find your Property ID. property should be the same value as in your runReport request. Example: properties/1234 Set the Property ID to 0 for compatibility checking on dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

  • check_compatibility_request_object (Google::Apis::AnalyticsdataV1beta::CheckCompatibilityRequest) (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



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 163

def check_property_compatibility(property, check_compatibility_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+property}:checkCompatibility', options)
  command.request_representation = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityRequest::Representation
  command.request_object = check_compatibility_request_object
  command.response_representation = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse::Representation
  command.response_class = Google::Apis::AnalyticsdataV1beta::CheckCompatibilityResponse
  command.params['property'] = property unless property.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_property_metadata(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsdataV1beta::Metadata

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked . Universal metadata are dimensions and metrics applicable to any property such as country and totalUsers.

Parameters:

  • name (String) —

    Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID. Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

  • 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



208
209
210
211
212
213
214
215
216
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 208

def get_property_metadata(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::AnalyticsdataV1beta::Metadata::Representation
  command.response_class = Google::Apis::AnalyticsdataV1beta::Metadata
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_property_pivot_report(property, run_pivot_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsdataV1beta::RunPivotReportResponse

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

Parameters:

  • property (String) —

    A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/ 1234

  • run_pivot_report_request_object (Google::Apis::AnalyticsdataV1beta::RunPivotReportRequest) (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



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 247

def run_property_pivot_report(property, run_pivot_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+property}:runPivotReport', options)
  command.request_representation = Google::Apis::AnalyticsdataV1beta::RunPivotReportRequest::Representation
  command.request_object = run_pivot_report_request_object
  command.response_representation = Google::Apis::AnalyticsdataV1beta::RunPivotReportResponse::Representation
  command.response_class = Google::Apis::AnalyticsdataV1beta::RunPivotReportResponse
  command.params['property'] = property unless property.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_property_realtime_report(property, run_realtime_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsdataV1beta::RunRealtimeReportResponse

The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.

Parameters:

  • property (String) —

    A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Example: properties/1234

  • run_realtime_report_request_object (Google::Apis::AnalyticsdataV1beta::RunRealtimeReportRequest) (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



285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 285

def run_property_realtime_report(property, run_realtime_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+property}:runRealtimeReport', options)
  command.request_representation = Google::Apis::AnalyticsdataV1beta::RunRealtimeReportRequest::Representation
  command.request_object = run_realtime_report_request_object
  command.response_representation = Google::Apis::AnalyticsdataV1beta::RunRealtimeReportResponse::Representation
  command.response_class = Google::Apis::AnalyticsdataV1beta::RunRealtimeReportResponse
  command.params['property'] = property unless property.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_property_report(property, run_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsdataV1beta::RunReportResponse

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

Parameters:

  • property (String) —

    A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/ 1234

  • run_report_request_object (Google::Apis::AnalyticsdataV1beta::RunReportRequest) (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



329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/google/apis/analyticsdata_v1beta/service.rb', line 329

def run_property_report(property, run_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+property}:runReport', options)
  command.request_representation = Google::Apis::AnalyticsdataV1beta::RunReportRequest::Representation
  command.request_object = run_report_request_object
  command.response_representation = Google::Apis::AnalyticsdataV1beta::RunReportResponse::Representation
  command.response_class = Google::Apis::AnalyticsdataV1beta::RunReportResponse
  command.params['property'] = property unless property.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end