Class: Google::Analytics::Data::V1beta::RunRealtimeReportRequest

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

Overview

The request to generate a realtime report.

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The filter clause of dimensions. Metrics cannot be used in this filter.

Returns:



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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

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

Returns The dimensions requested and displayed.

Returns:



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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

#limit ⇒ ::Integer

Returns The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

Returns:

  • (::Integer) —

    The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

    The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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

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

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

Returns:



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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

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

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

Returns:



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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

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

Returns The metrics requested and displayed.

Returns:



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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

#minute_ranges ⇒ ::Array<::Google::Analytics::Data::V1beta::MinuteRange>

Returns The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

Returns:

  • (::Array<::Google::Analytics::Data::V1beta::MinuteRange>) —

    The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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

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

Returns Specifies how rows are ordered in the response.

Returns:



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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.



528
529
530
531
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 528

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