Struct google_analyticsdata1_beta::api::RunPivotReportRequest

pub struct RunPivotReportRequest {
    pub cohort_spec: Option<CohortSpec>,
    pub currency_code: Option<String>,
    pub date_ranges: Option<Vec<DateRange>>,
    pub dimension_filter: Option<FilterExpression>,
    pub dimensions: Option<Vec<Dimension>>,
    pub keep_empty_rows: Option<bool>,
    pub metric_filter: Option<FilterExpression>,
    pub metrics: Option<Vec<Metric>>,
    pub pivots: Option<Vec<Pivot>>,
    pub property: Option<String>,
    pub return_property_quota: Option<bool>,
}

The request to generate a pivot report.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• run pivot report properties (request)

Fields

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.

currency_code: Option<String>

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

date_ranges: Option<Vec<DateRange>>

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name “dateRange” can be included in a Pivot’s field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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.

dimensions: Option<Vec<Dimension>>

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

keep_empty_rows: Option<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. Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: “purchase” and eventCount: 0.

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.

metrics: Option<Vec<Metric>>

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

pivots: Option<Vec<Pivot>>

Describes the visual format of the report’s dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

property: Option<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. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

return_property_quota: Option<bool>

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

Trait Implementations

impl Clone for RunPivotReportRequest

fn clone(&self) -> RunPivotReportRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunPivotReportRequest

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

Formats the value using the given formatter.

impl Default for RunPivotReportRequest

fn default() -> RunPivotReportRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunPivotReportRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunPivotReportRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for RunPivotReportRequest