Struct google_analyticsreporting4::ReportRequest

pub struct ReportRequest {
    pub metrics: Option<Vec<Metric>>,
    pub page_size: Option<i32>,
    pub view_id: Option<String>,
    pub cohort_group: Option<CohortGroup>,
    pub date_ranges: Option<Vec<DateRange>>,
    pub sampling_level: Option<String>,
    pub metric_filter_clauses: Option<Vec<MetricFilterClause>>,
    pub pivots: Option<Vec<Pivot>>,
    pub hide_totals: Option<bool>,
    pub dimensions: Option<Vec<Dimension>>,
    pub dimension_filter_clauses: Option<Vec<DimensionFilterClause>>,
    pub include_empty_rows: Option<bool>,
    pub segments: Option<Vec<Segment>>,
    pub order_bys: Option<Vec<OrderBy>>,
    pub filters_expression: Option<String>,
    pub page_token: Option<String>,
    pub hide_value_ranges: Option<bool>,
}

The main request class which specifies the Reporting API request.

This type is not used in any activity, and only used as part of another schema.

Fields

metrics: Option<Vec<Metric>>

The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.

page_size: Option<i32>

Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for ga:country, so when segmenting only by country, you can't get more than 300 rows, even if you set pageSize to a higher value.

view_id: Option<String>

The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId.

cohort_group: Option<CohortGroup>

Cohort group associated with this request. If there is a cohort group in the request the ga:cohort dimension must be present. Every ReportRequest within a batchGet method must contain the same cohortGroup definition.

date_ranges: Option<Vec<DateRange>>

Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The reportRequest.dateRanges field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every ReportRequest within a batchGet method must contain the same dateRanges definition.

sampling_level: Option<String>

The desired report sample size. If the the samplingLevel field is unspecified the DEFAULT sampling level is used. Every ReportRequest within a batchGet method must contain the same samplingLevel definition. See developer guide for details.

metric_filter_clauses: Option<Vec<MetricFilterClause>>

The metric filter clauses. They are logically combined with the AND operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.

pivots: Option<Vec<Pivot>>

The pivot definitions. Requests can have a maximum of 2 pivots.

hide_totals: Option<bool>

If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.

dimensions: Option<Vec<Dimension>>

The dimensions requested. Requests can have a total of 7 dimensions.

dimension_filter_clauses: Option<Vec<DimensionFilterClause>>

The dimension filter clauses for filtering Dimension Values. They are logically combined with the AND operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.

include_empty_rows: Option<bool>

If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.

segments: Option<Vec<Segment>>

Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every ReportRequest within a batchGet method must contain the same segments definition. Requests with segments must have the ga:segment dimension.

order_bys: Option<Vec<OrderBy>>

Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.

filters_expression: Option<String>

Dimension or metric filters that restrict the data returned for your request. To use the filtersExpression, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects ga:browser dimension which starts with Firefox; ga:browser=~^Firefox. For more information on dimensions and metric filters, see Filters reference.

page_token: Option<String>

A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.

hide_value_ranges: Option<bool>

If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.

Trait Implementations

impl Default for ReportRequest

fn default() -> ReportRequest

Returns the "default value" for a type.

impl Clone for ReportRequest

fn clone(&self) -> ReportRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReportRequest

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

Formats the value using the given formatter.

impl Part for ReportRequest