Struct googapis::google::analytics::data::v1beta::RunRealtimeReportRequest

pub struct RunRealtimeReportRequest {
    pub property: String,
    pub dimensions: Vec<Dimension>,
    pub metrics: Vec<Metric>,
    pub dimension_filter: Option<FilterExpression>,
    pub metric_filter: Option<FilterExpression>,
    pub limit: i64,
    pub metric_aggregations: Vec<i32>,
    pub order_bys: Vec<OrderBy>,
    pub return_property_quota: bool,
    pub minute_ranges: Vec<MinuteRange>,
}

The request to generate a realtime report.

Fields

property: 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

dimensions: Vec<Dimension>

The dimensions requested and displayed.

metrics: Vec<Metric>

The metrics requested and displayed.

dimension_filter: Option<FilterExpression>

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

metric_filter: Option<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.

limit: i64

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: Vec<i32>

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

order_bys: Vec<OrderBy>

Specifies how rows are ordered in the response.

return_property_quota: bool

Toggles whether to return the current state of this Analytics Property’s Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).

minute_ranges: Vec<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.

Implementations

impl RunRealtimeReportRequest

pub fn metric_aggregations(
    &self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<MetricAggregation>>

Returns an iterator which yields the valid enum values contained in metric_aggregations.

pub fn push_metric_aggregations(&mut self, value: MetricAggregation)

Appends the provided enum value to metric_aggregations.

Trait Implementations

impl Clone for RunRealtimeReportRequest

fn clone(&self) -> RunRealtimeReportRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RunRealtimeReportRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RunRealtimeReportRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for RunRealtimeReportRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<RunRealtimeReportRequest> for RunRealtimeReportRequest

fn eq(&self, other: &RunRealtimeReportRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RunRealtimeReportRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for RunRealtimeReportRequest