Struct google_analyticsdata1_beta::api::RunReportRequest

pub struct RunReportRequest {

    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 limit: Option<i64>,
    pub metric_aggregations: Option<Vec<String>>,
    pub metric_filter: Option<FilterExpression>,
    pub metrics: Option<Vec<Metric>>,
    pub offset: Option<i64>,
    pub order_bys: Option<Vec<OrderBy>>,
    pub property: Option<String>,
    pub return_property_quota: Option<bool>,
}

The request to generate a 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 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>>

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.

dimension_filter: Option<FilterExpression>

Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.

dimensions: Option<Vec<Dimension>>

The dimensions requested and displayed.

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.

limit: Option<i64>

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,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. To learn more about this pagination parameter, see Pagination.

metric_aggregations: Option<Vec<String>>

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

metric_filter: Option<FilterExpression>

The filter clause of metrics. Applied after aggregating the report’s rows, similar to SQL having-clause. Dimensions cannot be used in this filter.

metrics: Option<Vec<Metric>>

The metrics requested and displayed.

offset: Option<i64>

The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows. To learn more about this pagination parameter, see Pagination.

order_bys: Option<Vec<OrderBy>>

Specifies how rows are ordered in the response.

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 RunReportRequest

fn clone(&self) -> RunReportRequest

Returns a copy of the value.

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<'de> Deserialize<'de> for RunReportRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunReportRequest

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 RunReportRequest