Class: Google::Apis::AnalyticsdataV1alpha::RunRealtimeReportRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsdata_v1alpha/classes.rb,
lib/google/apis/analyticsdata_v1alpha/representations.rb,
lib/google/apis/analyticsdata_v1alpha/representations.rb

Overview

The request to generate a realtime report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunRealtimeReportRequest

Returns a new instance of RunRealtimeReportRequest.



1512
1513
1514
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1512

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dimension_filter ⇒ Google::Apis::AnalyticsdataV1alpha::FilterExpression

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. Corresponds to the JSON property dimensionFilter

Returns:



1469
1470
1471
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1469

def dimension_filter
  @dimension_filter
end

#dimensions ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Dimension>

The dimensions requested and displayed. Corresponds to the JSON property dimensions

Returns:



1474
1475
1476
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1474

def dimensions
  @dimensions
end

#limit ⇒ Fixnum

The number of rows to return. If the limit parameter is unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


1481
1482
1483
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1481

def limit
  @limit
end

#metric_aggregations ⇒ Array<String>

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". Corresponds to the JSON property metricAggregations

Returns:

  • (Array<String>) 


1487
1488
1489
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1487

def metric_aggregations
  @metric_aggregations
end

#metric_filter ⇒ Google::Apis::AnalyticsdataV1alpha::FilterExpression

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. Corresponds to the JSON property metricFilter

Returns:



1493
1494
1495
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1493

def metric_filter
  @metric_filter
end

#metrics ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Metric>

The metrics requested and displayed. Corresponds to the JSON property metrics

Returns:



1498
1499
1500
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1498

def metrics
  @metrics
end

#order_bys ⇒ Array<Google::Apis::AnalyticsdataV1alpha::OrderBy>

Specifies how rows are ordered in the response. Corresponds to the JSON property orderBys

Returns:



1503
1504
1505
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1503

def order_bys
  @order_bys
end

#return_property_quota ⇒ Boolean Also known as: return_property_quota?

Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota. Corresponds to the JSON property returnPropertyQuota

Returns:

  • (Boolean) 


1509
1510
1511
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1509

def return_property_quota
  @return_property_quota
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1517

def update!(**args)
  @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @limit = args[:limit] if args.key?(:limit)
  @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
  @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
  @metrics = args[:metrics] if args.key?(:metrics)
  @order_bys = args[:order_bys] if args.key?(:order_bys)
  @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
end