Struct googapis::google::analytics::data::v1beta::RunReportRequest [−][src]
pub struct RunReportRequest {Show 14 fields
pub property: String,
pub dimensions: Vec<Dimension>,
pub metrics: Vec<Metric>,
pub date_ranges: Vec<DateRange>,
pub dimension_filter: Option<FilterExpression>,
pub metric_filter: Option<FilterExpression>,
pub offset: i64,
pub limit: i64,
pub metric_aggregations: Vec<i32>,
pub order_bys: Vec<OrderBy>,
pub currency_code: String,
pub cohort_spec: Option<CohortSpec>,
pub keep_empty_rows: bool,
pub return_property_quota: bool,
}
Expand description
The request to generate a 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property.
Example: properties/1234
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.
dimension_filter: Option<FilterExpression>
Dimension filters allow you to 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.
metric_filter: Option<FilterExpression>
The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.
offset: 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
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.
To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#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)”.
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 property’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](#PropertyQuota).
Implementations
pub fn metric_aggregations(
&self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<MetricAggregation>>
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
.
Appends the provided enum value to metric_aggregations
.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
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.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for RunReportRequest
impl Send for RunReportRequest
impl Sync for RunReportRequest
impl Unpin for RunReportRequest
impl UnwindSafe for RunReportRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more