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

defdimension_filter()->::Google::Analytics::Data::V1beta::FilterExpression
Returns

#dimension_filter=

defdimension_filter=(value)->::Google::Analytics::Data::V1beta::FilterExpression
Parameter
Returns

#dimensions

defdimensions()->::Array<::Google::Analytics::Data::V1beta::Dimension>
Returns

#dimensions=

defdimensions=(value)->::Array<::Google::Analytics::Data::V1beta::Dimension>
Parameter
Returns

#limit

deflimit()->::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=

deflimit=(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

defmetric_aggregations()->::Array<::Google::Analytics::Data::V1beta::MetricAggregation>
Returns

#metric_aggregations=

defmetric_aggregations=(value)->::Array<::Google::Analytics::Data::V1beta::MetricAggregation>
Parameter
Returns

#metric_filter

defmetric_filter()->::Google::Analytics::Data::V1beta::FilterExpression
Returns

#metric_filter=

defmetric_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

#metrics

defmetrics()->::Array<::Google::Analytics::Data::V1beta::Metric>
Returns

#metrics=

defmetrics=(value)->::Array<::Google::Analytics::Data::V1beta::Metric>
Parameter
Returns

#minute_ranges

defminute_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=

defminute_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

deforder_bys()->::Array<::Google::Analytics::Data::V1beta::OrderBy>
Returns

#order_bys=

deforder_bys=(value)->::Array<::Google::Analytics::Data::V1beta::OrderBy>
Parameter
Returns

#property

defproperty()->::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=

defproperty=(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

defreturn_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=

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.