Struct google_api_proto::google::analytics::data::v1alpha::RunFunnelReportRequest

pub struct RunFunnelReportRequest {
    pub property: String,
    pub date_ranges: Vec<DateRange>,
    pub funnel: Option<Funnel>,
    pub funnel_breakdown: Option<FunnelBreakdown>,
    pub funnel_next_action: Option<FunnelNextAction>,
    pub funnel_visualization_type: i32,
    pub segments: Vec<Segment>,
    pub limit: i64,
    pub dimension_filter: Option<FilterExpression>,
    pub return_property_quota: bool,
}

The request for a funnel report.

Fields

property: String

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

date_ranges: Vec<DateRange>

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

funnel: Option<Funnel>

Optional. The configuration of this request’s funnel. This funnel configuration is required.

funnel_breakdown: Option<FunnelBreakdown>

Optional. If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the deviceCategory dimension will create rows for mobile, tablet, desktop, and the total.

funnel_next_action: Option<FunnelNextAction>

Optional. If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the eventName dimension will create rows for several events (for example session_start & click) and the total.

Next action only supports eventName and most Page / Screen dimensions like pageTitle and pagePath.

funnel_visualization_type: i32

Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, STANDARD_FUNNEL is used.

segments: Vec<Segment>

Optional. The configurations of segments. Segments are subsets of a property’s data. In a funnel report with segments, the funnel is evaluated in each segment.

Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.

The segments parameter is optional. Requests are limited to 4 segments.

limit: i64

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

dimension_filter: Option<FilterExpression>

Optional. Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Creating a Report: Dimension Filters for examples. Metrics cannot be used in this filter.

return_property_quota: bool

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

Implementations

impl RunFunnelReportRequest

pub fn funnel_visualization_type(&self) -> FunnelVisualizationType

Returns the enum value of funnel_visualization_type, or the default if the field is set to an invalid enum value.

pub fn set_funnel_visualization_type(&mut self, value: FunnelVisualizationType)

Sets funnel_visualization_type to the provided enum value.

Trait Implementations

impl Clone for RunFunnelReportRequest

fn clone(&self) -> RunFunnelReportRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunFunnelReportRequest

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

Formats the value using the given formatter.

impl Default for RunFunnelReportRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for RunFunnelReportRequest

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for RunFunnelReportRequest

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RunFunnelReportRequest