Reference documentation and code samples for the Google Analytics Data V1alpha API class Google::Analytics::Data::V1alpha::RunRealtimeReportRequest.
The request to generate a realtime report.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#dimension_filter
def dimension_filter() -> ::Google::Analytics::Data::V1alpha::FilterExpression
Returns
- (::Google::Analytics::Data::V1alpha::FilterExpression) — The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
#dimension_filter=
def dimension_filter=(value) -> ::Google::Analytics::Data::V1alpha::FilterExpression
Parameter
- value (::Google::Analytics::Data::V1alpha::FilterExpression) — The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
Returns
- (::Google::Analytics::Data::V1alpha::FilterExpression) — The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
#dimensions
def dimensions() -> ::Array<::Google::Analytics::Data::V1alpha::Dimension>
Returns
- (::Array<::Google::Analytics::Data::V1alpha::Dimension>) — The dimensions requested and displayed.
#dimensions=
def dimensions=(value) -> ::Array<::Google::Analytics::Data::V1alpha::Dimension>
Parameter
- value (::Array<::Google::Analytics::Data::V1alpha::Dimension>) — The dimensions requested and displayed.
Returns
- (::Array<::Google::Analytics::Data::V1alpha::Dimension>) — The dimensions requested and displayed.
#limit
def limit() -> ::Integer
Returns
- (::Integer) — The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
#limit=
def limit=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
#metric_aggregations
def metric_aggregations() -> ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>
Returns
- (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
#metric_aggregations=
def metric_aggregations=(value) -> ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>
Parameter
- value (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
Returns
- (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
#metric_filter
def metric_filter() -> ::Google::Analytics::Data::V1alpha::FilterExpression
Returns
- (::Google::Analytics::Data::V1alpha::FilterExpression) — 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.
#metric_filter=
def metric_filter=(value) -> ::Google::Analytics::Data::V1alpha::FilterExpression
Parameter
- value (::Google::Analytics::Data::V1alpha::FilterExpression) — 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
- (::Google::Analytics::Data::V1alpha::FilterExpression) — 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.
#metrics
def metrics() -> ::Array<::Google::Analytics::Data::V1alpha::Metric>
Returns
- (::Array<::Google::Analytics::Data::V1alpha::Metric>) — The metrics requested and displayed.
#metrics=
def metrics=(value) -> ::Array<::Google::Analytics::Data::V1alpha::Metric>
Parameter
- value (::Array<::Google::Analytics::Data::V1alpha::Metric>) — The metrics requested and displayed.
Returns
- (::Array<::Google::Analytics::Data::V1alpha::Metric>) — The metrics requested and displayed.
#order_bys
def order_bys() -> ::Array<::Google::Analytics::Data::V1alpha::OrderBy>
Returns
- (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how rows are ordered in the response.
#order_bys=
def order_bys=(value) -> ::Array<::Google::Analytics::Data::V1alpha::OrderBy>
Parameter
- value (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how rows are ordered in the response.
Returns
- (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how rows are ordered in the response.
#property
def property() -> ::String
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
#property=
def property=(value) -> ::String
Parameter
-
value (::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
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
#return_property_quota
def return_property_quota() -> ::Boolean
Returns
- (::Boolean) — Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota.
#return_property_quota=
def return_property_quota=(value) -> ::Boolean
Parameter
- value (::Boolean) — 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.