Google Analytics Data V1beta API - Class Google::Analytics::Data::V1beta::RunRealtimeReportRequest (v0.4.3)

Reference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::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::V1beta::FilterExpression

Returns

(::Google::Analytics::Data::V1beta::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::V1beta::FilterExpression

Parameter

value (::Google::Analytics::Data::V1beta::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::V1beta::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::V1beta::Dimension>

Returns

(::Array<::Google::Analytics::Data::V1beta::Dimension>) — The dimensions requested and displayed.

#dimensions=

def dimensions=(value) -> ::Array<::Google::Analytics::Data::V1beta::Dimension>

Parameter

value (::Array<::Google::Analytics::Data::V1beta::Dimension>) — The dimensions requested and displayed.

Returns

(::Array<::Google::Analytics::Data::V1beta::Dimension>) — The dimensions requested and displayed.

#limit

def limit() -> ::Integer

Returns

(::Integer) — The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,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.

#limit=

def limit=(value) -> ::Integer

Parameter

value (::Integer) — The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,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 100,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.

#metric_aggregations

def metric_aggregations() -> ::Array<::Google::Analytics::Data::V1beta::MetricAggregation>

Returns

(::Array<::Google::Analytics::Data::V1beta::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::V1beta::MetricAggregation>

Parameter

value (::Array<::Google::Analytics::Data::V1beta::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::V1beta::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::V1beta::FilterExpression

Returns

(::Google::Analytics::Data::V1beta::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::V1beta::FilterExpression

Parameter

value (::Google::Analytics::Data::V1beta::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::V1beta::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::V1beta::Metric>

Returns

(::Array<::Google::Analytics::Data::V1beta::Metric>) — The metrics requested and displayed.

#metrics=

def metrics=(value) -> ::Array<::Google::Analytics::Data::V1beta::Metric>

Parameter

value (::Array<::Google::Analytics::Data::V1beta::Metric>) — The metrics requested and displayed.

Returns

(::Array<::Google::Analytics::Data::V1beta::Metric>) — The metrics requested and displayed.

#minute_ranges

def minute_ranges() -> ::Array<::Google::Analytics::Data::V1beta::MinuteRange>

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.

#minute_ranges=

def minute_ranges=(value) -> ::Array<::Google::Analytics::Data::V1beta::MinuteRange>

Parameter

value (::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.

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.

#order_bys

def order_bys() -> ::Array<::Google::Analytics::Data::V1beta::OrderBy>

Returns

(::Array<::Google::Analytics::Data::V1beta::OrderBy>) — Specifies how rows are ordered in the response.

#order_bys=

def order_bys=(value) -> ::Array<::Google::Analytics::Data::V1beta::OrderBy>

Parameter

value (::Array<::Google::Analytics::Data::V1beta::OrderBy>) — Specifies how rows are ordered in the response.

Returns

(::Array<::Google::Analytics::Data::V1beta::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.