Class: Google::Analytics::Data::V1alpha::RunRealtimeReportRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb

Overview

The request to generate a realtime report.

Instance Attribute Summary collapse

Instance Attribute Details

#dimension_filter ⇒ ::Google::Analytics::Data::V1alpha::FilterExpression

Returns The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Returns:



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dimensions ⇒ ::Array<::Google::Analytics::Data::V1alpha::Dimension>

Returns The dimensions requested and displayed.

Returns:



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#limit ⇒ ::Integer

Returns The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

Returns:

  • (::Integer) —

    The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metric_aggregations ⇒ ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>

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

Returns:



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metric_filter ⇒ ::Google::Analytics::Data::V1alpha::FilterExpression

Returns The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

Returns:



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metrics ⇒ ::Array<::Google::Analytics::Data::V1alpha::Metric>

Returns The metrics requested and displayed.

Returns:



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_bys ⇒ ::Array<::Google::Analytics::Data::V1alpha::OrderBy>

Returns Specifies how rows are ordered in the response.

Returns:



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#property ⇒ ::String

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

Returns:

  • (::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



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#return_property_quota ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



380
381
382
383
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 380

class RunRealtimeReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end