Struct gapi_grpc::google::analytics::data::v1alpha::RunReportRequest

pub struct RunReportRequest {
    pub entity: Option<Entity>,
    pub dimensions: Vec<Dimension>,
    pub metrics: Vec<Metric>,
    pub date_ranges: Vec<DateRange>,
    pub offset: i64,
    pub limit: i64,
    pub metric_aggregations: Vec<i32>,
    pub dimension_filter: Option<FilterExpression>,
    pub metric_filter: Option<FilterExpression>,
    pub order_bys: Vec<OrderBy>,
    pub currency_code: String,
    pub cohort_spec: Option<CohortSpec>,
    pub keep_empty_rows: bool,
    pub return_property_quota: bool,
}

The request to generate a report.

Fields

entity: Option<Entity>

A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

dimensions: Vec<Dimension>

The dimensions requested and displayed.

metrics: Vec<Metric>

The metrics requested and displayed.

date_ranges: Vec<DateRange>

Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this dateRanges must be unspecified.

offset: i64

The row count of the start row. The first row is counted as row 0.

To learn more about this pagination parameter, see Pagination.

limit: i64

The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

To learn more about this pagination parameter, see Pagination.

metric_aggregations: Vec<i32>

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

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.

order_bys: Vec<OrderBy>

Specifies how rows are ordered in the response.

currency_code: String

A currency code in ISO4217 format, such as “AED”, “USD”, “JPY”. If the field is empty, the report uses the entity’s default currency.

cohort_spec: Option<CohortSpec>

Cohort group associated with this request. If there is a cohort group in the request the ‘cohort’ dimension must be present.

keep_empty_rows: bool

If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

return_property_quota: bool

Toggles whether to return the current state of this Analytics Property’s quota. Quota is returned in PropertyQuota.

Implementations

impl RunReportRequest

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 RunReportRequest

fn clone(&self) -> RunReportRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunReportRequest

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

Formats the value using the given formatter.

impl Default for RunReportRequest

fn default() -> RunReportRequest

Returns the “default value” for a type.

impl Message for RunReportRequest

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.

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

Encodes the message to a buffer.

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

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

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

Decodes an instance of the message from a buffer.

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

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

pub 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<RunReportRequest> for RunReportRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for RunReportRequest